Kubernetes

Task runner that executes a task inside a pod in a Kubernetes cluster.

text

This plugin is only available in the [Enterprise Edition](https://kestra.io/enterprise) (EE).

This task runner is container-based so the `containerImage` property must be set to be able to use it.

To access the task's working directory, use the `{{workingDir}}` Pebble expression or the `WORKING_DIR` environment variable. Input files and namespace files will be available in this directory.

To generate output files you can either use the `outputFiles` task's property and create a file with the same name in the task's working directory, or create any file in the output directory which can be accessed by the `{{outputDir}}` Pebble expression or the `OUTPUT_DIR` environment variables.

Note that when the Kestra Worker running this task is terminated, the pod will still runs until completion, then after restarting, the Worker will resume processing on the existing pod unless `resume` is set to false.

If your cluster is configure with [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/), you need to configure the service account running your pod need to have the following authorizations: 
- pods: get, create, delete, watch, list
- pods/log: get, watch
- pods/exec: get, watch
As an example, here is a role that grant those authorizations: 
```yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata: 
  name: task-runner
rules: 
- apiGroups: [""]
  resources: ["pods"]
  verbs: ["get", "create", "delete", "watch", "list"]
- apiGroups: [""]
  resources: ["pods/exec"]
  verbs: ["get", "watch"]
- apiGroups: [""]
  resources: ["pods/log"]
  verbs: ["get", "watch"]
```

yaml
type: "io.kestra.plugin.ee.kubernetes.runner.Kubernetes"

Execute a Shell command.

yaml
id: new-shell
namespace: company.team

tasks:
  - id: shell
    type: io.kestra.plugin.scripts.shell.Commands
    taskRunner:
      type: io.kestra.plugin.ee.kubernetes.runner.Kubernetes
    commands:
      - echo "Hello World"

Pass input files to the task, execute a Shell command, then retrieve output files.

yaml
id: new-shell-with-file
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: shell
    type: io.kestra.plugin.scripts.shell.Commands
    inputFiles:
      data.txt: "{{ inputs.file }}"
    outputFiles:
      - out.txt
    containerImage: centos
    taskRunner:
      type: io.kestra.plugin.ee.kubernetes.runner.Kubernetes
    commands:
      - cp {{ workingDir }}/data.txt {{ workingDir }}/out.txt

Dynamic YES

Default default

The namespace where the pod will be created.

Dynamic NO

Default true

Whether to reconnect to the current pod if it already exists.

Dynamic YES

Default PT5S

Format duration

The additional duration to wait for logs to arrive after pod completion.

As logs are not retrieved in real time, we cannot guarantee that we have fetched all logs when the pod complete, therefore we wait for a fixed amount of time to fetch late logs.

Dynamic YES

Default PT10M

Format duration

The maximum duration to wait until the pod is created.

This timeout is the maximum time that Kubernetes scheduler can take to

schedule the pod
pull the pod image
and start the pod.

Dynamic NO

The configuration of the target Kubernetes cluster.

Dynamic YES

Additional YAML spec for the container.

Dynamic NO

Default true

Whether the pod should be deleted upon completion.

Dynamic YES

Additional YAML spec for the sidecar container.

Dynamic NO

Default

{
  "image": "busybox"
}

The configuration of the file sidecar container that handle download and upload of files.

Dynamic YES

The pod custom labels

Kestra will add default labels to the pod with execution and flow identifiers.

Dynamic YES

Node selector for pod scheduling

Kestra will assign the pod to the nodes you want (see Assign Pod Nodes)

Dynamic YES

Additional YAML spec for the pod.

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 NO

The pod custom resources

Dynamic YES

The name of the service account.

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the pod completion unless the task timeout property is set which will take precedence over this property.

Dynamic NO

Format duration

Dynamic NO

Default RETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

Dynamic NO

Minimum >= 1

Dynamic NO

Format duration

Dynamic NO

Default false

Dynamic YES

Default busybox

The image used for the file sidecar container.

Dynamic NO

Format duration

Dynamic NO

Format duration

Dynamic NO

Default RETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

Dynamic NO

Minimum >= 1

Dynamic NO

Format duration

Dynamic NO

Default false

Dynamic NO

Format duration

Dynamic NO

Format duration

Dynamic NO

Default RETRY_FAILED_TASK

Possible Values

RETRY_FAILED_TASKCREATE_NEW_EXECUTION

Dynamic NO

Minimum >= 1

Dynamic NO

Format duration

Dynamic NO

Default false

Dynamic YES

Default v1

The API version

Dynamic YES

CA certificate as data

Dynamic YES

CA certificate as file path

Dynamic YES

Client certificate as data

Dynamic YES

Client certificate as a file path

Dynamic YES

Default RSA

Client key encryption algorithm

default is RSA

Dynamic YES

Client key as data

Dynamic YES

Client key as a file path

Dynamic YES

Client key passphrase

Dynamic NO

Disable hostname verification

Dynamic YES

Key store file

Dynamic YES

Key store passphrase

Dynamic YES

Default https://kubernetes.default.svc

The url to the Kubernetes API

Dynamic YES

The namespace used

Dynamic YES

Oauth token

Dynamic NO

Oauth token provider

Dynamic YES

Password

Dynamic NO

Trust all certificates

Dynamic YES

Truststore file

Dynamic YES

Truststore passphrase

Dynamic YES

Username

Dynamic NO

Possible Values

FAILWAITCANCEL

Dynamic NO

​Kubernetes

Kubernetes