Get the Current Value Settings for a Helm Chart
get
/api/microservice/Deploy
Gets the current value settings for a Helm chart by Helm release name and version. You set values for installed Helm charts using the POST method on the /api/microservice/Deploy endpoint. Manually installing Helm charts with the a1helm binary will not preserve the value settings.
Request
Query Parameters
-
Helmchart(required): string
The name of the Helm chart package.Example:
example-poller
-
Namespace(required): string
Logical grouping of resources within a cluster.Example:
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
The version of the Helm chart.Example:
6.0.3
-
cluster(required): string
The name of the cluster.Example:
cluster-1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: array
data
The values for the specified Helm chart.
-
message: string
The response message in text.Example:
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : microserviceDeployRead
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
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