Kubernetes Run Pod with YAML

Table of Contents

YAML parameters for Kubernetes Run Pod

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_RUN_POD.
auth_type
Required
StringAuthorization type. Can be one of BASIC, TOKEN or CERTS.
server
Required
StringThe host for the connection.
save_config_argBooleanIf 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.
loginStringThe username required when auth_type is set to BASIC.
passwordStringThe password required when auth_type is set to BASIC.
tokenStringThe token required when auth_type is set to TOKEN.
client_caStringThe certificate authority required when auth_type is set to CERTS.
client_certStringThe client certificate required when auth_type is set to CERTS.
client_keyStringThe client key required when auth_type is set to CERTS.
record_argStringRecord 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_afterBooleanDefines whether to leave the Pod or delete it after the action finishes.
config_pathStringThe repository path to the configuration file. One of config_path or content must be specified.
contentStringThe configuration content. One of config_path or content must be specified.
not_waitBooleanDefines whether the execution should or should not wait for job to end.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Kubernetes Run Pod

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

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_RUN_POD.
integration_hash
Required
StringThe ID of the Google or Amazon integration.
zone_id
Required
StringThe ID of the GKE zone.
cluster
Required
StringThe ID of the GKE and Amazon EKS cluster.
application_id
Required
StringThe ID of the GKE application.
gke_auth_type
Required
StringAuthorization type. Set to SERVICE_ACCOUNT.
save_config_argBooleanIf 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_argStringRecord 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_afterBooleanDefines whether to leave the Pod or delete it after the action finishes.
config_pathStringThe repository path to the configuration file. One of config_path or content must be specified.
contentStringThe configuration content. One of config_path or content must be specified.
not_waitBooleanDefines whether the execution should or should not wait for job to end.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on GKE cluster

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_hash: "5ddb7c180fb38be67bd78a88a"
  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

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_RUN_POD.
integration_hash
Required
StringThe ID of the Amazon integration.
cluster
Required
StringThe ID of the GKE and Amazon EKS cluster.
region
Required
StringThe Amazon region. Required when Amazon EKS cluster is set.
role_arn
Required
StringContains information about an IAM role. Can be set for Amazon EKS cluster.
save_config_argBooleanIf 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_argStringRecord 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_afterBooleanDefines whether to leave the Pod or delete it after the action finishes.
config_pathStringThe repository path to the configuration file. One of config_path or content must be specified.
contentStringThe configuration content. One of config_path or content must be specified.
not_waitBooleanDefines whether the execution should or should not wait for job to end.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Amazon EKS cluster

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

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_RUN_POD.
integration_hash
Required
StringThe ID of the Azure integration.
subscription_id
Required
StringThe ID of Azure subscription.
resource_group_name
Required
StringThe Azure resource group name in which the AKS cluster is set.
resource_name
Required
StringThe name of the Kubernetes service in Azure.
save_config_argBooleanIf 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_argStringRecord 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_afterBooleanDefines whether to leave the Pod or delete it after the action finishes.
config_pathStringThe repository path to the configuration file. One of config_path or content must be specified.
contentStringThe configuration content. One of config_path or content must be specified.
not_waitBooleanDefines whether the execution should or should not wait for job to end.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Azure AKS cluster

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_hash: "5ddb7c180fb38be67bd78a88a"
  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

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_RUN_POD.
integration_hash
Required
StringThe ID of Digital Ocean integration.
digital_ocean_cluster
Required
StringThe ID of the DO cluster.
save_config_argBooleanIf 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_argStringRecord 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_afterBooleanDefines whether to leave the Pod or delete it after the action finishes.
config_pathStringThe repository path to the configuration file. One of config_path or content must be specified.
contentStringThe configuration content. One of config_path or content must be specified.
not_waitBooleanDefines whether the execution should or should not wait for job to end.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.

YAML example for Run Pod on Digital Ocean cluster

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_hash: "5ddb7c180fb38be67bd78a88a"
  digital_ocean_cluster: "0ec55079-0398-4cfc-9b51-97e07cb07ae7"

Last modified on December 22, 2022

Get Started

Sign up for free and deploy your project in less than 10 minutes.