Kubernetes kubectl with YAML

Tip

Learn more about:

Kubernetes kubectl

YAML parameters for Kubernetes kubectl

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_CLI`.
auth_type `Required`	String	Authorization type. Can be one of `BASIC`, `TOKEN` or `CERTS`.
server `Required`	String	The host for the connection.
execute_commands `Required`	String[]	The commands that will be executed.
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`.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The name of the shell that will be used to execute commands. Can be one of `SH` (default) or `BASH`.

YAML example for Kubernetes kubectl

yaml
actions:
- action: "Run kubectl"
  type: "KUBERNETES_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  auth_type: "BASIC"
  server: "$serverAddress"
  login: "admin"
  password: "qwerty"
  kubectl_version: "1.11.1"
  shell: "SH"
  execute_commands:
  - "kubectl --namespace=buddy-tests get pods"
  variables:
  - key: "serverAddress"
    value: "https://123.45.56.89:6443"

GKE kubectl

YAML parameters for kubectl 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_CLI`.
execute_commands `Required`	String[]	The commands that will be executed.
integration `Required`	String	The ID of the Google integration.
zone_id `Required`	String	The ID of the GKE zone.
cluster `Required`	String	The ID of the GKE cluster.
application_id `Required`	String	The ID of the GKE application.
gke_auth_type `Required`	String	Authorization type. Set to `SERVICE_ACCOUNT`.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The name of the shell that will be used to execute commands. Can be one of `SH` (default) or `BASH`.

YAML example for kubectl on GKE cluster

yaml
actions:
- action: "Run kubectl"
  type: "KUBERNETES_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  kubectl_version: "1.11.1"
  shell: "SH"
  execute_commands:
  - "kubectl --namespace=buddy-tests get pods"
  integration: "my_integration"
  zone_id: "europe-west1-c"
  cluster: "cluster-1"
  application_id: "tokyo-house-138923"
  gke_auth_type: "SERVICE_ACCOUNT"

Amazon EKS

YAML parameters for kubectl 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_CLI`.
execute_commands `Required`	String[]	The commands that will be executed.
integration `Required`	String	The ID of the Amazon integration.
cluster `Required`	String	The ID of the 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.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The name of the shell that will be used to execute commands. Can be one of `SH` (default) or `BASH`.

YAML example for kubectl on Amazon EKS cluster

yaml
actions:
- action: "Run kubectl"
  type: "KUBERNETES_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  auth_type: "BASIC"
  server: "$serverAddress"
  login: "admin"
  password: "qwerty"
  kubectl_version: "1.11.1"
  shell: "SH"
  execute_commands:
  - "kubectl --namespace=buddy-tests get pods"
  integartion_hash: "5ddb7c180fb38be67bd78a88a"
  cluster: "cluster-1"
  region: "us-west-2"
  role_arn: arn:aws:iam::344123456789:role/EKS_TESTS

Azure AKS

YAML parameters for kubectl 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_CLI`.
execute_commands `Required`	String[]	The commands that will be executed.
integration `Required`	String	The ID of the Azure integration.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The name of the shell that will be used to execute commands. Can be one of `SH` (default) or `BASH`.
subscription_id	String	The ID of Azure subscription.
resource_group_name	String	The Azure resource group name in which the AKS cluster is set.
resource_name	String	The name of the Kubernetes service in Azure.

YAML example for kubectl on Azure AKS cluster

yaml
actions:
- action: "Run kubectl"
  type: "KUBERNETES_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  kubectl_version: "1.11.1"
  shell: "SH"
  execute_commands:
  - "kubectl --namespace=buddy-tests get pods"
  integration: "my_integration"
  subscription_id: "d4fd0732-1b7f-47ff-8ca9-8b003428dcd8"
  resource_group_name: "test-buddy_group"
  resource_name: "buddy-tests"

Digital Ocean

YAML parameters for kubectl 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_CLI`.
execute_commands `Required`	String[]	The commands that will be executed.
integration `Required`	String	The ID of the Digital Ocean integration.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The name of the shell that will be used to execute commands. Can be one of `SH` (default) or `BASH`.
digital_ocean_cluster	String	The ID of the Digital Ocean cluster.

YAML example for kubectl on Digital Ocean cluster

yaml
actions:
- action: "Run kubectl"
  type: "KUBERNETES_CLI"
  trigger_time: "ON_EVERY_EXECUTION"
  kubectl_version: "1.11.1"
  shell: "SH"
  execute_commands:
  - "kubectl --namespace=buddy-tests get pods"
  integration: "my_integration"
  digital_ocean_cluster: "0ec55079-0398-4cfc-9b51-97e07cb07ae7"

Last modified on Sep 23, 2024

Kubernetes Apply Deployment Kubernetes Run Helm CMDs