AddZookeeper

Adds a ZooKeeper subcluster to the specified ClickHouse cluster.

TypeScript

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

const AddClusterZookeeperRequest =
  cloudApi.mdb.clickhouse_cluster_service.AddClusterZookeeperRequest;
const Cluster = cloudApi.dataproc.cluster.Cluster;
const Host_Type = cloudApi.mdb.clickhouse_cluster.Host_Type;

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

  const operation = await client.addZookeeper(
    AddClusterZookeeperRequest.fromPartial({
      clusterId: "clusterId",
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskSize: 0,
      // diskTypeId: "diskTypeId"
      // },
      // hostSpecs: [{
      // zoneId: "zoneId",
      // type: Host_Type.CLICKHOUSE,
      // subnetId: "subnetId",
      // assignPublicIp: true,
      // shardName: "shardName"
      // }],
      // convertTablesToReplicated: {
      // value: true
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import AddClusterZookeeperMetadata
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import AddClusterZookeeperRequest
from yandex.cloud.dataproc.v1.cluster_pb2 import Cluster
from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import HostSpec
from yandex.cloud.mdb.clickhouse.v1.cluster_pb2 import Resources

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.AddZookeeper(
    AddClusterZookeeperRequest(
        cluster_id="clusterId",
        # resources = Resources(
        # resource_preset_id = "resourcePresetId",
        # disk_size = 0,
        # disk_type_id = "diskTypeId"
        # ),
        # host_specs = [HostSpec(
        # zone_id = "zoneId",
        # type = Host.Type.CLICKHOUSE,
        # subnet_id = "subnetId",
        # assign_public_ip = true,
        # shard_name = "shardName"
        # )],
        # convert_tables_to_replicated = BoolValue(
        # value = true
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Cluster,
    meta_type=AddClusterZookeeperMetadata,
)
print(operation_result)

AddClusterZookeeperRequest

clusterId : string

ID of the ClickHouse cluster to modify.

resources : Resources

Resources allocated to Zookeeper hosts.

hostSpecs : HostSpec

Configuration of ZooKeeper hosts.

convertTablesToReplicated : google.protobuf.BoolValue

Enable automatic convertation of non-replicated MergeTree tables to replicated ones.

Resources

resourcePresetId : string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation

diskSize : int64

Volume of the storage available to a host, in bytes.

diskTypeId : string

Type of the storage environment for the host. Possible values:

• network-hdd - network HDD drive,
• network-ssd - network SSD drive,
• local-ssd - local SSD storage.

HostSpec

zoneId : string

ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

type : Host.Type

Type of the host to be deployed.

subnetId : string

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field.

assignPublicIp : bool

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed.

Possible values:

• false - don't assign a public IP to the host.
• true - the host should have a public IP address.

shardName : string

Name of the shard that the host is assigned to.

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.

---