Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB
deployments

Create a Helm deployment

Creating a Helm deployment

post/api/v1/orgs/{orgId}/clusters/{id}/deployments

Path parameters

orgIdinteger required

Organization identifier

idinteger required

Cluster identifier

Request body

namestring required
versionstring

Version of the deployment. If not specified, the latest version is used.

packagestring byte

The chart content packaged by helm package. If specified chart version is ignored.

namespacestring
releaseNamestring
dryRunboolean
waitboolean

if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful

timeoutinteger

time in seconds to wait for any individual Kubernetes operation (default 300)

odPctsobject

Map of resources in the template where replicas should have a minimum on-demand percentage. Format: <kind.resourceName: min-percentage>

reuseValuesboolean
valuesobject

current values of the deployment

Example request

{
  "wait": false,
  "package": {
    "0": 85,
    "1": 51,
    "2": 100,
    "3": 104,
    "4": 90,
    "5": 50,
    "6": 100,
    "7": 108,
    "8": 99,
    "9": 105,
    "10": 66,
    "11": 121,
    "12": 98,
    "13": 50,
    "14": 78,
    "15": 114,
    "16": 99,
    "17": 119,
    "18": 61,
    "19": 61
  },
  "dryRun": false,
  "releaseName": "singed-bee",
  "odPcts": {
    "deployment.my-deployment": 40
  },
  "values": {
    "ingress": {
      "enabled": "true"
    }
  },
  "name": "banzaicloud-stable/pipeline",
  "namespace": "default",
  "reuseValues": true,
  "version": "0.1.0",
  "timeout": 500
}

Response

Deployment created successfully

releaseNamestring
notesstring base64

deployment notes in base64 encoded format

Example response

{
  "notes": "notes",
  "releaseName": "vigilant-mandrill"
}