Kubernetes Run Pod
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_RUN_POD . |
auth_type Required | String | Authorization type. Can be one of BASIC , TOKEN or CERTS . |
server Required | String | The host for the connection. |
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. |
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. |
leave_after | Boolean | Defines whether to leave the Pod or delete it after the action finishes. |
config_path | String | The repository path to the configuration file. One of config_path or content must be specified. |
content | String | The configuration content. One of config_path or content must be specified. |
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": "Run Pod",
"type": "KUBERNETES_RUN_POD",
"trigger_time": "ON_EVERY_EXECUTION",
"auth_type": "BASIC",
"server": "https://123.45.56.89:6443",
"login": "admin",
"password": "qwerty",
"record_arg": "NOT_SET",
"config_path": "config.yaml",
"leave_after": true,
"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": "Run Pod",
"type": "KUBERNETES_RUN_POD",
"trigger_time": "ON_EVERY_EXECUTION",
"auth_type": "BASIC",
"server": "https://123.45.56.89:6443",
"login": "admin",
"password": "qwerty",
"record_arg": "NOT_SET",
"config_path": "config.yaml",
"leave_after": true,
"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