GKE Run Helm

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `HELM`.
execute_commands `Required`	String[]	The commands that will be executed.
integration_hash `Required`	Integration	The ID of the Google 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.
kubectl_version	String	Version of the kubectl used in the action. Default is “latest”.
shell	String	The 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",
  "shell": "SH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "cluster": "cluster-1",
  "application_id": "app-id",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "zone_id": "europe-west3-a",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "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",
  "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",
  "cluster": "cluster-1",
  "application_id": "app-id",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "zone_id": "europe-west3-a",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "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"
  ],
  "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

GKE Run Helm

Knowledge is power!