batect.yml
Batect configuration file
| Type | object |
|---|---|
| File match |
batect.yml
batect-bundle.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/batect-yml/latest.json |
| Source | https://ide-integration.batect.dev/v1/configSchema.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Definitions for each of the containers that make up your various environments
Definitions for each of your tasks, the actions you launch through Batect
Definitions for each of the config variables used to configure your tasks and containers
The name of your project. Used to label any images built.
Forbid reporting telemetry information for this project, even if the user has previously consented to telemetry.
List of configuration files to include in this project
Definitions
Definitions for each of the containers that make up your various environments
Image name (in standard Docker image reference format) to use for this container
Path (relative to the configuration file's directory) to a directory containing a Dockerfile to build and use as an image for this container
Dockerfile stage name to build and use for this container
Dockerfile (relative to build_directory) to use when building the image. Defaults to Dockerfile if not set.
Command to run when the container starts
Entrypoint to use to run the command
Working directory to start the container in
5 nested properties
The number of times to perform the health check before considering the container unhealthy
The interval between runs of the health check. Accepts values such as 2s (two seconds) or 1m (one minute).
The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as 2s (two seconds) or 1m (one minute).
The time to wait before timing out a single health check command invocation. Accepts values such as 2s (two seconds) or 1m (one minute).
The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.
Enable privileged mode for the container
Set to true to run an init process inside the container that forwards signals and reaps processes
Additional hostnames to add to /etc/hosts in the container
Docker log driver to use
Additional options to pass to Docker log driver
Whether or not to pull image (including base image for containers that use a built image), even if it has already been pulled
Size of /dev/shm (shared memory for IPC) for the container
Labels to apply to the container
Definitions for each of your tasks, the actions you launch through Batect
Definition of a single task
Specifies what to do when this task starts
6 nested properties
Container to run for this task
Command to run for this task
Entrypoint to use to run the command for this task
Working directory to start the container in
Description shown when running batect --list-tasks
Name used to group tasks when running batect --list-tasks
List of other tasks that should be run before running this task
Customisations for dependency containers run as part of this task
Specifies what to do when this task starts
Container to run for this task
Command to run for this task
Entrypoint to use to run the command for this task
Working directory to start the container in
Working directory to start the container in
Name of the environment variable to expose as a secret
Path to the file to expose as a secret
The number of times to perform the health check before considering the container unhealthy
The interval between runs of the health check. Accepts values such as 2s (two seconds) or 1m (one minute).
The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as 2s (two seconds) or 1m (one minute).
The time to wait before timing out a single health check command invocation. Accepts values such as 2s (two seconds) or 1m (one minute).
The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.
Definitions for each of the config variables used to configure your tasks and containers
Definition of a single config variable
Human-readable description of the purpose of the variable
Default value of the variable if one is not provided elsewhere
List of configuration files to include in this project