Bash

Execute a Bash script, command or set of commands.

This task is deprecated, please use the io.kestra.plugin.scripts.shell.Script or io.kestra.plugin.scripts.shell.Commands task instead.

yaml
type: "io.kestra.core.tasks.scripts.Bash"

Single bash command.

yaml
id: bash_single_command
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    commands:
      - 'echo "The current execution is : {{ execution.id }}"'

Bash command that generate file in storage accessible through outputs.

yaml
id: bash_generate_files
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    outputFiles:
      - first
      - second
    commands:
      - echo "1" >> {{ outputFiles.first }}
      - echo "2" >> {{ outputFiles.second }}

Bash with some inputs files.

yaml
id: bash_input_files
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    inputFiles:
      script.sh: |
        echo {{ workingDir }}
    commands:
      - /bin/bash script.sh

Bash with an input file from Kestra's local storage created by a previous task.

yaml
id: bash_use_input_files
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    inputFiles:
      data.csv: {{ outputs.previousTaskId.uri }}
    commands:
      - cat data.csv

Run a command on a Docker image.

yaml
id: bash_run_php_code
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    runner: DOCKER
    dockerOptions:
      image: php
    commands:
      - php -r 'print(phpversion() . "
");'

Execute cmd on Windows.

yaml
id: bash_run_cmd_on_windows
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    commands:
      - 'echo "The current execution is : {{ execution.id }}"'
    exitOnFailed: false
    interpreter: cmd
    interpreterArgs:
      - /c

Set outputs from bash standard output.

yaml
id: bash_set_outputs
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    commands:
      - echo '::{"outputs":{"test":"value","int":2,"bool":true,"float":3.65}}::'

Send a counter metric from bash standard output.

yaml
id: bash_set_metrics
namespace: company.team

tasks:
  - id: bash
    type: io.kestra.core.tasks.scripts.Bash
    commands:
      - echo '::{"metrics":[{"name":"count","type":"counter","value":1,"tags":{"tag1":"i","tag2":"win"}}]}::'

SubType string

Dynamic YES

Min items 1

The commands to run.

Default command will be launched with /bin/sh -c "commands".

Dynamic YES

Default /bin/sh

Interpreter to use when launching the process.

Dynamic YES

Default true

Dynamic NO

Docker options when using the DOCKER runner.

SubType string

Dynamic YES

One or more additional environment variable(s) to add to the task run.

Dynamic YES

Default true

SubType string

Dynamic YES

Deprecated The list of files that will be uploaded to Kestra's internal storage.

Use outputFiles instead.

SubType string

Dynamic YES

Input files are extra files that will be available in the script's working directory.

Define the files as a map of a file name being the key, and the value being the file's content. Alternatively, configure the files as a JSON string with the same key/value structure as the map. In both cases, you can either specify the file's content inline, or reference a file from Kestra's internal storage by its URI, e.g. a file from an input, output of a previous task, or a Namespace File.

SubType string

Dynamic NO

Default

[
  "-c"
]

Interpreter arguments to be used.

SubType string

Dynamic YES

List of output directories that will be uploaded to Kestra's internal storage.

List of keys that will generate temporary directories. This property can be used with a special variable named outputDirs.key. If you add a file with ["myDir"], you can use the special var echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt, and both the files will be uploaded to Kestra's internal storage. You can reference them in other tasks using {{ outputs.taskId.outputFiles['myDir/file1.txt'] }}.

SubType string

Dynamic YES

Output file list that will be uploaded to Kestra's internal storage.

List of keys that will generate temporary files. This property can be used with a special variable named outputFiles.key. If you add a file with ["first"], you can use the special var echo 1 >> {[ outputFiles.first }}, and on other tasks, you can reference it using {{ outputs.taskId.outputFiles.first }}.

SubType string

Dynamic YES

Deprecated Output files.

Use outputFiles instead.

Dynamic YES

Default PROCESS

Possible Values

PROCESSDOCKER

The task runner.

Default 0

The exit code of the whole execution.

SubType string

Deprecated Output files.

Use outputFiles instead.

SubType string

The output files' URIs in Kestra's internal storage.

Default 0

The standard error line count.

Default 0

The standard output line count.

The value extracted from the output of the commands.

Dynamic YES

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.

Dynamic YES

The maximum amount of memory resources the container can use.

Make sure to use the format number + unit (regardless of the case) without any spaces. The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.

Given that it's case-insensitive, the following values are equivalent:

"512MB"
"512Mb"
"512mb"
"512000KB"
"0.5GB"

It is recommended that you allocate at least 6MB.

Dynamic YES

Allows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

Dynamic YES

The total amount of memory and swap that can be used by a container.

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.

Dynamic YES

A setting which controls the likelihood of the kernel to swap memory pages.

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.

Dynamic YES

Min length 1

Docker image to use.

Dynamic YES

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

Dynamic NO

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

Dynamic YES

SubType

Dynamic NO

A list of device requests to be sent to device drivers.

SubType string

Dynamic YES

Docker entrypoint to use.

SubType string

Dynamic YES

Extra hostname mappings to the container network interface configuration.

Dynamic YES

Docker API URI.

Dynamic NO

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

Dynamic YES

Docker network mode to use e.g. host, none, etc.

Dynamic YES

Default ALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

Dynamic YES

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

Dynamic YES

User in the Docker container.

SubType string

Dynamic YES

List of volumes to mount.

Must be a valid mount expression as string, example : /home/user:/app.

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.

Dynamic YES

The registry authentication.

The auth field is a base64-encoded authentication string of username: password or a token.

Dynamic YES

The identity token.

Dynamic YES

The registry password.

Dynamic YES

The registry URL.

If not defined, the registry will be extracted from the image name.

Dynamic YES

The registry token.

Dynamic YES

The registry username.

SubType array

Dynamic YES

A list of capabilities; an OR list of AND lists of capabilities.

Dynamic YES

SubType string

Dynamic YES

SubType string

Dynamic YES

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

​Bash

Bash