Skip to content

workflow.md

Latest commit

 

History

History
1210 lines (649 loc) · 44.1 KB

workflow.md

File metadata and controls

1210 lines (649 loc) · 44.1 KB

Untitled schema Schema

https://github.com/kitproj/kit/internal/types/workflow
Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status Unknown identifiability Forbidden Allowed none workflow.schema.json

Untitled schema Type

unknown

Untitled schema Definitions

Definitions group Duration

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration"}
Property Type Required Nullable Defined by
Duration object Required cannot be null Untitled schema

Duration

Duration

Duration Type

object (Duration)

Definitions group EnvVars

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars"}
Property Type Required Nullable Defined by
.* string Optional cannot be null Untitled schema

Pattern: .*

.*

.* Type

string

Definitions group Envfile

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Envfile"}
Property Type Required Nullable Defined by

Definitions group HTTPGetAction

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction"}
Property Type Required Nullable Defined by
scheme string Optional cannot be null Untitled schema
port integer Optional cannot be null Untitled schema
path string Optional cannot be null Untitled schema

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

scheme

scheme Type

string (scheme)

port

Number of the port

port

port Type

integer (port)

path

Path to access on the HTTP server.

path

path Type

string (path)

Definitions group HostPath

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath"}
Property Type Required Nullable Defined by
path string Required cannot be null Untitled schema

path

Path of the directory on the host.

path

path Type

string (path)

Definitions group Port

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port"}
Property Type Required Nullable Defined by
containerPort integer Optional cannot be null Untitled schema
hostPort integer Optional cannot be null Untitled schema

containerPort

The container port to expose

containerPort

containerPort Type

integer (containerPort)

hostPort

The host port to route to the container port

hostPort

hostPort Type

integer (hostPort)

Definitions group Ports

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Ports"}
Property Type Required Nullable Defined by

Definitions group Probe

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe"}
Property Type Required Nullable Defined by
tcpSocket object Optional cannot be null Untitled schema
httpGet object Optional cannot be null Untitled schema
initialDelaySeconds integer Optional cannot be null Untitled schema
periodSeconds integer Optional cannot be null Untitled schema
successThreshold integer Optional cannot be null Untitled schema
failureThreshold integer Optional cannot be null Untitled schema

tcpSocket

TCPSocketAction describes an action based on opening a socket

tcpSocket

tcpSocket Type

object (TCPSocketAction)

httpGet

HTTPGetAction describes an action based on HTTP Locks requests.

httpGet

httpGet Type

object (HTTPGetAction)

initialDelaySeconds

Number of seconds after the process has started before the probe is initiated.

initialDelaySeconds

initialDelaySeconds Type

integer (initialDelaySeconds)

periodSeconds

How often (in seconds) to perform the probe.

periodSeconds

periodSeconds Type

integer (periodSeconds)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed.

successThreshold

successThreshold Type

integer (successThreshold)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded.

failureThreshold

failureThreshold Type

integer (failureThreshold)

Definitions group Strings

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Strings"}
Property Type Required Nullable Defined by

Definitions group TCPSocketAction

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction"}
Property Type Required Nullable Defined by
port integer Required cannot be null Untitled schema

port

Port number of the port to probe.

port

port Type

integer (port)

Definitions group Task

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task"}
Property Type Required Nullable Defined by
type string Optional cannot be null Untitled schema
log string Optional cannot be null Untitled schema
image string Optional cannot be null Untitled schema
imagePullPolicy string Optional cannot be null Untitled schema
livenessProbe object Optional cannot be null Untitled schema
readinessProbe object Optional cannot be null Untitled schema
command array Optional cannot be null Untitled schema
args array Optional cannot be null Untitled schema
sh string Optional cannot be null Untitled schema
manifests array Optional cannot be null Untitled schema
namespace string Optional cannot be null Untitled schema
workingDir string Optional cannot be null Untitled schema
user string Optional cannot be null Untitled schema
env object Optional cannot be null Untitled schema
envfile array Optional cannot be null Untitled schema
ports array Optional cannot be null Untitled schema
volumeMounts array Optional cannot be null Untitled schema
tty boolean Optional cannot be null Untitled schema
watch array Optional cannot be null Untitled schema
mutex string Optional cannot be null Untitled schema
semaphore string Optional cannot be null Untitled schema
dependencies array Optional cannot be null Untitled schema
targets array Optional cannot be null Untitled schema
restartPolicy string Optional cannot be null Untitled schema
stalledTimeout object Optional cannot be null Untitled schema
group string Optional cannot be null Untitled schema
default boolean Optional cannot be null Untitled schema

type

Type is the type of the task: "service" or "job". If omitted, if there are ports, it's a service, otherwise it's a job. This is only needed when you have service that does not listen on ports. Services are running in the background.

