Run a Bash script or command (Deprecated).

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

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

Examples

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"}}]}::'

Properties

commands *array

SubType string

Min items 1

The commands to run.

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

dockerOptions DockerOptions

Docker options when using the DOCKER runner.

env object

SubType string

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

exitOnFailed booleanstring

Default true

Exit if any non-true value is returned.

This tells bash that it should exit the script if any statement returns a non-true return value. Setting this to true helps catch cases where a command fails and the script continues to run anyway.

inputFiles object

SubType string

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.

interpreter string

Default /bin/sh

Interpreter to use when launching the process.

interpreterArgs array

SubType string

Default

[
  "-c"
]

Interpreter arguments to be used.

outputFiles array

SubType string

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 }}.

runner string

Default PROCESS

Possible Values

PROCESSDOCKER

The task runner.

Outputs

exitCode integer

Default 0

The exit code of the whole execution.

outputFiles object

SubType string

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

stdErrLineCount integer

Default 0

The standard error line count.

stdOutLineCount integer

Default 0

The standard output line count.

vars object

The value extracted from the output of the commands.

Definitions

io.kestra.plugin.scripts.runner.docker.Cpu

cpus numberstring

The maximum amount of CPU resources a container can use.

Make sure to set that to a numeric value e.g. cpus: "1.5" or cpus: "4" or For instance, if the host machine has two CPUs and you set cpus: "1.5", the container is guaranteed at most one and a half of the CPUs.

io.kestra.plugin.scripts.runner.docker.Memory

kernelMemory string

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.

memory string

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.

memoryReservation string

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.

memorySwap string

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.

memorySwappiness string

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.

oomKillDisable booleanstring

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

io.kestra.plugin.scripts.exec.scripts.models.DockerOptions

image *string

Min length 1

Docker image to use.

config stringobject

Docker configuration file.

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

cpu Cpu

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.

credentials Credentials

deviceRequests array

SubType

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

entryPoint array

SubType string

Docker entrypoint to use.

extraHosts array

SubType string

Extra hostname mappings to the container network interface configuration.

host string

Docker API URI.

memory Memory

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.

networkMode string

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

privileged booleanstring

Give extended privileges to this container.

pullPolicy string

Default IF_NOT_PRESENT

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.

shmSize string

Size of /dev/shm in bytes.

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

user string

User in the Docker container.

volumes array

SubType string

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.

Credentials for a private container registry.

auth string

The registry authentication.

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

identityToken string

The identity token.

password string

The registry password.

registry string

The registry URL.

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

registryToken string

The registry token.

username string

The registry username.

A request for devices to be sent to device drivers.

capabilities array

SubType array

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

count integerstring

deviceIds array

SubType string

driver string

options object

SubType string

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

These options are passed directly to the driver.