Skip to main content

Create

Creates a subcluster in the specified cluster.

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

const CreateSubclusterRequest =
  cloudApi.dataproc.subcluster_service.CreateSubclusterRequest;
const Role = cloudApi.dataproc.subcluster.Role;
const Subcluster = cloudApi.dataproc.subcluster.Subcluster;

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

  const operation = await client.create(
    CreateSubclusterRequest.fromPartial({
      clusterId: "clusterId",
      // name: "name",
      role: Role.MASTERNODE,
      resources: {
        // resourcePresetId: "resourcePresetId",
        // diskTypeId: "diskTypeId",
        // diskSize: 0
      },
      subnetId: "subnetId",
      hostsCount: 0,
      // autoscalingConfig: {
      // maxHostsCount: 0,
      // preemptible: true,
      // measurementDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // warmupDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // stabilizationDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // cpuUtilizationTarget: 0,
      // decommissionTimeout: 0
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

CreateSubclusterRequest​

clusterId : string​

ID of the Data Proc cluster to create a subcluster in.

To get a cluster ID, make a ClusterService.List request.

name : string​

Name of the subcluster. The name must be unique within the cluster. The name can't be changed when the subcluster is created.

role : Role​

Role that is fulfilled by hosts of the subcluster.

resources : Resources​

Resources allocated for each host in the subcluster.

subnetId : string​

ID of the VPC subnet used for hosts in the subcluster.

hostsCount : int64​

Number of hosts in the subcluster.

autoscalingConfig : AutoscalingConfig​

Configuration for instance group based subclusters

Resources​

resourcePresetId : string​

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

diskTypeId : string​

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

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive.
diskSize : int64​

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

AutoscalingConfig​

maxHostsCount : int64​

Upper limit for total instance subcluster count.

preemptible : bool​

Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.

measurementDuration : google.protobuf.Duration​

Time in seconds allotted for averaging metrics.

warmupDuration : google.protobuf.Duration​

The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.

stabilizationDuration : google.protobuf.Duration​

Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.

cpuUtilizationTarget : double​

Defines an autoscaling rule based on the average CPU utilization of the instance group.

decommissionTimeout : int64​

Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120

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.