GKE Run Job
Learn more about:
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_JOB . |
integration Required | Integration | The integration. |
gke_auth_type Required | String | Authorization type. Can be one of BASIC , SERVICE_ACCOUNT or CERTS . |
zone_id Required | String | The ID of the GKE zone. |
cluster Required | String | The ID of the GKE cluster. |
application_id Required | String | The ID of the GKE application. |
server_key | String | The server key required when gke_auth_type is set to SERVICE_ACCOUNT . |
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 Job 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. |
not_wait | Boolean | Defines whether the execution should or should not wait for job to end. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name": "Run job","type": "KUBERNETES_RUN_JOB","trigger_time": "ON_EVERY_EXECUTION","zone_id": "europe-west1-c","cluster": "cluster-1","application_id": "tokyo-house-138923","gke_auth_type": "BASIC","record_arg": "NOT_SET","leave_after": true,"not_wait": true,"config_path": "config.yaml","integration": {"hash_id": "5ddb7c180fb38be67bd78a88a"}}
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 job","type": "KUBERNETES_RUN_JOB","trigger_time": "ON_EVERY_EXECUTION","zone_id": "europe-west1-c","cluster": "cluster-1","application_id": "tokyo-house-138923","gke_auth_type": "BASIC","record_arg": "NOT_SET","leave_after": true,"not_wait": true,"config_path": "config.yaml","integration": {"url": "https://api.buddy.works/workspaces/buddy/user/integrations/2","html_url": "https://app.buddy.works/my-id","hash_id": "5ddb7c180fb38be67bd78a88a"},"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","trigger_mode": "MANUAL","ref_name": "master","last_execution_status": "SUCCESSFUL","last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"}}