Kubernetes Apply Deployment Configuration
POST Parameters
Name | Type | Description |
---|---|---|
name 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. |
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. |
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. |
kubectl_version | String | Version of the kubectl used in the action. Default is “latest”. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
"name": "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": "120",
"kubectl_version": "1.11.1"
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "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": "120",
"kubectl_version": "1.11.1",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "test pipeline",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Last modified on December 21, 2022