type

type Type

string (type)

log

Where to log the output of the task. E.g. if the task is verbose. Defaults to /dev/stdout. Maybe a file, or /dev/null.

log

log Type

string (log)

image

Either the container image to run, or a directory containing a Dockerfile. If omitted, the process runs on the host.

image

image Type

string (image)

imagePullPolicy

Pull policy, e.g. Always, Never, IfNotPresent

imagePullPolicy

imagePullPolicy Type

string (imagePullPolicy)

livenessProbe

A probe to check if the task is alive, it will be restarted if not.

livenessProbe

livenessProbe Type

object (Probe)

readinessProbe

A probe to check if the task is alive, it will be restarted if not.

readinessProbe

readinessProbe Type

object (Probe)

command

The command to run in the container or on the host. If both the image and the command are omitted, this is a noop.

command

command Type

string[]

args

The arguments to pass to the command

args

args Type

string[]

sh

The shell script to run, instead of the command

sh

sh Type

string (sh)

manifests

A directories or files of Kubernetes manifests to apply. Once running the task will wait for the resources to be ready.

manifests

manifests Type

string[]

namespace

The namespace to run the Kubernetes resource in. Defaults to the namespace of the current Kubernetes context.

namespace

namespace Type

string (namespace)

workingDir

The working directory in the container or on the host

workingDir

workingDir Type

string (workingDir)

user

The user to run the task as.

user

user Type

string (user)

env

A list of environment variables.

env

env Type

object (EnvVars)

envfile

Environment file (e.g. .env) to use

envfile

envfile Type

string[]

ports

A list of ports to expose.

ports

ports Type

object[] (Port)

volumeMounts

Volumes to mount in the container

volumeMounts

volumeMounts Type

object[] (VolumeMount)

tty

Use a pseudo-TTY

tty

tty Type

boolean (tty)

watch

A list of files to watch for changes, and restart the task if they change

watch

watch Type

string[]

mutex

A mutex to prevent multiple tasks with the same mutex from running at the same time

mutex

mutex Type

string (mutex)

semaphore

A semaphore to limit the number of tasks with the same semaphore that can run at the same time

semaphore

semaphore Type

string (semaphore)

dependencies

A list of tasks to run before this task

dependencies

dependencies Type

string[]

targets

A list of files this task will create. If these exist, and they're newer than the watched files, the task is skipped.

targets

targets Type

string[]

restartPolicy

The restart policy, e.g. Always, Never, OnFailure. Defaults depends on the type of task.

restartPolicy

restartPolicy Type

string (restartPolicy)

stalledTimeout

The timeout for the task to be considered stalled. If omitted, the task will be considered stalled after 30 seconds of no activity.

stalledTimeout

stalledTimeout Type

object (Duration)

group

The group this task belongs to. Tasks in the same group will be visually grouped together in the UI.

group

group Type

string (group)

default

Whether this is the default task to run if no task is specified.

default

default Type

boolean (default)

Definitions group Tasks

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks"}
Property Type Required Nullable Defined by
.* object Optional cannot be null Untitled schema

Pattern: .*

A task is a container or a command to run.

.*

.* Type

object (Task)

Definitions group Volume

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume"}
Property Type Required Nullable Defined by
name string Required cannot be null Untitled schema
hostPath object Required cannot be null Untitled schema

name

Volume's name.

name

name Type

string (name)

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container.

hostPath

hostPath Type

object (HostPath)

Definitions group VolumeMount

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount"}
Property Type Required Nullable Defined by
name string Required cannot be null Untitled schema
mountPath string Required cannot be null Untitled schema

name

This must match the name of a volume.

name

name Type

string (name)

mountPath

Path within the container at which the volume should be mounted.

mountPath

mountPath Type

string (mountPath)

Definitions group Workflow

Reference this group by using

{"$ref":"https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow"}
Property Type Required Nullable Defined by
port integer Optional cannot be null Untitled schema
terminationGracePeriodSeconds integer Optional cannot be null Untitled schema
tasks object Optional cannot be null Untitled schema
volumes array Optional cannot be null Untitled schema
semaphores object Optional cannot be null Untitled schema
env object Optional cannot be null Untitled schema
envfile array Optional cannot be null Untitled schema

port

port

port Type

integer (port)

terminationGracePeriodSeconds

terminationGracePeriodSeconds

terminationGracePeriodSeconds Type

integer (terminationGracePeriodSeconds)

tasks

tasks

tasks Type

object (Tasks)

volumes

volumes

volumes Type

object[] (Volume)

semaphores

semaphores

semaphores Type

object (semaphores)

env

A list of environment variables.

env

env Type

object (EnvVars)

envfile

envfile

envfile Type

string[]