pluginsplugin-kubernetes

Get​Get

Get one or many Kubernetes resources of a kind.

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

Get all pods from Kubernetes using YAML (<=> kubectl get pods).

yaml
id: get_all_pods
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.kubernetes.kubectl.Get
    namespace: default
    resourceType: pods
    fetchType: FETCH

Get one deployment named my-deployment from Kubernetes using YAML (<=> kubectl get deployment my-deployment).

yaml
id: get_one_deployment
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.kubernetes.kubectl.Get
    namespace: default
    resourceType: deployments
    resourcesNames:
      - my-deployment
    fetchType: FETCH_ONE

Get two deployments named my-deployment and my-deployment-2 from Kubernetes using YAML (<=> kubectl get deployment my-deployment) and store them in the internal storage.

yaml
id: get_two_deployments
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.kubernetes.kubectl.Get
    namespace: default
    resourceType: deployments
    resourcesNames:
      - my-deployment
      - my-deployment-2
    fetchType: STORE

Get one custom resource named Shirt from Kubernetes using YAML (<=> kubectl get Shirt).

yaml
id: get_one_custom_resource
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.kubernetes.kubectl.Get
    namespace: default
    resourceType: shirts # could be Shirt
    apiGroup: stable.example.com
    apiVersion: v1
    fetchType: FETCH_ONE
Properties

The Kubernetes namespace

The Kubernetes resource type (= kind) (e.g. pod, service)

The Kubernetes resource apiGroup

The Kubernetes resource apiVersion

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:

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

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

Default NONE
Possible Values
STOREFETCHFETCH_ONENONE
Default { "image": "busybox" }

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

SubType string

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.

SubType string

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

SubType string

The Kubernetes resources names

Default PT1H
Format duration

The maximum duration to wait for the job completion.

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.

The metadata for a single resource.

Only available when fetchType is set to FETCH_ONE.

SubType

The metadata for multiple resources.

Only available when fetchType is set to FETCH.

The count of the fetched or stored resources.

Format uri

The output files URI in Kestra's internal storage.

Only available when fetchType is set to STORE.

Default v1

The API version

CA certificate as data

CA certificate as file path

Client certificate as data

Client certificate as a file path

Default RSA

Client key encryption algorithm

default is RSA

Client key as data

Client key as a file path

Client key passphrase

Disable hostname verification

Key store file

Key store passphrase

Default https://kubernetes.default.svc

The url to the Kubernetes API

The namespace used

Oauth token

Oauth token provider

Password

Trust all certificates

Truststore file

Truststore passphrase

Username

SubType string

List of all annotations of the resource

Name of the current cluster

Format date-time

Creation datetime

Deletetion grace period in seconds

Format date-time

Deletetion datetime

SubType string

List of finalizers

Generate name of the resource

Generation

SubType string

List of labels

List of managed fields

Name of the resource

Namespace of the resource

List of owner reference

Resource version

Generated Uid of this resource

Default busybox

The image used for the file sidecar container.