Kubernetes Marketplace, gRPC: HelmReleaseService
A set of methods for managing Helm release.
Call | Description |
---|---|
List | Retrieves the list of Helm releases in the specified Kubernetes Cluster. |
Get | Returns the specified Helm release. |
Install | Installs helm release into specified Kubernetes Cluster. |
Update | Updates helm release. |
Uninstall | Uninstalls helm release. |
Calls HelmReleaseService
List
Retrieves the list of Helm releases in the specified Kubernetes Cluster.
rpc List (ListHelmReleasesRequest) returns (ListHelmReleasesResponse)
ListHelmReleasesRequest
Field | Description |
---|---|
cluster_id | string Required. The ID of the Kubernetes cluster to list Helm releases from. |
page_size | int64 The maximum number of results per page that should be returned. Acceptable values are 0 to 1000, inclusive. |
page_token | string Token for pagination to retrieve the next page of results. The maximum string length in characters is 100. |
ListHelmReleasesResponse
Field | Description |
---|---|
helm_releases[] | HelmRelease List of Helm releases in the Kubernetes cluster. |
next_page_token | string Token for retrieving the next page of Helm releases. |
HelmRelease
Field | Description |
---|---|
id | string ID of a helm release. |
cluster_id | string ID of the Kubernetes cluster. |
app_name | string Name of the application. |
app_namespace | string Namespace of the application. |
product_id | string Kubernetes marketplace product id. |
product_name | string Kubernetes marketplace product name. |
product_version | string Kubernetes marketplace product version. |
status | enum Status Status of a helm release.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
Get
Returns the specified Helm release.
rpc Get (GetHelmReleaseRequest) returns (HelmRelease)
GetHelmReleaseRequest
Field | Description |
---|---|
id | string Required. The ID of the Helm release to retrieve. |
HelmRelease
Field | Description |
---|---|
id | string ID of a helm release. |
cluster_id | string ID of the Kubernetes cluster. |
app_name | string Name of the application. |
app_namespace | string Namespace of the application. |
product_id | string Kubernetes marketplace product id. |
product_name | string Kubernetes marketplace product name. |
product_version | string Kubernetes marketplace product version. |
status | enum Status Status of a helm release.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
Install
Installs helm release into specified Kubernetes Cluster.
rpc Install (InstallHelmReleaseRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:InstallHelmReleaseMetadata
Operation.response:HelmRelease
InstallHelmReleaseRequest
Field | Description |
---|---|
cluster_id | string Required. The ID of the Kubernetes cluster where the Helm release is to be installed. |
product_version_id | string The product version ID to install. |
user_values[] | ValueWithKey User-defined values for the Helm chart during installation. |
ValueWithKey
Field | Description |
---|---|
key | string Required. The key associated with the value. |
value | Value The value associated with the key. |
Value
Field | Description |
---|---|
value | oneof: typed_value |
typed_value | string The typed string value. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
InstallHelmReleaseMetadata
Field | Description |
---|---|
cluster_id | string The ID of the Kubernetes cluster where the Helm release is being installed. |
helm_release_id | string The ID of the Helm release being installed. |
product_version_id | string The ID of the product version being deployed. |
HelmRelease
Field | Description |
---|---|
id | string ID of a helm release. |
cluster_id | string ID of the Kubernetes cluster. |
app_name | string Name of the application. |
app_namespace | string Namespace of the application. |
product_id | string Kubernetes marketplace product id. |
product_name | string Kubernetes marketplace product name. |
product_version | string Kubernetes marketplace product version. |
status | enum Status Status of a helm release.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
Update
Updates helm release.
rpc Update (UpdateHelmReleaseRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateHelmReleaseMetadata
Operation.response:HelmRelease
UpdateHelmReleaseRequest
Field | Description |
---|---|
id | string Required. The ID of the Helm release to update. |
product_version_id | string The ID of the new product version for the release. |
user_values[] | ValueWithKey Custom user values to apply during the update. |
ValueWithKey
Field | Description |
---|---|
key | string Required. The key associated with the value. |
value | Value The value associated with the key. |
Value
Field | Description |
---|---|
value | oneof: typed_value |
typed_value | string The typed string value. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateHelmReleaseMetadata
Field | Description |
---|---|
cluster_id | string The ID of the Kubernetes cluster where the Helm release is being updated. |
helm_release_id | string The ID of the Helm release being updated. |
product_version_id | string The ID of the new product version to update the Helm release to. |
HelmRelease
Field | Description |
---|---|
id | string ID of a helm release. |
cluster_id | string ID of the Kubernetes cluster. |
app_name | string Name of the application. |
app_namespace | string Namespace of the application. |
product_id | string Kubernetes marketplace product id. |
product_name | string Kubernetes marketplace product name. |
product_version | string Kubernetes marketplace product version. |
status | enum Status Status of a helm release.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
Uninstall
Uninstalls helm release.
rpc Uninstall (UninstallHelmReleaseRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UninstallHelmReleaseMetadata
Operation.response:google.protobuf.Empty
UninstallHelmReleaseRequest
Field | Description |
---|---|
id | string Required. The ID of the Helm release to retrieve. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UninstallHelmReleaseMetadata
Field | Description |
---|---|
cluster_id | string Required. The ID of the Kubernetes cluster where the release is being uninstalled. |
helm_release_id | string Required. The ID of the Helm release being uninstalled. |