Kubernetes Marketplace, gRPC: HelmReleaseService.Update

Статья создана

Yandex Cloud

Обновлена 26 ноября 2024 г.

gRPC request
UpdateHelmReleaseRequest
ValueWithKey
Value
operation.Operation
UpdateHelmReleaseMetadata
HelmRelease

Updates helm release.

gRPC request

rpc Update (UpdateHelmReleaseRequest) returns (operation.Operation)

UpdateHelmReleaseRequest

{
  "id": "string",
  "product_version_id": "string",
  "user_values": [
    {
      "key": "string",
      "value": {
        // Includes only one of the fields `typed_value`
        "typed_value": "string"
        // end of the list of possible fields
      }
    }
  ]
}

Field	Description
id	string Required field. 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 field. The key associated with the value.

value

Value

The value associated with the key.

Value

Field

Description

typed_value

string

The typed string value.

Includes only one of the fields typed_value.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "helm_release_id": "string",
    "product_version_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "cluster_id": "string",
    "app_name": "string",
    "app_namespace": "string",
    "product_id": "string",
    "product_name": "string",
    "product_version": "string",
    "status": "Status",
    "created_at": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see 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	UpdateHelmReleaseMetadata 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
response	HelmRelease The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `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.

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

A Helm Release.

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. `STATUS_UNSPECIFIED` `UNKNOWN`: Helm release status is unknown `DEPLOYED`: Helm release deployed. `UNINSTALLED`: Helm release uninstalled. `SUPERSEDED`: Helm release superseded. `FAILED`: Helm release installation failed. `UNINSTALLING`: Helm release is being uninstalled. `PENDING_INSTALL`: Helm release is to be installed. `PENDING_UPGRADE`: Helm release is to be updated. `PENDING_ROLLBACK`: Helm release is to be rolled back.
created_at	google.protobuf.Timestamp Creation timestamp.

Kubernetes Marketplace, gRPC: HelmReleaseService.Update

gRPC requestgRPC request

UpdateHelmReleaseRequestUpdateHelmReleaseRequest

ValueWithKeyValueWithKey

ValueValue

operation.Operationoperation.Operation

UpdateHelmReleaseMetadataUpdateHelmReleaseMetadata

HelmReleaseHelmRelease

Была ли статья полезна?