Knowledge

Kubernetes Apply Deployment Configuration

Parameters

Name Description
name Required String The name of the action.
trigger_time Required String Specifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
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.
login String The username required when auth_type is set to BASIC.
passwordString 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.
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.
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.
grace_period_arg 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.
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.
timeout_arg String Only relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).

Example

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"
    save_config_arg: false
    force_arg: false
    overwrite_arg: false
    cascade_arg: false
    all_arg: true
    grace_period_arg: 0
    prune_arg: true
    prune_whitelist_arg: ""
    timeout_arg: "0s"

Get started now

14 days of unlimited trial. No credit card required.