Kubernetes Set Image
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_SET_IMAGE . |
auth_type Required | String | Authorization type. Can be one of BASIC , TOKEN or CERTS . |
server Required | String | The host for the connection. |
container Required | String | The name of the container. |
namespace Required | String | The name of the namespace. |
deployment Required | String | The name of the deployment from the namespace. |
image_name Required | String | The name of the image to set. |
image_tag Required | String | The tag of the chosen image. |
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. |
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": "Set image",
"type": "KUBERNETES_SET_IMAGE",
"trigger_time": "ON_EVERY_EXECUTION",
"auth_type": "BASIC",
"server": "https://123.45.56.89:6443",
"login": "admin",
"password": "qwerty",
"deployment": "nginx-deployment",
"namespace": "default",
"image_name": "nginx",
"image_tag": "1.7.8",
"record_arg": "NOT_SET",
"container": "nginx",
"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": "Set image",
"type": "KUBERNETES_SET_IMAGE",
"trigger_time": "ON_EVERY_EXECUTION",
"auth_type": "BASIC",
"server": "https://123.45.56.89:6443",
"login": "admin",
"password": "qwerty",
"deployment": "nginx-deployment",
"namespace": "default",
"image_name": "nginx",
"image_tag": "1.7.8",
"record_arg": "NOT_SET",
"container": "nginx",
"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 November 16, 2022