Kubernetes Run Helm CMDs

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `HELM`.
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.
integration_hash `Required`	String	The ID of the Google integration.
integration `Required`	Integration	The integration.
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.
helm_version `Required`	String	The Helm version.
helm_repository_region	String	Helm repository region. Set it if Helm repository is on AWS S3.
helm_repository_integration	Integration	Amazon integration ID. Set it if Helm repository is on AWS S3.
helm_repository_key	String	Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS.
setup_commands	String	Allow you to install Helm plugins.
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”.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
  "name": "Kubernetes - execute: # helm upgrade i myvalues.yaml f override.yaml myApp .chart",
  "type": "HELM",
  "login": "admin",
  "password": "secure!QEJMXFs6anlOLO/+feiNVg==",
  "trigger_time": "ON_EVERY_EXECUTION",
  "helm_repository_integration": {
    "hash_id": "5e1873c2e36b2f65b2896101",
    "type": "AMAZON"
  },
  "execute_commands": [
    "kubectl apply f ./mymanifest.yaml",
    "helm upgrade i myvalues.yaml f override.yaml myApp .chart"
  ],
  "setup_commands": [
    "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0",
    "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1"
  ],
  "helm_version": "v3.0.1",
  "auth_type": "BASIC",
  "server": "$serverAddress",
  "kubectl_version": "latest",
  "timeout": 5
}

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": "Kubernetes - execute: # helm upgrade i myvalues.yaml f override.yaml myApp .chart",
  "type": "HELM",
  "login": "admin",
  "password": "secure!QEJMXFs6anlOLO/+feiNVg==",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "disabled": false,
  "helm_repository_integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/5e1873c2e36b2f65b2896101",
    "html_url": "https://app.dev.io/my-id",
    "hash_id": "5e1873c2e36b2f65b2896101",
    "type": "AMAZON"
  },
  "execute_commands": [
    "kubectl apply f ./mymanifest.yaml",
    "helm upgrade i myvalues.yaml f override.yaml myApp .chart"
  ],
  "setup_commands": [
    "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0",
    "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1"
  ],
  "auth_type": "BASIC",
  "server": "$serverAddress",
  "kubectl_version": "latest",
  "helm_version": "v3.0.1",
  "trigger_condition": "ALWAYS",
  "run_next_parallel": false,
  "timeout": 5,
  "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 server",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "ref_type": "BRANCH",
    "last_execution_status": "INITIAL",
    "last_execution_revision": null,
    "always_from_scratch": false,
    "ignore_fail_on_project_status": false,
    "no_skip_to_most_recent": false,
    "auto_clear_cache": false,
    "do_not_create_commit_status": false
  }
}

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.

Kubernetes Run Helm CMDs

Questions?

Sign up for Buddy Digest

Get started for free