Kubernetes Run Pod with YAML

Tip

Learn more about: - Run Kubernetes Pod action features - Run Kubernetes Pod integrations - Run Kubernetes Pod alternatives

YAML parameters for Kubernetes Run Pod

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `KUBERNETES_RUN_POD`.
auth_type `Required`	String	Authorization type. Can be one of `BASIC`, `TOKEN` or `CERTS`.
server `Required`	String	The host for the connection.
save_config_arg	Boolean	If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
login	String	The username required when `auth_type` is set to `BASIC`.
password	String	The password required when `auth_type` is set to `BASIC`.
token	String	The token required when `auth_type` is set to `TOKEN`.
client_ca	String	The certificate authority required when `auth_type` is set to `CERTS`.
client_cert	String	The client certificate required when `auth_type` is set to `CERTS`.
client_key	String	The client key required when `auth_type` is set to `CERTS`.
record_arg	String	Record current kubectl command in the resource annotation. Can be one of `TRUE`, `FALSE` or `NOT_SET`. If set to `FALSE`, do not record the command. If set to `TRUE`, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_after	Boolean	Defines whether to leave the Pod or delete it after the action finishes.
config_path	String	The repository path to the configuration file. One of `config_path` or `content` must be specified.
content	String	The configuration content. One of `config_path` or `content` must be specified.
not_wait	Boolean	Defines whether the execution should or should not wait for job to end.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.

YAML example for Kubernetes Run Pod

yaml
actions:
- action: "Run pod"
  type: "KUBERNETES_RUN_POD"
  trigger_time: "ON_EVERY_EXECUTION"
  auth_type: "BASIC"
  server: "https://123.45.56.89:6443"
  login: "admin"
  password: "qwerty"
  config_path: "config.yaml"
  leave_after: true
  not_wait: true
  kubectl_version: "1.11.1"

Run Pod on GKE cluster

YAML parameters for Run Pod on GKE cluster

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `KUBERNETES_RUN_POD`.
integration `Required`	String	The ID of the Google or Amazon integration.
zone_id `Required`	String	The ID of the GKE zone.
cluster `Required`	String	The ID of the GKE and Amazon EKS cluster.
application_id `Required`	String	The ID of the GKE application.
gkeauthtype `Required`	String	Authorization type. Set to SERVICE_ACCOUNT.
save_config_arg	Boolean	If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
record_arg	String	Record current kubectl command in the resource annotation. Can be one of `TRUE`, `FALSE` or `NOT_SET`. If set to `FALSE`, do not record the command. If set to `TRUE`, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_after	Boolean	Defines whether to leave the Pod or delete it after the action finishes.
config_path	String	The repository path to the configuration file. One of `config_path` or `content` must be specified.
content	String	The configuration content. One of `config_path` or `content` must be specified.
not_wait	Boolean	Defines whether the execution should or should not wait for job to end.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on GKE cluster

yaml
actions:
- action: "Run pod"
  type: "KUBERNETES_RUN_POD"
  trigger_time: "ON_EVERY_EXECUTION"
  config_path: "config.yaml"
  leave_after: true
  not_wait: true
  kubectl_version: "1.11.1"
  integration: "my_integration"
  zone_id: "europe-west1-c"
  cluster: "cluster-1"
  application_id: "tokyo-house-138923"
  gke_auth_type: "SERVICE_ACCOUNT"

Run Pod on Amazon EKS cluster

YAML parameters for Run Pod on Amazon EKS cluster

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `KUBERNETES_RUN_POD`.
integration `Required`	String	The ID of the Amazon integration.
cluster `Required`	String	The ID of the GKE and Amazon EKS cluster.
region `Required`	String	The Amazon region. Required when Amazon EKS cluster is set.
role_arn `Required`	String	Contains information about an IAM role. Can be set for Amazon EKS cluster.
save_config_arg	Boolean	If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
record_arg	String	Record current kubectl command in the resource annotation. Can be one of `TRUE`, `FALSE` or `NOT_SET`. If set to `FALSE`, do not record the command. If set to `TRUE`, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_after	Boolean	Defines whether to leave the Pod or delete it after the action finishes.
config_path	String	The repository path to the configuration file. One of `config_path` or `content` must be specified.
content	String	The configuration content. One of `config_path` or `content` must be specified.
not_wait	Boolean	Defines whether the execution should or should not wait for job to end.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Amazon EKS cluster

yaml
actions:
- action: "Run pod"
  type: "KUBERNETES_RUN_POD"
  trigger_time: "ON_EVERY_EXECUTION"
  config_path: "config.yaml"
  leave_after: true
  not_wait: true
  kubectl_version: "1.11.1"
  integartion_hash: "5ddb7c180fb38be67bd78a88a"
  cluster: "cluster-1"
  region: "us-west-2"
  role_arn: arn:aws:iam::344123456789:role/EKS_TESTS

Run Pod on Azure AKS cluster

YAML parameters for Run Pod on Azure AKS cluster

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `KUBERNETES_RUN_POD`.
integration `Required`	String	The ID of the Azure integration.
subscription_id `Required`	String	The ID of Azure subscription.
resourcegroupname `Required`	String	The Azure resource group name in which the AKS cluster is set.
resource_name `Required`	String	The name of the Kubernetes service in Azure.
save_config_arg	Boolean	If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
record_arg	String	Record current kubectl command in the resource annotation. Can be one of `TRUE`, `FALSE` or `NOT_SET`. If set to `FALSE`, do not record the command. If set to `TRUE`, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_after	Boolean	Defines whether to leave the Pod or delete it after the action finishes.
config_path	String	The repository path to the configuration file. One of `config_path` or `content` must be specified.
content	String	The configuration content. One of `config_path` or `content` must be specified.
not_wait	Boolean	Defines whether the execution should or should not wait for job to end.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Azure AKS cluster

yaml
actions:
- action: "Run pod"
  type: "KUBERNETES_RUN_POD"
  trigger_time: "ON_EVERY_EXECUTION"
  config_path: "config.yaml"
  leave_after: true
  not_wait: true
  kubectl_version: "1.11.1"
  integration: "my_integration"
  subscription_id: "d4fd0732-1b7f-47ff-8ca9-8b003428dcd8"
  resource_group_name: "test-buddy_group"
  resource_name: "buddy-tests"

Run Pod on Digital Ocean cluster

YAML parameters for Run Pod on Digital Ocean cluster

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `KUBERNETES_RUN_POD`.
integration `Required`	String	The ID of Digital Ocean integration.
digitaloceancluster `Required`	String	The ID of the DO cluster.
save_config_arg	Boolean	If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
record_arg	String	Record current kubectl command in the resource annotation. Can be one of `TRUE`, `FALSE` or `NOT_SET`. If set to `FALSE`, do not record the command. If set to `TRUE`, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_after	Boolean	Defines whether to leave the Pod or delete it after the action finishes.
config_path	String	The repository path to the configuration file. One of `config_path` or `content` must be specified.
content	String	The configuration content. One of `config_path` or `content` must be specified.
not_wait	Boolean	Defines whether the execution should or should not wait for job to end.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Digital Ocean cluster

yaml
actions:
- action: "Run pod"
  type: "KUBERNETES_RUN_POD"
  trigger_time: "ON_EVERY_EXECUTION"
  config_path: "config.yaml"
  leave_after: true
  not_wait: true
  kubectl_version: "1.11.1"
  integration: "my_integration"
  digital_ocean_cluster: "0ec55079-0398-4cfc-9b51-97e07cb07ae7"

Last modified on Mar 4, 2025

Kubernetes Run Job Kubernetes Set Image