YAML parameters for Kubernetes Apply DeploymentYAML example for Kubernetes Apply DeploymentGKE Apply DeploymentYAML parameters for Apply Deployment on GKE clusterYAML example for Apply Deployment on GKE clusterAmazon EKSYAML parameters for Apply Deployment on Amazon EKS clusterYAML example for Apply Deployment on Amazon EKS clusterAzure AKSYAML parameters for Apply Deployment on Azure AKS clusterYAML example for Apply Deployment on Azure AKS clusterDigital OceanYAML parameters for Apply Deployment on Digital Ocean clusterYAML example for Apply Deployment on Digital Ocean cluster
Kubernetes Apply Deployment with YAML
Learn more about:
YAML parameters for Kubernetes Apply Deployment
| Name | Type | Description |
|---|---|---|
action Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_APPLY. |
auth_type Required | String | Authorization type. Can be one of BASIC, TOKEN or CERTS. |
server Required | String | The host for the connection. |
config_path Required | String | The path to the configuration file. |
grace_period_arg Required | Integer | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. |
| 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. |
| force_arg | Boolean | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. |
| overwrite_arg | Boolean | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration. |
| cascade_arg | Boolean | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). |
| all_arg | Boolean | Defines whether to select all the specified resources. |
| prune_arg | Boolean | Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all. |
| prune_whitelist_arg | String | Overwrite the default whitelist with <group/version/kind> for –prune. |
| kubectl_version | String | Version of the kubectl used in the action. Default is <latest>. |
YAML example for Kubernetes Apply Deployment
actions:
- action: "Apply deployment"
type: "KUBERNETES_APPLY"
trigger_time: "ON_EVERY_EXECUTION"
auth_type: "BASIC"
server: "https://123.45.56.89:6443"
login: "admin"
password: "qwerty"
config_path: "config.yaml"
record_arg: "NOT_SET"
force_arg: false
overwrite_arg: false
cascade_arg: false
all_arg: true
grace_period_arg: 0
prune_arg: true
prune_whitelist_arg: ""
timeout: "120"
kubectl_version: "1.11.1"GKE Apply Deployment
YAML parameters for Apply Deployment on GKE cluster
| Name | Type | Description |
|---|---|---|
action Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_APPLY. |
config_path Required | String | The path to the configuration file. |
integration_hash 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. |
gke_auth_type Required | String | Authorization type. Set to SERVICE_ACCOUNT. |
grace_period_arg Required | Integer | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. |
| 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. |
| force_arg | Boolean | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. |
| overwrite_arg | Boolean | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration. |
| cascade_arg | Boolean | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). |
| all_arg | Boolean | Defines whether to select all the specified resources. |
| prune_arg | Boolean | Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all. |
| prune_whitelist_arg | String | Overwrite the default whitelist with <group/version/kind> for –prune. |
| kubectl_version | String | Version of the kubectl used in the action. Default is <latest>. |
YAML example for Apply Deployment on GKE cluster
actions:
- action: "Apply deployment"
type: "KUBERNETES_APPLY"
trigger_time: "ON_EVERY_EXECUTION"
config_path: "config.yaml"
record_arg: "NOT_SET"
force_arg: false
overwrite_arg: false
cascade_arg: false
all_arg: true
grace_period_arg: 0
prune_arg: true
prune_whitelist_arg: ""
timeout: "120"
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"Amazon EKS
YAML parameters for Apply Deployment on Amazon EKS cluster
| Name | Type | Description |
|---|---|---|
action Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_APPLY. |
config_path Required | String | The path to the configuration file. |
integration_hash 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. |
grace_period_arg Required | Integer | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. |
| 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. |
| force_arg | Boolean | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. |
| overwrite_arg | Boolean | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration. |
| cascade_arg | Boolean | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). |
| all_arg | Boolean | Defines whether to select all the specified resources. |
| prune_arg | Boolean | Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all. |
| prune_whitelist_arg | String | Overwrite the default whitelist with <group/version/kind> for –prune. |
| kubectl_version | String | Version of the kubectl used in the action. Default is <latest>. |
YAML example for Apply Deployment on Amazon EKS cluster
actions:
- action: "Apply deployment"
type: "KUBERNETES_APPLY"
trigger_time: "ON_EVERY_EXECUTION"
config_path: "config.yaml"
record_arg: "NOT_SET"
force_arg: false
overwrite_arg: false
cascade_arg: false
all_arg: true
grace_period_arg: 0
prune_arg: true
prune_whitelist_arg: ""
timeout: "120"
kubectl_version: "1.11.1"
integartion_hash: "5ddb7c180fb38be67bd78a88a"
cluster: "cluster-1"
region: "us-west-2"
role_arn: arn:aws:iam::344123456789:role/EKS_TESTSAzure AKS
YAML parameters for Apply Deployment on Azure AKS cluster
| Name | Type | Description |
|---|---|---|
action Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_APPLY. |
config_path Required | String | The path to the configuration file. |
integration_hash Required | String | The ID of the Azure integration. |
subscription_id Required | String | The ID of Azure subscription. |
resource_group_name 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. |
grace_period_arg Required | Integer | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. |
| 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. |
| force_arg | Boolean | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. |
| overwrite_arg | Boolean | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration. |
| cascade_arg | Boolean | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). |
| all_arg | Boolean | Defines whether to select all the specified resources. |
| prune_arg | Boolean | Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all. |
| prune_whitelist_arg | String | Overwrite the default whitelist with <group/version/kind> for –prune. |
| kubectl_version | String | Version of the kubectl used in the action. Default is <latest>. |
YAML example for Apply Deployment on Azure AKS cluster
actions:
- action: "Apply deployment"
type: "KUBERNETES_APPLY"
trigger_time: "ON_EVERY_EXECUTION"
config_path: "config.yaml"
record_arg: "NOT_SET"
force_arg: false
overwrite_arg: false
cascade_arg: false
all_arg: true
grace_period_arg: 0
prune_arg: true
prune_whitelist_arg: ""
timeout: "120"
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"Digital Ocean
YAML parameters for Apply Deployment on Digital Ocean cluster
| Name | Type | Description |
|---|---|---|
action Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_APPLY. |
config_path Required | String | The path to the configuration file. |
integration_hash Required | String | The ID of Digital Ocean integration. |
digital_ocean_cluster Required | String | The ID of the DO cluster. |
grace_period_arg Required | Integer | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. |
| 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. |
| force_arg | Boolean | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. |
| overwrite_arg | Boolean | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration. |
| cascade_arg | Boolean | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). |
| all_arg | Boolean | Defines whether to select all the specified resources. |
| prune_arg | Boolean | Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all. |
| prune_whitelist_arg | String | Overwrite the default whitelist with <group/version/kind> for –prune. |
| kubectl_version | String | Version of the kubectl used in the action. Default is <latest>. |
YAML example for Apply Deployment on Digital Ocean cluster
actions:
- action: "Apply deployment"
type: "KUBERNETES_APPLY"
trigger_time: "ON_EVERY_EXECUTION"
config_path: "config.yaml"
record_arg: "NOT_SET"
force_arg: false
overwrite_arg: false
cascade_arg: false
all_arg: true
grace_period_arg: 0
prune_arg: true
prune_whitelist_arg: ""
timeout: "120"
kubectl_version: "1.11.1"
integration_hash: "5ddb7c180fb38be67bd78a88a"
digital_ocean_cluster: "0ec55079-0398-4cfc-9b51-97e07cb07ae7"Last modified on December 22, 2022