Instance template

When creating a group, you need to describe an instance template, which is the basic instance configuration used for deploying all instances in the group.

Both the template and policy description are provided to the CLI in a YAML file using the --file flag when creating or updating an instance group. This is a convenient method to provide values that consist of multiple strings. For more information, see Creating a fixed-size instance group.

You can set variable values for the instance template. For more information, see Variables in an instance template.

Computing resourcesComputing resources

When describing a template, you specify the computing resources to allocate to each instance, i.e., the number and guaranteed performance of processor cores (vCPUs) and the amount of RAM. You can choose the computing resources that are appropriate for the expected load. For more information, see vCPU performance levels.

You can also use configure the template to create preemptible instances, which are cheaper than regular ones. Preemptible instances can only be autohealed if there is enough computing resources in the availability zone. If the resources are insufficient, Instance Groups will resume autohealing as soon as the resources become available; this, however, may take a longer time.

You can enable a software-accelerated network for group instances. This will transfer the processing of VM network traffic to additional compute cores.

Disks and file storagesDisks and file storages

Each instance must have at least one disk attached, which is a boot disk. Each boot disk is created automatically and attached to a single instance when creating an instance group. For more information, see Disks.

You can also attach additional disks to each instance. You can create an additional disk along with an instance group. You can create an empty disk or restore it from a snapshot or an image. You can only attach or detach additional disks when creating or updating a group. You can update secondary disks by updating YAML specification.

In addition to disks, you can also attach file storages to instances within a group. File storages allow configuring an instance to handle stateful workloads by saving the states of applications running on the instance to the storage independent of the instance group.

After attaching a file storage to a VM in the group, mount it on the VM's operating system. You can attach file storages using the CLI, Terraform, or API. For more information, see Creating an instance group connected to a file storage.

NetworkNetwork

When creating a group, you can:

• Set the network for the entire group.
• Set subnets for each instance in the group.

A service account used to perform operations in Instance Groups should have a role for accessing network and subnets where the instance group is located. For more information, see Access.

You can create a group without specifying any subnets for its instances if the availability zone selected for each instance contains exactly one subnet for the specified network.

You can also configure a public IP address for each instance. This allows the instance to connect to other services over the internet. For more information, see VM network interfaces.

You can specify the appropriate security groups in a template or configure them individually for each instance in the group.

MetadataMetadata

You can use a template to describe the metadata service parameters and the VM metadata for the instances in the group. For example, in the user-data key, you can describe the system users to be added or the software installation scripts to be run when creating a new VM. Read more about the metadata supported by Compute Cloud in VM metadata.

Template description in a YAML fileTemplate description in a YAML file

A template describes the configuration of the base instance. It is defined in the instance_template key in a YAML file.

Here is how a YAML file entry may look like:

...
instance_template:
  platform_id: standard-v3
  resources_spec:
    memory: 2G
    cores: 2
    core_fraction: 20
  boot_disk_spec:
    mode: READ_WRITE
    disk_spec:
      image_id: jk9ib7ecsbrj********
      type_id: network-hdd
      size: 50G
      preserve_after_instance_delete: false
  secondary_disk_specs:
    - name: disk-2
      mode: READ_WRITE
      disk_spec:
        preserve_after_instance_delete: false
        type_id: network-hdd
        size: 21474836480
  filesystem_specs:
    - mode: READ_WRITE
      device_name: sample-fs
      filesystem_id: epdccsrlalon********
  network_interface_specs:
    - network_id: adv1rq7pmi05********
      subnet_ids:
        - u8zxv2v5f3rr********
      primary_v4_address_spec: {
        one_to_one_nat_spec: {
          ip_version: IPV4
        }
      }
      security_group_ids:
        - enps0ar5s3ti********
  network_settings:
    type: SOFTWARE_ACCELERATED
  placement_policy:
    placement_group_id: rmppvhrgm77g********
  service_account_id: ajegtlf2q28a********
  metadata_options:
    gce_http_endpoint: ENABLED
    aws_v1_http_endpoint: DISABLED
    gce_http_token: DISABLED
    aws_v1_http_token: DISABLED
  metadata:
    user-data: |-
      #cloud-config
      write_files:
        - path: /var/lib/cloud/scripts/per-boot/01-run-load-generator.sh
          permissions: '0555'
          content: |
            #!/bin/bash
            docker run -d --net=host -p 80:80 openresty/openresty:alpine
      users:
        - name: my-user
          groups: sudo
          shell: /bin/bash
          sudo: 'ALL=(ALL) NOPASSWD:ALL'
          ssh_authorized_keys:
            - ssh-ed25519 AAAAB3...
...

By default, the disk size is specified in bytes. You can specify a different unit of measurement using the applicable suffix.

Keys (the table lists keys that directly define the base instance configuration):

For information about the technical restrictions of Instance Groups, see Quotas and limits in Compute Cloud.

Use casesUse cases

• Running an autoscaling instance group
• Scheduled instance group scaling
• Autoscaling an instance group to process messages in Yandex Message Queue

See alsoSee also

• VM metadata
• Creating a VM with a custom configuration script