Install

Installs helm release into specified Kubernetes Cluster.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const HelmRelease = cloudApi.k8s.marketplace_helm_release.HelmRelease;
const InstallHelmReleaseRequest =
  cloudApi.k8s.marketplace_helm_release_service.InstallHelmReleaseRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.HelmReleaseServiceClient);

  const operation = await client.install(
    InstallHelmReleaseRequest.fromPartial({
      clusterId: "clusterId",
      // productVersionId: "productVersionId",
      // userValues: [{
      // key: "key",
      // value: {
      // typedValue: "typedValue"
      // }
      // }]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof HelmRelease>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.k8s.marketplace.v1.helm_release_pb2 import HelmRelease
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2_grpc import HelmReleaseServiceStub
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2 import InstallHelmReleaseMetadata
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2 import InstallHelmReleaseRequest
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2 import Value
from yandex.cloud.k8s.marketplace.v1.helm_release_service_pb2 import ValueWithKey

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(HelmReleaseServiceStub)
operation = service.Install(
    InstallHelmReleaseRequest(
        cluster_id="clusterId",
        # product_version_id = "productVersionId",
        # user_values = [ValueWithKey(
        # key = "key",
        # value = Value(
        # typed_value = "typedValue"
        # )
        # )]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=HelmRelease,
    meta_type=InstallHelmReleaseMetadata,
)
print(operation_result)

InstallHelmReleaseRequest

clusterId : string

The ID of the Kubernetes cluster where the Helm release is to be installed.

productVersionId : string

The product version ID to install.

userValues : ValueWithKey

User-defined values for the Helm chart during installation.

ValueWithKey

key : string

The key associated with the value.

value : Value

The value associated with the key.

Value

One of value

• typedValue : string

  The typed string value.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : 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.

One of result

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

  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.

---