Apply a Kubernetes resource (e.g., a Kubernetes deployment).

yaml
type: "io.kestra.plugin.kubernetes.kubectl.apply"

Apply a Kubernetes resource, using YAML.

yaml
id: create_or_replace_deployment
namespace: company.team

tasks:
  - id: apply
    type: io.kestra.plugin.kubernetes.kubectl.Apply
    namespace: default
    spec: |-
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: mypod

Apply a Kubernetes resource, using a namespace file.

yaml
id: create_or_replace_deployment
namespace: company.team

tasks:
  - id: apply
    type: io.kestra.plugin.kubernetes.kubectl.Apply
    namespaceFiles:
      enabled: true
    namespace: default
    spec: "{{ read('deployment.yaml') }}"

Apply a Kubernetes custom resource definition, using YAML.

yaml
id: k8s
namespace: company.name

tasks:
  - id: apply
    type: io.kestra.plugin.kubernetes.kubectl.Apply
    namespace: default
    spec: |-
      apiVersion: apiextensions.k8s.io/v1
      kind: CustomResourceDefinition
      metadata:
        name: shirts.stable.example.com
      spec:
        group: stable.example.com
        scope: Namespaced
        names:
          plural: shirts
          singular: shirt
          kind: Shirt
        versions:
        - name: v1
          served: true
          storage: true
          schema:
            openAPIV3Schema:
              type: object
              properties:
                apiVersion:
                  type: string
                kind:
                  type: string
                metadata:
                  type: object
                spec:
                  type: object
                  x-kubernetes-preserve-unknown-fields: true # Allows any fields in spec
                  properties:
                    # You should define your actual Shirt properties here later
                    # For example:
                    # color:
                    #   type: string
                    # size:
                    #   type: string
                    #   enum: ["S", "M", "L", "XL"]
                status:
                  type: object
                  x-kubernetes-preserve-unknown-fields: true # Allows any fields in status
                  properties:
                    # Define your status properties here
                    # message:
                    #   type: string

Dynamic YES

The Kubernetes resource spec

Dynamic NO

The connection parameters to the Kubernetes cluster

If no connection is defined, we try to load the connection from the current context in the following order:

System properties
Environment variables
Kube config file
Service account token and a mounted CA certificate.

You can pass a full configuration with all options if needed.

Dynamic NO

Default

{
  "image": "busybox"
}

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

SubType string

Dynamic YES

The files to create on the local filesystem. It can be a map or a JSON object.

The files will be available inside the kestra/working-dir directory of the container. You can use the special variable {{workingDir}} in your command to refer to it.

Dynamic YES

The Kubernetes namespace

SubType string

Dynamic YES

The files from the container filesystem to send to Kestra's internal storage.

Only files created inside the kestra/working-dir directory of the container can be retrieved. Must be a list of glob expressions relative to the current working directory, some examples: my-dir/**, my-dir/*/** or my-dir/my-file.txt..

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the job completion.

Dynamic YES

Default PT10M

Format duration

The maximum duration to wait until the job and the pod is created.

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

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

SubType

The resource metadata.

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

SubType string

Dynamic NO

List of all annotations of the resource

Dynamic NO

Name of the current cluster

Dynamic NO

Format date-time

Creation datetime

Dynamic NO

Deletetion grace period in seconds

Dynamic NO

Format date-time

Deletetion datetime

SubType string

Dynamic NO

List of finalizers

Dynamic NO

Generate name of the resource

Dynamic NO

Generation

SubType string

Dynamic NO

List of labels

SubType

Dynamic NO

List of managed fields

Dynamic NO

Name of the resource

Dynamic NO

Namespace of the resource

SubType

Dynamic NO

List of owner reference

Dynamic NO

Resource version

Dynamic NO

Direct link on the api of this resource

Dynamic NO

Generated Uid of this resource

Dynamic NO

Dynamic YES

Default busybox

The image used for the file sidecar container.

Dynamic NO