diff --git a/.gitignore b/.gitignore index eb2745b..bbac83c 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,5 @@ .idea /demo/go/go .qodo +internal/logs/ +internal/test.log diff --git a/README.md b/README.md index 5ccb459..057b4da 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ With Kit, you can define and manage complex workflows in a single `tasks.yaml` f - **Auto-restart** - Automatically restart services on failure - **File watching** - Re-run tasks when files change - **Port forwarding** - Forward ports from services to host -- **Web UI** - Visualize your workflow and monitor task status +- **Web UI** - Visualize your workflow and monitor task status with real-time metrics ## Quick Start diff --git a/docs/examples/README.md b/docs/examples/README.md index f828fda..079e96d 100644 --- a/docs/examples/README.md +++ b/docs/examples/README.md @@ -1,18 +1,18 @@ # Examples - * [](postgres.md) The postgres container image provides a preconfigured PostgreSQL database server for easy deployment in containerized environments. - * [](mysql.md) The MySQL container image provides a pre-configured and optimized environment for running the MySQL database service within a container. - * [](mariadb.md) MariaDB is an open-source relational database management system (RDBMS) and a community-driven fork of MySQL, designed to be a drop-in replacement for MySQL with enhanced performance, stability, and security features, including support for advanced clustering, storage engines, and plugins. - * [](redis.md) The Redis container image is a lightweight, open-source, and in-memory data structure store used as a cache, database, and message broker. - * [](mongo.md) The mongo container image provides a lightweight and scalable solution for running MongoDB databases in a containerized environment. - * [](memcached.md) The memcached container image provides an efficient in-memory caching system for key-value pairs. - * [](influxdb.md) The influxdb container image provides a pre-configured instance of the InfluxDB database that can be easily deployed for time-series data storage and analysis. - * [](kafka.md) - * [](rabbitmq.md) The RabbitMQ container image provides a scalable and highly-available message broker that supports various messaging protocols and can be easily deployed and managed in a containerized environment. - * [](nats.md) The nats container image provides a lightweight messaging system for distributed applications running in containerized environments. - * [](pulsar.md) The apachepulsar/pulsar container image provides a scalable and distributed messaging system for enterprise-grade applications. - * [](sim.md) - * [](nginx.md) The nginx container image is a lightweight and high-performance web server designed to efficiently serve static and dynamic content. - * [](httpd.md) The httpd container image provides an Apache HTTP server for serving web content. - * [](dynamo.md) Dynamo is a distributed key-value storage system developed by Amazon Web Services (AWS) for highly available, scalable and reliable NoSQL data storage. - * [](timestream.md) Timestream is a fully-managed, scalable time-series database service developed by Amazon Web Services (AWS) that enables users to store, process, and analyze time-series data, such as logs, sensor data, and industrial telemetry, with high precision and accuracy, and built-in analytics and visualization tools. + * [PostgreSQL](postgres.md) The postgres container image provides a preconfigured PostgreSQL database server for easy deployment in containerized environments. + * [MySQL](mysql.md) The MySQL container image provides a pre-configured and optimized environment for running the MySQL database service within a container. + * [MariaDB](mariadb.md) MariaDB is an open-source relational database management system (RDBMS) and a community-driven fork of MySQL, designed to be a drop-in replacement for MySQL with enhanced performance, stability, and security features, including support for advanced clustering, storage engines, and plugins. + * [Redis](redis.md) The Redis container image is a lightweight, open-source, and in-memory data structure store used as a cache, database, and message broker. + * [MongoDB](mongo.md) The mongo container image provides a lightweight and scalable solution for running MongoDB databases in a containerized environment. + * [Memcached](memcached.md) The memcached container image provides an efficient in-memory caching system for key-value pairs. + * [InfluxDB](influxdb.md) The influxdb container image provides a pre-configured instance of the InfluxDB database that can be easily deployed for time-series data storage and analysis. + * [Apache Kafka](kafka.md) Apache Kafka is a distributed streaming platform that's designed to handle high throughput, fault-tolerant streaming data. + * [RabbitMQ](rabbitmq.md) The RabbitMQ container image provides a scalable and highly-available message broker that supports various messaging protocols and can be easily deployed and managed in a containerized environment. + * [NATS](nats.md) The nats container image provides a lightweight messaging system for distributed applications running in containerized environments. + * [Apache Pulsar](pulsar.md) The apachepulsar/pulsar container image provides a scalable and distributed messaging system for enterprise-grade applications. + * [Sim](sim.md) Sim is a straight-forward API simulation tool that's tiny, fast, secure and scalable. + * [Nginx](nginx.md) The nginx container image is a lightweight and high-performance web server designed to efficiently serve static and dynamic content. + * [Apache HTTP Server](httpd.md) The httpd container image provides an Apache HTTP server for serving web content. + * [DynamoDB Local](dynamo.md) Dynamo is a distributed key-value storage system developed by Amazon Web Services (AWS) for highly available, scalable and reliable NoSQL data storage. + * [Timestream (Moto)](timestream.md) Timestream is a fully-managed, scalable time-series database service developed by Amazon Web Services (AWS) that enables users to store, process, and analyze time-series data, such as logs, sensor data, and industrial telemetry, with high precision and accuracy, and built-in analytics and visualization tools. diff --git a/docs/examples/examples.yaml b/docs/examples/examples.yaml index f797158..f8f72f3 100755 --- a/docs/examples/examples.yaml +++ b/docs/examples/examples.yaml @@ -2,6 +2,7 @@ # SQL - name: postgres + title: PostgreSQL description: The postgres container image provides a preconfigured PostgreSQL database server for easy deployment in containerized environments. workflow: spec: @@ -10,6 +11,7 @@ env: - POSTGRES_PASSWORD=password - name: mysql + title: MySQL description: The MySQL container image provides a pre-configured and optimized environment for running the MySQL database service within a container. workflow: spec: @@ -18,6 +20,7 @@ env: - MYSQL_ROOT_PASSWORD=password - name: mariadb + title: MariaDB description: MariaDB is an open-source relational database management system (RDBMS) and a community-driven fork of MySQL, designed to be a drop-in replacement for MySQL with enhanced performance, stability, and security features, including support for advanced clustering, storage engines, and plugins. workflow: spec: @@ -29,12 +32,14 @@ # NoSQL - name: redis + title: Redis description: The Redis container image is a lightweight, open-source, and in-memory data structure store used as a cache, database, and message broker. workflow: spec: tasks: - image: redis - name: mongo + title: MongoDB description: The mongo container image provides a lightweight and scalable solution for running MongoDB databases in a containerized environment. workflow: spec: @@ -42,6 +47,7 @@ - image: mongo - name: memcached + title: Memcached description: The memcached container image provides an efficient in-memory caching system for key-value pairs. workflow: spec: @@ -51,6 +57,7 @@ # Time-series database - name: influxdb + title: InfluxDB description: The influxdb container image provides a pre-configured instance of the InfluxDB database that can be easily deployed for time-series data storage and analysis. workflow: spec: @@ -60,23 +67,28 @@ # Streaming - name: kafka + title: Apache Kafka + description: Apache Kafka is a distributed streaming platform that's designed to handle high throughput, fault-tolerant streaming data. workflow: spec: tasks: - image: ghcr.io/kitproj/kafka - name: rabbitmq + title: RabbitMQ description: The RabbitMQ container image provides a scalable and highly-available message broker that supports various messaging protocols and can be easily deployed and managed in a containerized environment. workflow: spec: tasks: - image: rabbitmq - name: nats + title: NATS description: The nats container image provides a lightweight messaging system for distributed applications running in containerized environments. workflow: spec: tasks: - image: nats - name: pulsar + title: Apache Pulsar description: The apachepulsar/pulsar container image provides a scalable and distributed messaging system for enterprise-grade applications. workflow: spec: @@ -88,6 +100,8 @@ # Simulation - name: sim + title: Sim + description: Sim is a straight-forward API simulation tool that's tiny, fast, secure and scalable. workflow: spec: tasks: @@ -98,6 +112,7 @@ # Webserver - name: nginx + title: Nginx description: The nginx container image is a lightweight and high-performance web server designed to efficiently serve static and dynamic content. workflow: spec: @@ -112,6 +127,7 @@ name: nginx.html - name: httpd + title: Apache HTTP Server description: The httpd container image provides an Apache HTTP server for serving web content. workflow: spec: @@ -127,6 +143,7 @@ # AWS - name: dynamo + title: DynamoDB Local description: Dynamo is a distributed key-value storage system developed by Amazon Web Services (AWS) for highly available, scalable and reliable NoSQL data storage. workflow: spec: @@ -135,6 +152,7 @@ image: amazon/dynamodb-local - name: timestream + title: Timestream (Moto) description: Timestream is a fully-managed, scalable time-series database service developed by Amazon Web Services (AWS) that enables users to store, process, and analyze time-series data, such as logs, sensor data, and industrial telemetry, with high precision and accuracy, and built-in analytics and visualization tools. workflow: spec: diff --git a/docs/examples/pulsar.md b/docs/examples/pulsar.md index 1431632..b1ab2a0 100644 --- a/docs/examples/pulsar.md +++ b/docs/examples/pulsar.md @@ -5,8 +5,12 @@ The apachepulsar/pulsar container image provides a scalable and distributed mess ```yaml tasks: "": - command: /pulsar/bin/pulsar standalone + command: + - /pulsar/bin/pulsar + - standalone image: apachepulsar/pulsar - ports: 6650 8080 + ports: + - "6650" + - "8080" ``` diff --git a/docs/examples/pulsar.yaml b/docs/examples/pulsar.yaml index 555a8b5..9875cf6 100644 --- a/docs/examples/pulsar.yaml +++ b/docs/examples/pulsar.yaml @@ -1,5 +1,9 @@ tasks: "": - command: /pulsar/bin/pulsar standalone + command: + - /pulsar/bin/pulsar + - standalone image: apachepulsar/pulsar - ports: 6650 8080 + ports: + - "6650" + - "8080" diff --git a/docs/examples/sim.md b/docs/examples/sim.md index 0138b48..f156f57 100644 --- a/docs/examples/sim.md +++ b/docs/examples/sim.md @@ -8,8 +8,9 @@ Sim is straight-forward API simulation tool that's tiny, fast, secure and scalab tasks: "": image: ghcr.io/kitproj/sim - ports: "8080" - readinessProbe: http://:8080/hello?failureThreshold=20&initialDelay=5s&period=5s&successThreshold=1 + ports: + - "8080" + readinessProbe: http://localhost:8080/hello volumes: - hostPath: path: volumes/sim/apis diff --git a/docs/examples/sim.yaml b/docs/examples/sim.yaml index c847e5d..bdc7292 100644 --- a/docs/examples/sim.yaml +++ b/docs/examples/sim.yaml @@ -1,8 +1,9 @@ tasks: "": image: ghcr.io/kitproj/sim - ports: "8080" - readinessProbe: http://:8080/hello?failureThreshold=20&initialDelay=5s&period=5s&successThreshold=1 + ports: + - "8080" + readinessProbe: http://localhost:8080/hello volumes: - hostPath: path: volumes/sim/apis diff --git a/docs/reference/README.md b/docs/reference/README.md index b9e6ef8..bd88aeb 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -2,49 +2,49 @@ ## Top-level Schemas -* [Untitled schema](./workflow.md) – `https://github.com/kitproj/kit/internal/types/workflow` +* [Untitled schema](./workflow.md) – `https://github.com/kitproj/kit/internal/types/workflow` ## Other Schemas ### Objects -* [Duration](./workflow-defs-duration.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration` +* [Duration](./workflow-defs-duration.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration` -* [EnvVars](./workflow-defs-envvars.md "A list of environment variables") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars` +* [EnvVars](./workflow-defs-envvars.md "A list of environment variables") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars` -* [HTTPGetAction](./workflow-defs-httpgetaction.md "HTTPGetAction describes an action based on HTTP Locks requests") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction` +* [HTTPGetAction](./workflow-defs-httpgetaction.md "HTTPGetAction describes an action based on HTTP Locks requests") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction` -* [HostPath](./workflow-defs-hostpath.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath` +* [HostPath](./workflow-defs-hostpath.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath` -* [Port](./workflow-defs-port.md "A port to expose") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port` +* [Port](./workflow-defs-port.md "A port to expose") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port` -* [Probe](./workflow-defs-probe.md "A probe to check if the task is alive, it will be restarted if not") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe` +* [Probe](./workflow-defs-probe.md "A probe to check if the task is alive, it will be restarted if not") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe` -* [TCPSocketAction](./workflow-defs-tcpsocketaction.md "TCPSocketAction describes an action based on opening a socket") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction` +* [TCPSocketAction](./workflow-defs-tcpsocketaction.md "TCPSocketAction describes an action based on opening a socket") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction` -* [Task](./workflow-defs-task.md "A task is a container or a command to run") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task` +* [Task](./workflow-defs-task.md "A task is a container or a command to run") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task` -* [Tasks](./workflow-defs-tasks.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks` +* [Tasks](./workflow-defs-tasks.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks` -* [Volume](./workflow-defs-volume.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume` +* [Volume](./workflow-defs-volume.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume` -* [VolumeMount](./workflow-defs-volumemount.md "VolumeMount describes a mounting of a Volume within a container") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount` +* [VolumeMount](./workflow-defs-volumemount.md "VolumeMount describes a mounting of a Volume within a container") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount` -* [Workflow](./workflow-defs-workflow.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow` +* [Workflow](./workflow-defs-workflow.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow` -* [semaphores](./workflow-defs-workflow-properties-semaphores.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores` +* [semaphores](./workflow-defs-workflow-properties-semaphores.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores` ### Arrays -* [Envfile](./workflow-defs-envfile.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Envfile` +* [Envfile](./workflow-defs-envfile.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Envfile` -* [Ports](./workflow-defs-ports.md "A list of ports to expose") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Ports` +* [Ports](./workflow-defs-ports.md "A list of ports to expose") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Ports` -* [Strings](./workflow-defs-strings.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Strings` +* [Strings](./workflow-defs-strings.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Strings` -* [volumeMounts](./workflow-defs-task-properties-volumemounts.md "Volumes to mount in the container") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts` +* [volumeMounts](./workflow-defs-task-properties-volumemounts.md "Volumes to mount in the container") – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts` -* [volumes](./workflow-defs-workflow-properties-volumes.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes` +* [volumes](./workflow-defs-workflow-properties-volumes.md) – `https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes` ## Version Note diff --git a/docs/reference/workflow-defs-duration.md b/docs/reference/workflow-defs-duration.md index 011c350..e74760c 100644 --- a/docs/reference/workflow-defs-duration.md +++ b/docs/reference/workflow-defs-duration.md @@ -26,13 +26,13 @@ The timeout for the task to be considered stalled. If omitted, the task will be `Duration` -* is required +* is required -* Type: `object` ([Duration](workflow-defs-duration.md)) +* Type: `object` ([Duration](workflow-defs-duration.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration/properties/Duration") +* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration/properties/Duration") ### Duration Type diff --git a/docs/reference/workflow-defs-envvars.md b/docs/reference/workflow-defs-envvars.md index 917f6f2..0d1f8f3 100644 --- a/docs/reference/workflow-defs-envvars.md +++ b/docs/reference/workflow-defs-envvars.md @@ -26,13 +26,13 @@ A list of environment variables. `.*` -* is optional +* is optional -* Type: `string` +* Type: `string` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars/patternProperties/.*") +* defined in: [Untitled schema](workflow-defs-envvars-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars/patternProperties/.*") ### .\* Type diff --git a/docs/reference/workflow-defs-hostpath.md b/docs/reference/workflow-defs-hostpath.md index f5d938d..c7de411 100644 --- a/docs/reference/workflow-defs-hostpath.md +++ b/docs/reference/workflow-defs-hostpath.md @@ -26,13 +26,13 @@ Path of the directory on the host. `path` -* is required +* is required -* Type: `string` ([path](workflow-defs-hostpath-properties-path.md)) +* Type: `string` ([path](workflow-defs-hostpath-properties-path.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-hostpath-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath/properties/path") +* defined in: [Untitled schema](workflow-defs-hostpath-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath/properties/path") ### path Type diff --git a/docs/reference/workflow-defs-httpgetaction.md b/docs/reference/workflow-defs-httpgetaction.md index 1e69dd8..4989a8a 100644 --- a/docs/reference/workflow-defs-httpgetaction.md +++ b/docs/reference/workflow-defs-httpgetaction.md @@ -28,13 +28,13 @@ Scheme to use for connecting to the host. Defaults to HTTP. `scheme` -* is optional +* is optional -* Type: `string` ([scheme](workflow-defs-httpgetaction-properties-scheme.md)) +* Type: `string` ([scheme](workflow-defs-httpgetaction-properties-scheme.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-scheme.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/scheme") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-scheme.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/scheme") ### scheme Type @@ -46,13 +46,13 @@ Number of the port `port` -* is optional +* is optional -* Type: `integer` ([port](workflow-defs-httpgetaction-properties-port.md)) +* Type: `integer` ([port](workflow-defs-httpgetaction-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/port") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/port") ### port Type @@ -64,13 +64,13 @@ Path to access on the HTTP server. `path` -* is optional +* is optional -* Type: `string` ([path](workflow-defs-httpgetaction-properties-path.md)) +* Type: `string` ([path](workflow-defs-httpgetaction-properties-path.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/path") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/path") ### path Type diff --git a/docs/reference/workflow-defs-port.md b/docs/reference/workflow-defs-port.md index db5360a..e2d13ab 100644 --- a/docs/reference/workflow-defs-port.md +++ b/docs/reference/workflow-defs-port.md @@ -27,13 +27,13 @@ The container port to expose `containerPort` -* is optional +* is optional -* Type: `integer` ([containerPort](workflow-defs-port-properties-containerport.md)) +* Type: `integer` ([containerPort](workflow-defs-port-properties-containerport.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-port-properties-containerport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/containerPort") +* defined in: [Untitled schema](workflow-defs-port-properties-containerport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/containerPort") ### containerPort Type @@ -45,13 +45,13 @@ The host port to route to the container port `hostPort` -* is optional +* is optional -* Type: `integer` ([hostPort](workflow-defs-port-properties-hostport.md)) +* Type: `integer` ([hostPort](workflow-defs-port-properties-hostport.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-port-properties-hostport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/hostPort") +* defined in: [Untitled schema](workflow-defs-port-properties-hostport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/hostPort") ### hostPort Type diff --git a/docs/reference/workflow-defs-probe.md b/docs/reference/workflow-defs-probe.md index 774094e..68c12e2 100644 --- a/docs/reference/workflow-defs-probe.md +++ b/docs/reference/workflow-defs-probe.md @@ -31,13 +31,13 @@ TCPSocketAction describes an action based on opening a socket `tcpSocket` -* is optional +* is optional -* Type: `object` ([TCPSocketAction](workflow-defs-tcpsocketaction.md)) +* Type: `object` ([TCPSocketAction](workflow-defs-tcpsocketaction.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tcpsocketaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/tcpSocket") +* defined in: [Untitled schema](workflow-defs-tcpsocketaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/tcpSocket") ### tcpSocket Type @@ -49,13 +49,13 @@ HTTPGetAction describes an action based on HTTP Locks requests. `httpGet` -* is optional +* is optional -* Type: `object` ([HTTPGetAction](workflow-defs-httpgetaction.md)) +* Type: `object` ([HTTPGetAction](workflow-defs-httpgetaction.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/httpGet") +* defined in: [Untitled schema](workflow-defs-httpgetaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/httpGet") ### httpGet Type @@ -67,13 +67,13 @@ Number of seconds after the process has started before the probe is initiated. `initialDelaySeconds` -* is optional +* is optional -* Type: `integer` ([initialDelaySeconds](workflow-defs-probe-properties-initialdelayseconds.md)) +* Type: `integer` ([initialDelaySeconds](workflow-defs-probe-properties-initialdelayseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-initialdelayseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/initialDelaySeconds") +* defined in: [Untitled schema](workflow-defs-probe-properties-initialdelayseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/initialDelaySeconds") ### initialDelaySeconds Type @@ -85,13 +85,13 @@ How often (in seconds) to perform the probe. `periodSeconds` -* is optional +* is optional -* Type: `integer` ([periodSeconds](workflow-defs-probe-properties-periodseconds.md)) +* Type: `integer` ([periodSeconds](workflow-defs-probe-properties-periodseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-periodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/periodSeconds") +* defined in: [Untitled schema](workflow-defs-probe-properties-periodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/periodSeconds") ### periodSeconds Type @@ -103,13 +103,13 @@ Minimum consecutive successes for the probe to be considered successful after ha `successThreshold` -* is optional +* is optional -* Type: `integer` ([successThreshold](workflow-defs-probe-properties-successthreshold.md)) +* Type: `integer` ([successThreshold](workflow-defs-probe-properties-successthreshold.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-successthreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/successThreshold") +* defined in: [Untitled schema](workflow-defs-probe-properties-successthreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/successThreshold") ### successThreshold Type @@ -121,13 +121,13 @@ Minimum consecutive failures for the probe to be considered failed after having `failureThreshold` -* is optional +* is optional -* Type: `integer` ([failureThreshold](workflow-defs-probe-properties-failurethreshold.md)) +* Type: `integer` ([failureThreshold](workflow-defs-probe-properties-failurethreshold.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-failurethreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/failureThreshold") +* defined in: [Untitled schema](workflow-defs-probe-properties-failurethreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/failureThreshold") ### failureThreshold Type diff --git a/docs/reference/workflow-defs-task.md b/docs/reference/workflow-defs-task.md index 36e39df..ea297e6 100644 --- a/docs/reference/workflow-defs-task.md +++ b/docs/reference/workflow-defs-task.md @@ -54,13 +54,13 @@ Services are running in the background. `type` -* is optional +* is optional -* Type: `string` ([type](workflow-defs-task-properties-type.md)) +* Type: `string` ([type](workflow-defs-task-properties-type.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-type.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/type") +* defined in: [Untitled schema](workflow-defs-task-properties-type.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/type") ### type Type @@ -72,13 +72,13 @@ Where to log the output of the task. E.g. if the task is verbose. Defaults to /d `log` -* is optional +* is optional -* Type: `string` ([log](workflow-defs-task-properties-log.md)) +* Type: `string` ([log](workflow-defs-task-properties-log.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-log.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/log") +* defined in: [Untitled schema](workflow-defs-task-properties-log.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/log") ### log Type @@ -90,13 +90,13 @@ Either the container image to run, or a directory containing a Dockerfile. If om `image` -* is optional +* is optional -* Type: `string` ([image](workflow-defs-task-properties-image.md)) +* Type: `string` ([image](workflow-defs-task-properties-image.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-image.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/image") +* defined in: [Untitled schema](workflow-defs-task-properties-image.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/image") ### image Type @@ -108,13 +108,13 @@ Pull policy, e.g. Always, Never, IfNotPresent `imagePullPolicy` -* is optional +* is optional -* Type: `string` ([imagePullPolicy](workflow-defs-task-properties-imagepullpolicy.md)) +* Type: `string` ([imagePullPolicy](workflow-defs-task-properties-imagepullpolicy.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-imagepullpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/imagePullPolicy") +* defined in: [Untitled schema](workflow-defs-task-properties-imagepullpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/imagePullPolicy") ### imagePullPolicy Type @@ -126,13 +126,13 @@ A probe to check if the task is alive, it will be restarted if not. `livenessProbe` -* is optional +* is optional -* Type: `object` ([Probe](workflow-defs-probe.md)) +* Type: `object` ([Probe](workflow-defs-probe.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/livenessProbe") +* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/livenessProbe") ### livenessProbe Type @@ -144,13 +144,13 @@ A probe to check if the task is alive, it will be restarted if not. `readinessProbe` -* is optional +* is optional -* Type: `object` ([Probe](workflow-defs-probe.md)) +* Type: `object` ([Probe](workflow-defs-probe.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/readinessProbe") +* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/readinessProbe") ### readinessProbe Type @@ -162,13 +162,13 @@ The command to run in the container or on the host. If both the image and the co `command` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/command") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/command") ### command Type @@ -180,13 +180,13 @@ The arguments to pass to the command `args` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/args") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/args") ### args Type @@ -198,13 +198,13 @@ The shell script to run, instead of the command `sh` -* is optional +* is optional -* Type: `string` ([sh](workflow-defs-task-properties-sh.md)) +* Type: `string` ([sh](workflow-defs-task-properties-sh.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-sh.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/sh") +* defined in: [Untitled schema](workflow-defs-task-properties-sh.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/sh") ### sh Type @@ -216,13 +216,13 @@ A directories or files of Kubernetes manifests to apply. Once running the task w `manifests` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/manifests") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/manifests") ### manifests Type @@ -234,13 +234,13 @@ The namespace to run the Kubernetes resource in. Defaults to the namespace of th `namespace` -* is optional +* is optional -* Type: `string` ([namespace](workflow-defs-task-properties-namespace.md)) +* Type: `string` ([namespace](workflow-defs-task-properties-namespace.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-namespace.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/namespace") +* defined in: [Untitled schema](workflow-defs-task-properties-namespace.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/namespace") ### namespace Type @@ -252,13 +252,13 @@ The working directory in the container or on the host `workingDir` -* is optional +* is optional -* Type: `string` ([workingDir](workflow-defs-task-properties-workingdir.md)) +* Type: `string` ([workingDir](workflow-defs-task-properties-workingdir.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-workingdir.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/workingDir") +* defined in: [Untitled schema](workflow-defs-task-properties-workingdir.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/workingDir") ### workingDir Type @@ -270,13 +270,13 @@ The user to run the task as. `user` -* is optional +* is optional -* Type: `string` ([user](workflow-defs-task-properties-user.md)) +* Type: `string` ([user](workflow-defs-task-properties-user.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-user.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/user") +* defined in: [Untitled schema](workflow-defs-task-properties-user.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/user") ### user Type @@ -288,13 +288,13 @@ A list of environment variables. `env` -* is optional +* is optional -* Type: `object` ([EnvVars](workflow-defs-envvars.md)) +* Type: `object` ([EnvVars](workflow-defs-envvars.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/env") +* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/env") ### env Type @@ -306,13 +306,13 @@ Environment file (e.g. .env) to use `envfile` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/envfile") +* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/envfile") ### envfile Type @@ -324,13 +324,13 @@ A list of ports to expose. `ports` -* is optional +* is optional -* Type: `object[]` ([Port](workflow-defs-port.md)) +* Type: `object[]` ([Port](workflow-defs-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-ports.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/ports") +* defined in: [Untitled schema](workflow-defs-ports.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/ports") ### ports Type @@ -342,13 +342,13 @@ Volumes to mount in the container `volumeMounts` -* is optional +* is optional -* Type: `object[]` ([VolumeMount](workflow-defs-volumemount.md)) +* Type: `object[]` ([VolumeMount](workflow-defs-volumemount.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-volumemounts.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts") +* defined in: [Untitled schema](workflow-defs-task-properties-volumemounts.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts") ### volumeMounts Type @@ -360,13 +360,13 @@ Use a pseudo-TTY `tty` -* is optional +* is optional -* Type: `boolean` ([tty](workflow-defs-task-properties-tty.md)) +* Type: `boolean` ([tty](workflow-defs-task-properties-tty.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-tty.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/tty") +* defined in: [Untitled schema](workflow-defs-task-properties-tty.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/tty") ### tty Type @@ -378,13 +378,13 @@ A list of files to watch for changes, and restart the task if they change `watch` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/watch") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/watch") ### watch Type @@ -396,13 +396,13 @@ A mutex to prevent multiple tasks with the same mutex from running at the same t `mutex` -* is optional +* is optional -* Type: `string` ([mutex](workflow-defs-task-properties-mutex.md)) +* Type: `string` ([mutex](workflow-defs-task-properties-mutex.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-mutex.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/mutex") +* defined in: [Untitled schema](workflow-defs-task-properties-mutex.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/mutex") ### mutex Type @@ -414,13 +414,13 @@ A semaphore to limit the number of tasks with the same semaphore that can run at `semaphore` -* is optional +* is optional -* Type: `string` ([semaphore](workflow-defs-task-properties-semaphore.md)) +* Type: `string` ([semaphore](workflow-defs-task-properties-semaphore.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-semaphore.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/semaphore") +* defined in: [Untitled schema](workflow-defs-task-properties-semaphore.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/semaphore") ### semaphore Type @@ -432,13 +432,13 @@ A list of tasks to run before this task `dependencies` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/dependencies") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/dependencies") ### dependencies Type @@ -450,13 +450,13 @@ A list of files this task will create. If these exist, and they're newer than th `targets` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/targets") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/targets") ### targets Type @@ -468,13 +468,13 @@ The restart policy, e.g. Always, Never, OnFailure. Defaults depends on the type `restartPolicy` -* is optional +* is optional -* Type: `string` ([restartPolicy](workflow-defs-task-properties-restartpolicy.md)) +* Type: `string` ([restartPolicy](workflow-defs-task-properties-restartpolicy.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-restartpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/restartPolicy") +* defined in: [Untitled schema](workflow-defs-task-properties-restartpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/restartPolicy") ### restartPolicy Type @@ -486,13 +486,13 @@ The timeout for the task to be considered stalled. If omitted, the task will be `stalledTimeout` -* is optional +* is optional -* Type: `object` ([Duration](workflow-defs-duration.md)) +* Type: `object` ([Duration](workflow-defs-duration.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/stalledTimeout") +* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/stalledTimeout") ### stalledTimeout Type @@ -504,13 +504,13 @@ The group this task belongs to. Tasks in the same group will be visually grouped `group` -* is optional +* is optional -* Type: `string` ([group](workflow-defs-task-properties-group.md)) +* Type: `string` ([group](workflow-defs-task-properties-group.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-group.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/group") +* defined in: [Untitled schema](workflow-defs-task-properties-group.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/group") ### group Type @@ -522,13 +522,13 @@ Whether this is the default task to run if no task is specified. `default` -* is optional +* is optional -* Type: `boolean` ([default](workflow-defs-task-properties-default.md)) +* Type: `boolean` ([default](workflow-defs-task-properties-default.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-default.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/default") +* defined in: [Untitled schema](workflow-defs-task-properties-default.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/default") ### default Type diff --git a/docs/reference/workflow-defs-tasks.md b/docs/reference/workflow-defs-tasks.md index 746b248..4e74c81 100644 --- a/docs/reference/workflow-defs-tasks.md +++ b/docs/reference/workflow-defs-tasks.md @@ -26,13 +26,13 @@ A task is a container or a command to run. `.*` -* is optional +* is optional -* Type: `object` ([Task](workflow-defs-task.md)) +* Type: `object` ([Task](workflow-defs-task.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks/patternProperties/.*") +* defined in: [Untitled schema](workflow-defs-task.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks/patternProperties/.*") ### .\* Type diff --git a/docs/reference/workflow-defs-tcpsocketaction.md b/docs/reference/workflow-defs-tcpsocketaction.md index 7fa754f..4dbf8a4 100644 --- a/docs/reference/workflow-defs-tcpsocketaction.md +++ b/docs/reference/workflow-defs-tcpsocketaction.md @@ -26,13 +26,13 @@ Port number of the port to probe. `port` -* is required +* is required -* Type: `integer` ([port](workflow-defs-tcpsocketaction-properties-port.md)) +* Type: `integer` ([port](workflow-defs-tcpsocketaction-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tcpsocketaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction/properties/port") +* defined in: [Untitled schema](workflow-defs-tcpsocketaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction/properties/port") ### port Type diff --git a/docs/reference/workflow-defs-volume.md b/docs/reference/workflow-defs-volume.md index b8acaa7..1f93fb3 100644 --- a/docs/reference/workflow-defs-volume.md +++ b/docs/reference/workflow-defs-volume.md @@ -27,13 +27,13 @@ Volume's name. `name` -* is required +* is required -* Type: `string` ([name](workflow-defs-volume-properties-name.md)) +* Type: `string` ([name](workflow-defs-volume-properties-name.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volume-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/name") +* defined in: [Untitled schema](workflow-defs-volume-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/name") ### name Type @@ -45,13 +45,13 @@ HostPath represents a pre-existing file or directory on the host machine that is `hostPath` -* is required +* is required -* Type: `object` ([HostPath](workflow-defs-hostpath.md)) +* Type: `object` ([HostPath](workflow-defs-hostpath.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-hostpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/hostPath") +* defined in: [Untitled schema](workflow-defs-hostpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/hostPath") ### hostPath Type diff --git a/docs/reference/workflow-defs-volumemount.md b/docs/reference/workflow-defs-volumemount.md index f5b80bd..cc8e3f0 100644 --- a/docs/reference/workflow-defs-volumemount.md +++ b/docs/reference/workflow-defs-volumemount.md @@ -27,13 +27,13 @@ This must match the name of a volume. `name` -* is required +* is required -* Type: `string` ([name](workflow-defs-volumemount-properties-name.md)) +* Type: `string` ([name](workflow-defs-volumemount-properties-name.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volumemount-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/name") +* defined in: [Untitled schema](workflow-defs-volumemount-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/name") ### name Type @@ -45,13 +45,13 @@ Path within the container at which the volume should be mounted. `mountPath` -* is required +* is required -* Type: `string` ([mountPath](workflow-defs-volumemount-properties-mountpath.md)) +* Type: `string` ([mountPath](workflow-defs-volumemount-properties-mountpath.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volumemount-properties-mountpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/mountPath") +* defined in: [Untitled schema](workflow-defs-volumemount-properties-mountpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/mountPath") ### mountPath Type diff --git a/docs/reference/workflow-defs-workflow-properties-semaphores.md b/docs/reference/workflow-defs-workflow-properties-semaphores.md index e6db5cc..1866b13 100644 --- a/docs/reference/workflow-defs-workflow-properties-semaphores.md +++ b/docs/reference/workflow-defs-workflow-properties-semaphores.md @@ -26,13 +26,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/propertie `.*` -* is optional +* is optional -* Type: `integer` +* Type: `integer` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores/patternProperties/.*") +* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores/patternProperties/.*") ### .\* Type diff --git a/docs/reference/workflow-defs-workflow.md b/docs/reference/workflow-defs-workflow.md index 81fa30c..7438fcb 100644 --- a/docs/reference/workflow-defs-workflow.md +++ b/docs/reference/workflow-defs-workflow.md @@ -32,13 +32,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow `port` -* is optional +* is optional -* Type: `integer` ([port](workflow-defs-workflow-properties-port.md)) +* Type: `integer` ([port](workflow-defs-workflow-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/port") +* defined in: [Untitled schema](workflow-defs-workflow-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/port") ### port Type @@ -50,13 +50,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow `terminationGracePeriodSeconds` -* is optional +* is optional -* Type: `integer` ([terminationGracePeriodSeconds](workflow-defs-workflow-properties-terminationgraceperiodseconds.md)) +* Type: `integer` ([terminationGracePeriodSeconds](workflow-defs-workflow-properties-terminationgraceperiodseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-terminationgraceperiodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/terminationGracePeriodSeconds") +* defined in: [Untitled schema](workflow-defs-workflow-properties-terminationgraceperiodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/terminationGracePeriodSeconds") ### terminationGracePeriodSeconds Type @@ -68,13 +68,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow `tasks` -* is optional +* is optional -* Type: `object` ([Tasks](workflow-defs-tasks.md)) +* Type: `object` ([Tasks](workflow-defs-tasks.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tasks.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/tasks") +* defined in: [Untitled schema](workflow-defs-tasks.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/tasks") ### tasks Type @@ -86,13 +86,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow `volumes` -* is optional +* is optional -* Type: `object[]` ([Volume](workflow-defs-volume.md)) +* Type: `object[]` ([Volume](workflow-defs-volume.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-volumes.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes") +* defined in: [Untitled schema](workflow-defs-workflow-properties-volumes.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes") ### volumes Type @@ -104,13 +104,13 @@ https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow `semaphores` -* is optional +* is optional -* Type: `object` ([semaphores](workflow-defs-workflow-properties-semaphores.md)) +* Type: `object` ([semaphores](workflow-defs-workflow-properties-semaphores.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores") +* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores") ### semaphores Type @@ -122,13 +122,13 @@ A list of environment variables. `env` -* is optional +* is optional -* Type: `object` ([EnvVars](workflow-defs-envvars.md)) +* Type: `object` ([EnvVars](workflow-defs-envvars.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/env") +* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/env") ### env Type @@ -140,13 +140,13 @@ A list of environment variables. `envfile` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/envfile") +* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/envfile") ### envfile Type diff --git a/docs/reference/workflow.md b/docs/reference/workflow.md index aefcdcc..a9a5b34 100644 --- a/docs/reference/workflow.md +++ b/docs/reference/workflow.md @@ -34,13 +34,13 @@ Reference this group by using `Duration` -* is required +* is required -* Type: `object` ([Duration](workflow-defs-duration.md)) +* Type: `object` ([Duration](workflow-defs-duration.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration/properties/Duration") +* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Duration/properties/Duration") #### Duration Type @@ -64,13 +64,13 @@ Reference this group by using `.*` -* is optional +* is optional -* Type: `string` +* Type: `string` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars/patternProperties/.*") +* defined in: [Untitled schema](workflow-defs-envvars-patternproperties-.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/EnvVars/patternProperties/.*") #### .\* Type @@ -107,13 +107,13 @@ Scheme to use for connecting to the host. Defaults to HTTP. `scheme` -* is optional +* is optional -* Type: `string` ([scheme](workflow-defs-httpgetaction-properties-scheme.md)) +* Type: `string` ([scheme](workflow-defs-httpgetaction-properties-scheme.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-scheme.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/scheme") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-scheme.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/scheme") #### scheme Type @@ -125,13 +125,13 @@ Number of the port `port` -* is optional +* is optional -* Type: `integer` ([port](workflow-defs-httpgetaction-properties-port.md)) +* Type: `integer` ([port](workflow-defs-httpgetaction-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/port") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/port") #### port Type @@ -143,13 +143,13 @@ Path to access on the HTTP server. `path` -* is optional +* is optional -* Type: `string` ([path](workflow-defs-httpgetaction-properties-path.md)) +* Type: `string` ([path](workflow-defs-httpgetaction-properties-path.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/path") +* defined in: [Untitled schema](workflow-defs-httpgetaction-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HTTPGetAction/properties/path") #### path Type @@ -173,13 +173,13 @@ Path of the directory on the host. `path` -* is required +* is required -* Type: `string` ([path](workflow-defs-hostpath-properties-path.md)) +* Type: `string` ([path](workflow-defs-hostpath-properties-path.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-hostpath-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath/properties/path") +* defined in: [Untitled schema](workflow-defs-hostpath-properties-path.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/HostPath/properties/path") #### path Type @@ -204,13 +204,13 @@ The container port to expose `containerPort` -* is optional +* is optional -* Type: `integer` ([containerPort](workflow-defs-port-properties-containerport.md)) +* Type: `integer` ([containerPort](workflow-defs-port-properties-containerport.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-port-properties-containerport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/containerPort") +* defined in: [Untitled schema](workflow-defs-port-properties-containerport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/containerPort") #### containerPort Type @@ -222,13 +222,13 @@ The host port to route to the container port `hostPort` -* is optional +* is optional -* Type: `integer` ([hostPort](workflow-defs-port-properties-hostport.md)) +* Type: `integer` ([hostPort](workflow-defs-port-properties-hostport.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-port-properties-hostport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/hostPort") +* defined in: [Untitled schema](workflow-defs-port-properties-hostport.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Port/properties/hostPort") #### hostPort Type @@ -268,13 +268,13 @@ TCPSocketAction describes an action based on opening a socket `tcpSocket` -* is optional +* is optional -* Type: `object` ([TCPSocketAction](workflow-defs-tcpsocketaction.md)) +* Type: `object` ([TCPSocketAction](workflow-defs-tcpsocketaction.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tcpsocketaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/tcpSocket") +* defined in: [Untitled schema](workflow-defs-tcpsocketaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/tcpSocket") #### tcpSocket Type @@ -286,13 +286,13 @@ HTTPGetAction describes an action based on HTTP Locks requests. `httpGet` -* is optional +* is optional -* Type: `object` ([HTTPGetAction](workflow-defs-httpgetaction.md)) +* Type: `object` ([HTTPGetAction](workflow-defs-httpgetaction.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-httpgetaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/httpGet") +* defined in: [Untitled schema](workflow-defs-httpgetaction.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/httpGet") #### httpGet Type @@ -304,13 +304,13 @@ Number of seconds after the process has started before the probe is initiated. `initialDelaySeconds` -* is optional +* is optional -* Type: `integer` ([initialDelaySeconds](workflow-defs-probe-properties-initialdelayseconds.md)) +* Type: `integer` ([initialDelaySeconds](workflow-defs-probe-properties-initialdelayseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-initialdelayseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/initialDelaySeconds") +* defined in: [Untitled schema](workflow-defs-probe-properties-initialdelayseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/initialDelaySeconds") #### initialDelaySeconds Type @@ -322,13 +322,13 @@ How often (in seconds) to perform the probe. `periodSeconds` -* is optional +* is optional -* Type: `integer` ([periodSeconds](workflow-defs-probe-properties-periodseconds.md)) +* Type: `integer` ([periodSeconds](workflow-defs-probe-properties-periodseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-periodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/periodSeconds") +* defined in: [Untitled schema](workflow-defs-probe-properties-periodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/periodSeconds") #### periodSeconds Type @@ -340,13 +340,13 @@ Minimum consecutive successes for the probe to be considered successful after ha `successThreshold` -* is optional +* is optional -* Type: `integer` ([successThreshold](workflow-defs-probe-properties-successthreshold.md)) +* Type: `integer` ([successThreshold](workflow-defs-probe-properties-successthreshold.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-successthreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/successThreshold") +* defined in: [Untitled schema](workflow-defs-probe-properties-successthreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/successThreshold") #### successThreshold Type @@ -358,13 +358,13 @@ Minimum consecutive failures for the probe to be considered failed after having `failureThreshold` -* is optional +* is optional -* Type: `integer` ([failureThreshold](workflow-defs-probe-properties-failurethreshold.md)) +* Type: `integer` ([failureThreshold](workflow-defs-probe-properties-failurethreshold.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe-properties-failurethreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/failureThreshold") +* defined in: [Untitled schema](workflow-defs-probe-properties-failurethreshold.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Probe/properties/failureThreshold") #### failureThreshold Type @@ -399,13 +399,13 @@ Port number of the port to probe. `port` -* is required +* is required -* Type: `integer` ([port](workflow-defs-tcpsocketaction-properties-port.md)) +* Type: `integer` ([port](workflow-defs-tcpsocketaction-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tcpsocketaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction/properties/port") +* defined in: [Untitled schema](workflow-defs-tcpsocketaction-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/TCPSocketAction/properties/port") #### port Type @@ -457,13 +457,13 @@ Services are running in the background. `type` -* is optional +* is optional -* Type: `string` ([type](workflow-defs-task-properties-type.md)) +* Type: `string` ([type](workflow-defs-task-properties-type.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-type.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/type") +* defined in: [Untitled schema](workflow-defs-task-properties-type.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/type") #### type Type @@ -475,13 +475,13 @@ Where to log the output of the task. E.g. if the task is verbose. Defaults to /d `log` -* is optional +* is optional -* Type: `string` ([log](workflow-defs-task-properties-log.md)) +* Type: `string` ([log](workflow-defs-task-properties-log.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-log.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/log") +* defined in: [Untitled schema](workflow-defs-task-properties-log.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/log") #### log Type @@ -493,13 +493,13 @@ Either the container image to run, or a directory containing a Dockerfile. If om `image` -* is optional +* is optional -* Type: `string` ([image](workflow-defs-task-properties-image.md)) +* Type: `string` ([image](workflow-defs-task-properties-image.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-image.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/image") +* defined in: [Untitled schema](workflow-defs-task-properties-image.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/image") #### image Type @@ -511,13 +511,13 @@ Pull policy, e.g. Always, Never, IfNotPresent `imagePullPolicy` -* is optional +* is optional -* Type: `string` ([imagePullPolicy](workflow-defs-task-properties-imagepullpolicy.md)) +* Type: `string` ([imagePullPolicy](workflow-defs-task-properties-imagepullpolicy.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-imagepullpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/imagePullPolicy") +* defined in: [Untitled schema](workflow-defs-task-properties-imagepullpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/imagePullPolicy") #### imagePullPolicy Type @@ -529,13 +529,13 @@ A probe to check if the task is alive, it will be restarted if not. `livenessProbe` -* is optional +* is optional -* Type: `object` ([Probe](workflow-defs-probe.md)) +* Type: `object` ([Probe](workflow-defs-probe.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/livenessProbe") +* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/livenessProbe") #### livenessProbe Type @@ -547,13 +547,13 @@ A probe to check if the task is alive, it will be restarted if not. `readinessProbe` -* is optional +* is optional -* Type: `object` ([Probe](workflow-defs-probe.md)) +* Type: `object` ([Probe](workflow-defs-probe.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/readinessProbe") +* defined in: [Untitled schema](workflow-defs-probe.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/readinessProbe") #### readinessProbe Type @@ -565,13 +565,13 @@ The command to run in the container or on the host. If both the image and the co `command` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/command") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/command") #### command Type @@ -583,13 +583,13 @@ The arguments to pass to the command `args` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/args") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/args") #### args Type @@ -601,13 +601,13 @@ The shell script to run, instead of the command `sh` -* is optional +* is optional -* Type: `string` ([sh](workflow-defs-task-properties-sh.md)) +* Type: `string` ([sh](workflow-defs-task-properties-sh.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-sh.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/sh") +* defined in: [Untitled schema](workflow-defs-task-properties-sh.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/sh") #### sh Type @@ -619,13 +619,13 @@ A directories or files of Kubernetes manifests to apply. Once running the task w `manifests` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/manifests") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/manifests") #### manifests Type @@ -637,13 +637,13 @@ The namespace to run the Kubernetes resource in. Defaults to the namespace of th `namespace` -* is optional +* is optional -* Type: `string` ([namespace](workflow-defs-task-properties-namespace.md)) +* Type: `string` ([namespace](workflow-defs-task-properties-namespace.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-namespace.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/namespace") +* defined in: [Untitled schema](workflow-defs-task-properties-namespace.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/namespace") #### namespace Type @@ -655,13 +655,13 @@ The working directory in the container or on the host `workingDir` -* is optional +* is optional -* Type: `string` ([workingDir](workflow-defs-task-properties-workingdir.md)) +* Type: `string` ([workingDir](workflow-defs-task-properties-workingdir.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-workingdir.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/workingDir") +* defined in: [Untitled schema](workflow-defs-task-properties-workingdir.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/workingDir") #### workingDir Type @@ -673,13 +673,13 @@ The user to run the task as. `user` -* is optional +* is optional -* Type: `string` ([user](workflow-defs-task-properties-user.md)) +* Type: `string` ([user](workflow-defs-task-properties-user.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-user.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/user") +* defined in: [Untitled schema](workflow-defs-task-properties-user.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/user") #### user Type @@ -691,13 +691,13 @@ A list of environment variables. `env` -* is optional +* is optional -* Type: `object` ([EnvVars](workflow-defs-envvars.md)) +* Type: `object` ([EnvVars](workflow-defs-envvars.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/env") +* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/env") #### env Type @@ -709,13 +709,13 @@ Environment file (e.g. .env) to use `envfile` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/envfile") +* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/envfile") #### envfile Type @@ -727,13 +727,13 @@ A list of ports to expose. `ports` -* is optional +* is optional -* Type: `object[]` ([Port](workflow-defs-port.md)) +* Type: `object[]` ([Port](workflow-defs-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-ports.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/ports") +* defined in: [Untitled schema](workflow-defs-ports.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/ports") #### ports Type @@ -745,13 +745,13 @@ Volumes to mount in the container `volumeMounts` -* is optional +* is optional -* Type: `object[]` ([VolumeMount](workflow-defs-volumemount.md)) +* Type: `object[]` ([VolumeMount](workflow-defs-volumemount.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-volumemounts.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts") +* defined in: [Untitled schema](workflow-defs-task-properties-volumemounts.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/volumeMounts") #### volumeMounts Type @@ -763,13 +763,13 @@ Use a pseudo-TTY `tty` -* is optional +* is optional -* Type: `boolean` ([tty](workflow-defs-task-properties-tty.md)) +* Type: `boolean` ([tty](workflow-defs-task-properties-tty.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-tty.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/tty") +* defined in: [Untitled schema](workflow-defs-task-properties-tty.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/tty") #### tty Type @@ -781,13 +781,13 @@ A list of files to watch for changes, and restart the task if they change `watch` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/watch") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/watch") #### watch Type @@ -799,13 +799,13 @@ A mutex to prevent multiple tasks with the same mutex from running at the same t `mutex` -* is optional +* is optional -* Type: `string` ([mutex](workflow-defs-task-properties-mutex.md)) +* Type: `string` ([mutex](workflow-defs-task-properties-mutex.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-mutex.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/mutex") +* defined in: [Untitled schema](workflow-defs-task-properties-mutex.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/mutex") #### mutex Type @@ -817,13 +817,13 @@ A semaphore to limit the number of tasks with the same semaphore that can run at `semaphore` -* is optional +* is optional -* Type: `string` ([semaphore](workflow-defs-task-properties-semaphore.md)) +* Type: `string` ([semaphore](workflow-defs-task-properties-semaphore.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-semaphore.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/semaphore") +* defined in: [Untitled schema](workflow-defs-task-properties-semaphore.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/semaphore") #### semaphore Type @@ -835,13 +835,13 @@ A list of tasks to run before this task `dependencies` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/dependencies") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/dependencies") #### dependencies Type @@ -853,13 +853,13 @@ A list of files this task will create. If these exist, and they're newer than th `targets` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/targets") +* defined in: [Untitled schema](workflow-defs-strings.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/targets") #### targets Type @@ -871,13 +871,13 @@ The restart policy, e.g. Always, Never, OnFailure. Defaults depends on the type `restartPolicy` -* is optional +* is optional -* Type: `string` ([restartPolicy](workflow-defs-task-properties-restartpolicy.md)) +* Type: `string` ([restartPolicy](workflow-defs-task-properties-restartpolicy.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-restartpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/restartPolicy") +* defined in: [Untitled schema](workflow-defs-task-properties-restartpolicy.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/restartPolicy") #### restartPolicy Type @@ -889,13 +889,13 @@ The timeout for the task to be considered stalled. If omitted, the task will be `stalledTimeout` -* is optional +* is optional -* Type: `object` ([Duration](workflow-defs-duration.md)) +* Type: `object` ([Duration](workflow-defs-duration.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/stalledTimeout") +* defined in: [Untitled schema](workflow-defs-duration.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/stalledTimeout") #### stalledTimeout Type @@ -907,13 +907,13 @@ The group this task belongs to. Tasks in the same group will be visually grouped `group` -* is optional +* is optional -* Type: `string` ([group](workflow-defs-task-properties-group.md)) +* Type: `string` ([group](workflow-defs-task-properties-group.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-group.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/group") +* defined in: [Untitled schema](workflow-defs-task-properties-group.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/group") #### group Type @@ -925,13 +925,13 @@ Whether this is the default task to run if no task is specified. `default` -* is optional +* is optional -* Type: `boolean` ([default](workflow-defs-task-properties-default.md)) +* Type: `boolean` ([default](workflow-defs-task-properties-default.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task-properties-default.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/default") +* defined in: [Untitled schema](workflow-defs-task-properties-default.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/default") #### default Type @@ -955,13 +955,13 @@ A task is a container or a command to run. `.*` -* is optional +* is optional -* Type: `object` ([Task](workflow-defs-task.md)) +* Type: `object` ([Task](workflow-defs-task.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-task.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks/patternProperties/.*") +* defined in: [Untitled schema](workflow-defs-task.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Tasks/patternProperties/.*") #### .\* Type @@ -986,13 +986,13 @@ Volume's name. `name` -* is required +* is required -* Type: `string` ([name](workflow-defs-volume-properties-name.md)) +* Type: `string` ([name](workflow-defs-volume-properties-name.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volume-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/name") +* defined in: [Untitled schema](workflow-defs-volume-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/name") #### name Type @@ -1004,13 +1004,13 @@ HostPath represents a pre-existing file or directory on the host machine that is `hostPath` -* is required +* is required -* Type: `object` ([HostPath](workflow-defs-hostpath.md)) +* Type: `object` ([HostPath](workflow-defs-hostpath.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-hostpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/hostPath") +* defined in: [Untitled schema](workflow-defs-hostpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Volume/properties/hostPath") #### hostPath Type @@ -1035,13 +1035,13 @@ This must match the name of a volume. `name` -* is required +* is required -* Type: `string` ([name](workflow-defs-volumemount-properties-name.md)) +* Type: `string` ([name](workflow-defs-volumemount-properties-name.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volumemount-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/name") +* defined in: [Untitled schema](workflow-defs-volumemount-properties-name.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/name") #### name Type @@ -1053,13 +1053,13 @@ Path within the container at which the volume should be mounted. `mountPath` -* is required +* is required -* Type: `string` ([mountPath](workflow-defs-volumemount-properties-mountpath.md)) +* Type: `string` ([mountPath](workflow-defs-volumemount-properties-mountpath.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-volumemount-properties-mountpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/mountPath") +* defined in: [Untitled schema](workflow-defs-volumemount-properties-mountpath.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/VolumeMount/properties/mountPath") #### mountPath Type @@ -1089,13 +1089,13 @@ Reference this group by using `port` -* is optional +* is optional -* Type: `integer` ([port](workflow-defs-workflow-properties-port.md)) +* Type: `integer` ([port](workflow-defs-workflow-properties-port.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/port") +* defined in: [Untitled schema](workflow-defs-workflow-properties-port.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/port") #### port Type @@ -1107,13 +1107,13 @@ Reference this group by using `terminationGracePeriodSeconds` -* is optional +* is optional -* Type: `integer` ([terminationGracePeriodSeconds](workflow-defs-workflow-properties-terminationgraceperiodseconds.md)) +* Type: `integer` ([terminationGracePeriodSeconds](workflow-defs-workflow-properties-terminationgraceperiodseconds.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-terminationgraceperiodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/terminationGracePeriodSeconds") +* defined in: [Untitled schema](workflow-defs-workflow-properties-terminationgraceperiodseconds.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/terminationGracePeriodSeconds") #### terminationGracePeriodSeconds Type @@ -1125,13 +1125,13 @@ Reference this group by using `tasks` -* is optional +* is optional -* Type: `object` ([Tasks](workflow-defs-tasks.md)) +* Type: `object` ([Tasks](workflow-defs-tasks.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-tasks.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/tasks") +* defined in: [Untitled schema](workflow-defs-tasks.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/tasks") #### tasks Type @@ -1143,13 +1143,13 @@ Reference this group by using `volumes` -* is optional +* is optional -* Type: `object[]` ([Volume](workflow-defs-volume.md)) +* Type: `object[]` ([Volume](workflow-defs-volume.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-volumes.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes") +* defined in: [Untitled schema](workflow-defs-workflow-properties-volumes.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/volumes") #### volumes Type @@ -1161,13 +1161,13 @@ Reference this group by using `semaphores` -* is optional +* is optional -* Type: `object` ([semaphores](workflow-defs-workflow-properties-semaphores.md)) +* Type: `object` ([semaphores](workflow-defs-workflow-properties-semaphores.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores") +* defined in: [Untitled schema](workflow-defs-workflow-properties-semaphores.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/semaphores") #### semaphores Type @@ -1179,13 +1179,13 @@ A list of environment variables. `env` -* is optional +* is optional -* Type: `object` ([EnvVars](workflow-defs-envvars.md)) +* Type: `object` ([EnvVars](workflow-defs-envvars.md)) -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/env") +* defined in: [Untitled schema](workflow-defs-envvars.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/env") #### env Type @@ -1197,13 +1197,13 @@ A list of environment variables. `envfile` -* is optional +* is optional -* Type: `string[]` +* Type: `string[]` -* cannot be null +* cannot be null -* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/envfile") +* defined in: [Untitled schema](workflow-defs-envfile.md "https://github.com/kitproj/kit/internal/types/workflow#/$defs/Workflow/properties/envfile") #### envfile Type diff --git a/hack/examples.go b/hack/examples.go index 176259a..cba6ac0 100644 --- a/hack/examples.go +++ b/hack/examples.go @@ -70,7 +70,11 @@ func createExamplesReadme(err error, examples []Example) error { if description == "" { description = example.Documentation } - _, err = out.WriteString(fmt.Sprintf(" * [%s](%s) %s\n", example.Title, example.Name+".md", description)) + title := example.Title + if title == "" { + title = example.Name + } + _, err = out.WriteString(fmt.Sprintf(" * [%s](%s) %s\n", title, example.Name+".md", description)) if err != nil { return fmt.Errorf("failed to write README.md: %w", err) }