Deploy a Helm Chart
post
/api/microservice/Deploy
Deploy a specific version of a Helm chart inside a specific cluster and namespace.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
cluster(required): string
cluster NameExample:
cluster-1
-
CustomValues: string
Custom ValuesExample:
# Default values for example-poller/n/nglobal:/n imageRegistry: replicaCount: 1/n/nimage:/n
-
Helmchart(required): string
The name of the Helm chart packageExample:
example-poller
-
Namespace(required): string
Logical grouping of resources within a clusterExample:
kube-system
-
ReleaseName(required): string
- Release name for the installed Helm chart. - 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`Example:
example-poller-deploy
-
Version(required): string
Version of Helm chartExample:
6.0.3
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: array
data
Records array
-
message: array
message
The response message.
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : data
Type:
array
Records array
Show Source
Example:
[
[
"Service",
"example-poller"
],
[
"Deployment",
"example-poller"
]
]
Nested Schema : message
Type:
array
The response message.
Show Source
Example:
[
"NAME: example-poller",
"LAST DEPLOYED: Sat Oct 21 11:22:51 2023",
"NAMESPACE: a1-management",
"STATUS: deployed",
"REVISION: 1",
"TEST SUITE: None"
]
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object