Kubernetes kubectl
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_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 . |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name": "Run kubectl","type": "KUBERNETES_CLI","trigger_time": "ON_EVERY_EXECUTION","auth_type": "BASIC","server": "https://123.45.56.89:6443","login": "admin","password": "qwerty","shell": "SH","kubectl_version": "1.11.1","execute_commands": ["kubectl --namespace=buddy-tests get pods"],}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-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": "Run kubectl","type": "KUBERNETES_CLI","trigger_time": "ON_EVERY_EXECUTION","auth_type": "BASIC","server": "https://123.45.56.89:6443","login": "admin","password": "qwerty","shell": "SH","kubectl_version": "1.11.1","execute_commands": ["kubectl --namespace=buddy-tests get pods"],"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"}}