Kubernetes Run Helm CMDs

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to HELM.
auth_type
Required
StringAuthorization type. Can be one of BASIC, TOKEN or CERTS.
server
Required
StringThe host for the connection.
execute_commands
Required
String[]The commands that will be executed.
helm_version
Required
StringThe Helm version.
helm_repository_regionStringHelm repository region. Set it if Helm repository is on AWS S3.
helm_repository_integrationIntegrationAmazon integration ID. Set it if Helm repository is on AWS S3.
helm_repository_keyStringService Account Key from Google Cloud Storage. Set it if Helm repository is on GCS.
setup_commandsString[]Allow you to install Helm plugins.
loginStringThe username required when auth_type is set to BASIC.
passwordStringThe password required when auth_type is set to BASIC.
tokenStringThe token required when auth_type is set to TOKEN.
client_caStringThe certificate authority required when auth_type is set to CERTS.
client_certStringThe client certificate required when auth_type is set to CERTS.
client_keyStringThe client key required when auth_type is set to CERTS.
kubectl_versionStringVersion of the kubectl used in the action. Default is “latest”.
shellStringThe name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.

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==",
  "shell": "SH",
  "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==",
  "shell": "SH",
  "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",
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "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
  }
}

Last modified on November 16, 2022

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.