Kubernetes Apply Deployment Configuration

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to KUBERNETES_APPLY.

auth_typerequired string

Authorization type. Can be one of BASIC, TOKEN or CERTS.

serverrequired string

The host for the connection.

config_pathrequired string

The path to the configuration file.

loginstring

The username required when auth_type is set to BASIC.

passwordstring

The password required when auth_type is set to BASIC.

tokenstring

The token required when auth_type is set to TOKEN.

client_castring

The certificate authority required when auth_type is set to CERTS.

client_certstring

The client certificate required when auth_type is set to CERTS.

client_keystring

The client key required when auth_type is set to CERTS.

record_argstring

Record current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET.

force_argboolean

Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times.

overwrite_argboolean

Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration.

cascade_argboolean

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_argboolean

Defines whether to select all the specified resources.

grace_period_arginteger

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_argboolean

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_argstring

Overwrite the default whitelist with <group/version/kind> for –prune.

kubectl_versionstring

Version of the kubectl used in the action. Default is “latest”.

Last modified on Oct 7, 2024

JMeter CLI Kubernetes kubectl

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "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"
}'

EXAMPLE RESPONSE
{
  "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"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999