Bash Bash

yaml
type: "io.kestra.core.tasks.scripts.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.

Examples

Single bash command.

yaml
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"
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"
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"
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"
type: "io.kestra.core.tasks.scripts.Bash"
runner: DOCKER
dockerOptions:
  image: php
commands:
  - 'php -r 'print(phpversion() . "\n");'

Execute cmd on Windows.

yaml
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"
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"
type: "io.kestra.core.tasks.scripts.Bash"
commands:
  - echo '::{"metrics":[{"name":"count","type":"counter","value":1,"tags":{"tag1":"i","tag2":"win"}}]}::'

Properties

commands

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min items: 1

The commands to run.

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

exitOnFailed

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • 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.

interpreter

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: /bin/sh
  • Min length: 1

Interpreter to use when launching the process.

runner

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: PROCESS
  • Possible Values:
    • PROCESS
    • DOCKER

The task runner.

warningOnStdErr

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Whether to set the execution state to WARNING if any stdErr is emitted.

dockerOptions

Docker options when using the DOCKER runner.

env

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

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

files

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

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

Use outputFiles instead.

inputFiles

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

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.

interpreterArgs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌
  • Default: [-c]

Interpreter arguments to be used.

outputDirs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

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 .

outputFiles

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

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 .

outputsFiles

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Deprecated Output files.

Use outputFiles instead.

Outputs

exitCode

  • Type: integer
  • Dynamic: ❓
  • Required: ✔️
  • Default: 0

The exit code of the whole execution.

files

  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Deprecated Output files.

Use outputFiles instead.

outputFiles

  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

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

stdErrLineCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The standard error line count.

stdOutLineCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The standard output line count.

vars

  • Type: object
  • Dynamic: ❓
  • Required: ❌

The value extracted from the output of the commands.

Definitions

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

Properties

cpus
  • Type: integer
  • Dynamic: ❌
  • Required: ❌

The maximum amount of CPU resources a container can use.

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

Properties

kernelMemory
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. 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 --kernel-memory details.

memory
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of memory resources the container can use.

It is recommended that you set the value to at least 6 megabytes.

memoryReservation
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk.

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

memorySwappiness
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk.

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
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

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

Properties

image
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Docker image to use.

config
  • Type:
    • string
    • object
  • Dynamic: ✔️
  • Required: ❌

Docker configuration file.

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

cpu
  • Type: Cpu
  • Dynamic: ❌
  • Required: ❌

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
deviceRequests

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

entryPoint
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Docker entrypoint to use.

extraHosts
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Extra hostname mappings to the container network interface configuration.

host
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker API URI.

memory
  • Type: Memory
  • Dynamic: ❌
  • Required: ❌

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
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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

pullPolicy
  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: ALWAYS
  • Possible Values:
    • IF_NOT_PRESENT
    • ALWAYS
    • NEVER

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
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Size of /dev/shm in bytes.

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

user
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

User in the Docker container.

volumes
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

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.

io.kestra.plugin.scripts.runner.docker.Credentials

Properties

auth
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry authentication.

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

identityToken
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The identity token.

password
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry password.

registry
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry URL.

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

registryToken
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry token.

username
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry username.

io.kestra.plugin.scripts.runner.docker.DeviceRequest

Properties

capabilities
  • Type: array
  • SubType: array
  • Dynamic: ❌
  • Required: ❌

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

count
  • Type: integer
  • Dynamic: ❌
  • Required: ❌
deviceIds
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
driver
  • Type: string
  • Dynamic: ✔️
  • Required: ❌
options
  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

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

These options are passed directly to the driver.

Was this page helpful?