Get started
Yandex Managed Service for Kubernetes

NodeGroupService

A set of methods for managing node groups.

Call Description
Get Returns the specified node group.
List Retrieves the list of node group in the specified Kubernetes cluster.
Create Creates a node group in the specified Kubernetes cluster.
Update Updates the specified node group.
Delete Deletes the specified node group.
ListOperations Lists operations for the specified node group.

Calls NodeGroupService

Get

Returns the specified node group.
To get the list of available node group, make a List request.

rpc Get (GetNodeGroupRequest) returns (NodeGroup)

GetNodeGroupRequest

Field Description
node_group_id string
Required. ID of the node group to return. To get the node group ID use a NodeGroupService.List request.

NodeGroup

Field Description
id string
ID of the node group.
cluster_id string
ID of the cluster that the node group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the node group. The name is unique within the folder.
description string
Description of the node group. 0-256 characters long.
labels map<string,string>
Resource labels as key:value pairs. Мaximum of 64 per resource.
status enum Status
Status of the node group.
  • PROVISIONING: Node group is waiting for resources to be allocated.
  • RUNNING: Node group is running.
  • RECONCILING: Node group is waiting for some work to be done, such as upgrading node software.
  • STOPPING: Node group is being stopped.
  • STOPPED: Node group stopped.
  • DELETING: Node group is being deleted.
  • STARTING: Node group is being started.
    node_template NodeTemplate
    Node template that specifies parameters of the compute instances for the node group.
    scale_policy ScalePolicy
    Scale policy of the node group. For more information, see Scaling policy.
    allocation_policy NodeGroupAllocationPolicy
    Allocation policy by which resources for node group are allocated to zones and regions.
    instance_group_id string
    ID of the managed instance group associated with this node group.
    node_version string
    Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
    version_info VersionInfo
    maintenance_policy NodeGroupMaintenancePolicy

    NodeTemplate

    Field Description
    platform_id string
    ID of the hardware platform configuration for the node.
    resources_spec ResourcesSpec
    Computing resources of the node such as the amount of memory and number of cores.
    boot_disk_spec DiskSpec
    Specification for the boot disk that will be attached to the node. The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
    For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata.
    metadata map<string,string>
    No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
    v4_address_spec NodeAddressSpec
    Specification for the create network interfaces for the node group compute instances.
    scheduling_policy SchedulingPolicy
    Scheduling policy configuration.

    ResourcesSpec

    Field Description
    memory int64
    Amount of memory available to the node, specified in bytes. Acceptable values are 0 to 274877906944, inclusive.
    cores int64
    Number of cores available to the node. Value must be equal to 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
    core_fraction int64
    Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100.

    DiskSpec

    Field Description
    disk_type_id string
    ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
    disk_size int64
    Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

    NodeAddressSpec

    Field Description
    one_to_one_nat_spec OneToOneNatSpec
    One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

    OneToOneNatSpec

    Field Description
    ip_version enum IpVersion
    IP version for the public IP address.
    • IPV4: IPv4 address, for example 192.168.0.0.
    • IPV6: IPv6 address, not available yet.

      SchedulingPolicy

      Field Description
      preemptible bool
      True for preemptible compute instances. Default value is false. Preemptible compute 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.

      ScalePolicy

      Field Description
      scale_type oneof: fixed_scale or auto_scale
        fixed_scale FixedScale
      Fixed scale policy of the node group.
        auto_scale AutoScale
      Auto scale policy of the node group.

      FixedScale

      Field Description
      size int64
      Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

      AutoScale

      Field Description
      min_size int64
      Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
      max_size int64
      Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
      initial_size int64
      Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

      NodeGroupAllocationPolicy

      Field Description
      locations[] NodeGroupLocation
      List of locations where resources for the node group will be allocated.

      NodeGroupLocation

      Field Description
      zone_id string
      Required. ID of the availability zone where the nodes may reside.
      subnet_id string
      ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

      VersionInfo

      Field Description
      current_version string
      Current kubernetes version, major.minor (e.g. 1.15).
      new_revision_available bool
      Newer revisions may include kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
      new_revision_summary string
      Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
      version_deprecated bool
      The current version is on the deprecation schedule, component (master or node group) should be upgraded.

      NodeGroupMaintenancePolicy

      Field Description
      auto_upgrade bool
      auto_repair bool
      maintenance_window MaintenanceWindow

      MaintenanceWindow

      Field Description
      policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
        anytime AnytimeMaintenanceWindow
        daily_maintenance_window DailyMaintenanceWindow
        weekly_maintenance_window WeeklyMaintenanceWindow

      AnytimeMaintenanceWindow

      DailyMaintenanceWindow

      Field Description
      start_time google.type.TimeOfDay
      Required.
      duration google.protobuf.Duration
      Acceptable values are 1h to 24h, inclusive.

      WeeklyMaintenanceWindow

      Field Description
      days_of_week[] DaysOfWeekMaintenanceWindow
      The number of elements must be in the range 1-7.

      DaysOfWeekMaintenanceWindow

      Field Description
      days[] google.type.DayOfWeek
      The number of elements must be in the range 1-7.
      start_time google.type.TimeOfDay
      Required.
      duration google.protobuf.Duration
      Acceptable values are 1h to 24h, inclusive.

      List

      Retrieves the list of node group in the specified Kubernetes cluster.

      rpc List (ListNodeGroupsRequest) returns (ListNodeGroupsResponse)

      ListNodeGroupsRequest

      Field Description
      folder_id string
      Required. ID of the folder to list node groups in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
      page_size int64
      The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListNodeGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
      page_token string
      Page token. To get the next page of results, set page_token to the ListNodeGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
      filter string
      1. The field name. Currently you can use filtering only on NodeGroup.name field.
      2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
      3. The value. Must be 1-61 characters long and match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
      The maximum string length in characters is 1000.

      ListNodeGroupsResponse

      Field Description
      node_groups[] NodeGroup
      List of node groups.
      next_page_token string
      This token allows you to get the next page of results for list requests. If the number of results is larger than ListNodeGroupsRequest.page_size, use the next_page_token as the value for the ListNodeGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

      NodeGroup

      Field Description
      id string
      ID of the node group.
      cluster_id string
      ID of the cluster that the node group belongs to.
      created_at google.protobuf.Timestamp
      Creation timestamp.
      name string
      Name of the node group. The name is unique within the folder.
      description string
      Description of the node group. 0-256 characters long.
      labels map<string,string>
      Resource labels as key:value pairs. Мaximum of 64 per resource.
      status enum Status
      Status of the node group.
      • PROVISIONING: Node group is waiting for resources to be allocated.
      • RUNNING: Node group is running.
      • RECONCILING: Node group is waiting for some work to be done, such as upgrading node software.
      • STOPPING: Node group is being stopped.
      • STOPPED: Node group stopped.
      • DELETING: Node group is being deleted.
      • STARTING: Node group is being started.
        node_template NodeTemplate
        Node template that specifies parameters of the compute instances for the node group.
        scale_policy ScalePolicy
        Scale policy of the node group. For more information, see Scaling policy.
        allocation_policy NodeGroupAllocationPolicy
        Allocation policy by which resources for node group are allocated to zones and regions.
        instance_group_id string
        ID of the managed instance group associated with this node group.
        node_version string
        Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
        version_info VersionInfo
        maintenance_policy NodeGroupMaintenancePolicy

        NodeTemplate

        Field Description
        platform_id string
        ID of the hardware platform configuration for the node.
        resources_spec ResourcesSpec
        Computing resources of the node such as the amount of memory and number of cores.
        boot_disk_spec DiskSpec
        Specification for the boot disk that will be attached to the node. The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
        For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata.
        metadata map<string,string>
        No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
        v4_address_spec NodeAddressSpec
        Specification for the create network interfaces for the node group compute instances.
        scheduling_policy SchedulingPolicy
        Scheduling policy configuration.

        ResourcesSpec

        Field Description
        memory int64
        Amount of memory available to the node, specified in bytes. Acceptable values are 0 to 274877906944, inclusive.
        cores int64
        Number of cores available to the node. Value must be equal to 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
        core_fraction int64
        Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100.

        DiskSpec

        Field Description
        disk_type_id string
        ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
        disk_size int64
        Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

        NodeAddressSpec

        Field Description
        one_to_one_nat_spec OneToOneNatSpec
        One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

        OneToOneNatSpec

        Field Description
        ip_version enum IpVersion
        IP version for the public IP address.
        • IPV4: IPv4 address, for example 192.168.0.0.
        • IPV6: IPv6 address, not available yet.

          SchedulingPolicy

          Field Description
          preemptible bool
          True for preemptible compute instances. Default value is false. Preemptible compute 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.

          ScalePolicy

          Field Description
          scale_type oneof: fixed_scale or auto_scale
            fixed_scale FixedScale
          Fixed scale policy of the node group.
            auto_scale AutoScale
          Auto scale policy of the node group.

          FixedScale

          Field Description
          size int64
          Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

          AutoScale

          Field Description
          min_size int64
          Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
          max_size int64
          Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
          initial_size int64
          Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

          NodeGroupAllocationPolicy

          Field Description
          locations[] NodeGroupLocation
          List of locations where resources for the node group will be allocated.

          NodeGroupLocation

          Field Description
          zone_id string
          Required. ID of the availability zone where the nodes may reside.
          subnet_id string
          ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

          VersionInfo

          Field Description
          current_version string
          Current kubernetes version, major.minor (e.g. 1.15).
          new_revision_available bool
          Newer revisions may include kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
          new_revision_summary string
          Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
          version_deprecated bool
          The current version is on the deprecation schedule, component (master or node group) should be upgraded.

          NodeGroupMaintenancePolicy

          Field Description
          auto_upgrade bool
          auto_repair bool
          maintenance_window MaintenanceWindow

          MaintenanceWindow

          Field Description
          policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
            anytime AnytimeMaintenanceWindow
            daily_maintenance_window DailyMaintenanceWindow
            weekly_maintenance_window WeeklyMaintenanceWindow

          AnytimeMaintenanceWindow

          DailyMaintenanceWindow

          Field Description
          start_time google.type.TimeOfDay
          Required.
          duration google.protobuf.Duration
          Acceptable values are 1h to 24h, inclusive.

          WeeklyMaintenanceWindow

          Field Description
          days_of_week[] DaysOfWeekMaintenanceWindow
          The number of elements must be in the range 1-7.

          DaysOfWeekMaintenanceWindow

          Field Description
          days[] google.type.DayOfWeek
          The number of elements must be in the range 1-7.
          start_time google.type.TimeOfDay
          Required.
          duration google.protobuf.Duration
          Acceptable values are 1h to 24h, inclusive.

          Create

          Creates a node group in the specified Kubernetes cluster.

          rpc Create (CreateNodeGroupRequest) returns (operation.Operation)

          Metadata and response of Operation:

              Operation.metadata:CreateNodeGroupMetadata

              Operation.response:NodeGroup

          CreateNodeGroupRequest

          Field Description
          cluster_id string
          Required. ID of the Kubernetes cluster to create a node group in. To get the Kubernetes cluster ID, use a ClusterService.List request.
          name string
          Name of the node group. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
          description string
          Description of the node group. The maximum string length in characters is 256.
          labels map<string,string>
          Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
          node_template NodeTemplate
          Required. Node template for creating the node group.
          scale_policy ScalePolicy
          Required. Scale policy of the node group.
          allocation_policy NodeGroupAllocationPolicy
          Allocation policy of the node group by the zones and regions.
          version string
          maintenance_policy NodeGroupMaintenancePolicy
          allowed_unsafe_sysctls[] string

          NodeTemplate

          Field Description
          platform_id string
          ID of the hardware platform configuration for the node.
          resources_spec ResourcesSpec
          Computing resources of the node such as the amount of memory and number of cores.
          boot_disk_spec DiskSpec
          Specification for the boot disk that will be attached to the node. The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
          For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata.
          metadata map<string,string>
          No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
          v4_address_spec NodeAddressSpec
          Specification for the create network interfaces for the node group compute instances.
          scheduling_policy SchedulingPolicy
          Scheduling policy configuration.

          ResourcesSpec

          Field Description
          memory int64
          Amount of memory available to the node, specified in bytes. Acceptable values are 0 to 274877906944, inclusive.
          cores int64
          Number of cores available to the node. Value must be equal to 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
          core_fraction int64
          Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100.

          DiskSpec

          Field Description
          disk_type_id string
          ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
          disk_size int64
          Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

          NodeAddressSpec

          Field Description
          one_to_one_nat_spec OneToOneNatSpec
          One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

          OneToOneNatSpec

          Field Description
          ip_version enum IpVersion
          IP version for the public IP address.
          • IPV4: IPv4 address, for example 192.168.0.0.
          • IPV6: IPv6 address, not available yet.

            SchedulingPolicy

            Field Description
            preemptible bool
            True for preemptible compute instances. Default value is false. Preemptible compute 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.

            ScalePolicy

            Field Description
            scale_type oneof: fixed_scale or auto_scale
              fixed_scale FixedScale
            Fixed scale policy of the node group.
              auto_scale AutoScale
            Auto scale policy of the node group.

            FixedScale

            Field Description
            size int64
            Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

            AutoScale

            Field Description
            min_size int64
            Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
            max_size int64
            Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
            initial_size int64
            Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

            NodeGroupAllocationPolicy

            Field Description
            locations[] NodeGroupLocation
            List of locations where resources for the node group will be allocated.

            NodeGroupLocation

            Field Description
            zone_id string
            Required. ID of the availability zone where the nodes may reside.
            subnet_id string
            ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

            NodeGroupMaintenancePolicy

            Field Description
            auto_upgrade bool
            auto_repair bool
            maintenance_window MaintenanceWindow

            MaintenanceWindow

            Field Description
            policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
              anytime AnytimeMaintenanceWindow
              daily_maintenance_window DailyMaintenanceWindow
              weekly_maintenance_window WeeklyMaintenanceWindow

            AnytimeMaintenanceWindow

            DailyMaintenanceWindow

            Field Description
            start_time google.type.TimeOfDay
            Required.
            duration google.protobuf.Duration
            Acceptable values are 1h to 24h, inclusive.

            WeeklyMaintenanceWindow

            Field Description
            days_of_week[] DaysOfWeekMaintenanceWindow
            The number of elements must be in the range 1-7.

            DaysOfWeekMaintenanceWindow

            Field Description
            days[] google.type.DayOfWeek
            The number of elements must be in the range 1-7.
            start_time google.type.TimeOfDay
            Required.
            duration google.protobuf.Duration
            Acceptable values are 1h to 24h, inclusive.

            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 google.protobuf.Any<CreateNodeGroupMetadata>
            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.
            result oneof: error or 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.
              error google.rpc.Status
            The error result of the operation in case of failure or cancellation.
              response google.protobuf.Any<NodeGroup>
            if operation finished successfully.

            CreateNodeGroupMetadata

            Field Description
            node_group_id string
            ID of the node group that is being created.

            NodeGroup

            Field Description
            id string
            ID of the node group.
            cluster_id string
            ID of the cluster that the node group belongs to.
            created_at google.protobuf.Timestamp
            Creation timestamp.
            name string
            Name of the node group. The name is unique within the folder.
            description string
            Description of the node group. 0-256 characters long.
            labels map<string,string>
            Resource labels as key:value pairs. Мaximum of 64 per resource.
            status enum Status
            Status of the node group.
            • PROVISIONING: Node group is waiting for resources to be allocated.
            • RUNNING: Node group is running.
            • RECONCILING: Node group is waiting for some work to be done, such as upgrading node software.
            • STOPPING: Node group is being stopped.
            • STOPPED: Node group stopped.
            • DELETING: Node group is being deleted.
            • STARTING: Node group is being started.
              node_template NodeTemplate
              Node template that specifies parameters of the compute instances for the node group.
              scale_policy ScalePolicy
              Scale policy of the node group. For more information, see Scaling policy.
              allocation_policy NodeGroupAllocationPolicy
              Allocation policy by which resources for node group are allocated to zones and regions.
              instance_group_id string
              ID of the managed instance group associated with this node group.
              node_version string
              Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
              version_info VersionInfo
              maintenance_policy NodeGroupMaintenancePolicy

              Update

              Updates the specified node group.

              rpc Update (UpdateNodeGroupRequest) returns (operation.Operation)

              Metadata and response of Operation:

                  Operation.metadata:UpdateNodeGroupMetadata

                  Operation.response:NodeGroup

              UpdateNodeGroupRequest

              Field Description
              node_group_id string
              Required. ID of the node group to update. To get the node group ID use a NodeGroupService.List request.
              update_mask google.protobuf.FieldMask
              Field mask that specifies which fields of the node group are going to be updated.
              name string
              Name of the node group. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
              description string
              Description of the node group. The maximum string length in characters is 256.
              labels map<string,string>
              Resource labels as key:value pairs.
              Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
              node_template NodeTemplate
              Node template for the node group. Change may trigger nodes rolling reboot or recreate.
              scale_policy ScalePolicy
              Scale policy of the node group.
              allocation_policy NodeGroupAllocationPolicy
              Allocation policy of the node group by the zones and regions.
              version UpdateVersionSpec
              maintenance_policy NodeGroupMaintenancePolicy
              allowed_unsafe_sysctls[] string

              NodeTemplate

              Field Description
              platform_id string
              ID of the hardware platform configuration for the node.
              resources_spec ResourcesSpec
              Computing resources of the node such as the amount of memory and number of cores.
              boot_disk_spec DiskSpec
              Specification for the boot disk that will be attached to the node. The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
              For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata.
              metadata map<string,string>
              No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
              v4_address_spec NodeAddressSpec
              Specification for the create network interfaces for the node group compute instances.
              scheduling_policy SchedulingPolicy
              Scheduling policy configuration.

              ResourcesSpec

              Field Description
              memory int64
              Amount of memory available to the node, specified in bytes. Acceptable values are 0 to 274877906944, inclusive.
              cores int64
              Number of cores available to the node. Value must be equal to 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
              core_fraction int64
              Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Value must be equal to 0,5,20,50,100.

              DiskSpec

              Field Description
              disk_type_id string
              ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
              disk_size int64
              Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

              NodeAddressSpec

              Field Description
              one_to_one_nat_spec OneToOneNatSpec
              One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

              OneToOneNatSpec

              Field Description
              ip_version enum IpVersion
              IP version for the public IP address.
              • IPV4: IPv4 address, for example 192.168.0.0.
              • IPV6: IPv6 address, not available yet.

                SchedulingPolicy

                Field Description
                preemptible bool
                True for preemptible compute instances. Default value is false. Preemptible compute 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.

                ScalePolicy

                Field Description
                scale_type oneof: fixed_scale or auto_scale
                  fixed_scale FixedScale
                Fixed scale policy of the node group.
                  auto_scale AutoScale
                Auto scale policy of the node group.

                FixedScale

                Field Description
                size int64
                Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                AutoScale

                Field Description
                min_size int64
                Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                max_size int64
                Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                initial_size int64
                Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                NodeGroupAllocationPolicy

                Field Description
                locations[] NodeGroupLocation
                List of locations where resources for the node group will be allocated.

                NodeGroupLocation

                Field Description
                zone_id string
                Required. ID of the availability zone where the nodes may reside.
                subnet_id string
                ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

                UpdateVersionSpec

                Field Description
                specifier oneof: version or latest_revision
                  version string
                Request update to a newer version of kubernetes (1.x -> 1.y).
                  latest_revision bool
                Request update to the latest revision for the current version.

                NodeGroupMaintenancePolicy

                Field Description
                auto_upgrade bool
                auto_repair bool
                maintenance_window MaintenanceWindow

                MaintenanceWindow

                Field Description
                policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                  anytime AnytimeMaintenanceWindow
                  daily_maintenance_window DailyMaintenanceWindow
                  weekly_maintenance_window WeeklyMaintenanceWindow

                AnytimeMaintenanceWindow

                DailyMaintenanceWindow

                Field Description
                start_time google.type.TimeOfDay
                Required.
                duration google.protobuf.Duration
                Acceptable values are 1h to 24h, inclusive.

                WeeklyMaintenanceWindow

                Field Description
                days_of_week[] DaysOfWeekMaintenanceWindow
                The number of elements must be in the range 1-7.

                DaysOfWeekMaintenanceWindow

                Field Description
                days[] google.type.DayOfWeek
                The number of elements must be in the range 1-7.
                start_time google.type.TimeOfDay
                Required.
                duration google.protobuf.Duration
                Acceptable values are 1h to 24h, inclusive.

                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 google.protobuf.Any<UpdateNodeGroupMetadata>
                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.
                result oneof: error or 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.
                  error google.rpc.Status
                The error result of the operation in case of failure or cancellation.
                  response google.protobuf.Any<NodeGroup>
                if operation finished successfully.

                UpdateNodeGroupMetadata

                Field Description
                node_group_id string
                Required. ID of the Node group that is being updated.

                NodeGroup

                Field Description
                id string
                ID of the node group.
                cluster_id string
                ID of the cluster that the node group belongs to.
                created_at google.protobuf.Timestamp
                Creation timestamp.
                name string
                Name of the node group. The name is unique within the folder.
                description string
                Description of the node group. 0-256 characters long.
                labels map<string,string>
                Resource labels as key:value pairs. Мaximum of 64 per resource.
                status enum Status
                Status of the node group.
                • PROVISIONING: Node group is waiting for resources to be allocated.
                • RUNNING: Node group is running.
                • RECONCILING: Node group is waiting for some work to be done, such as upgrading node software.
                • STOPPING: Node group is being stopped.
                • STOPPED: Node group stopped.
                • DELETING: Node group is being deleted.
                • STARTING: Node group is being started.
                  node_template NodeTemplate
                  Node template that specifies parameters of the compute instances for the node group.
                  scale_policy ScalePolicy
                  Scale policy of the node group. For more information, see Scaling policy.
                  allocation_policy NodeGroupAllocationPolicy
                  Allocation policy by which resources for node group are allocated to zones and regions.
                  instance_group_id string
                  ID of the managed instance group associated with this node group.
                  node_version string
                  Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
                  version_info VersionInfo
                  maintenance_policy NodeGroupMaintenancePolicy

                  Delete

                  Deletes the specified node group.

                  rpc Delete (DeleteNodeGroupRequest) returns (operation.Operation)

                  Metadata and response of Operation:

                      Operation.metadata:DeleteNodeGroupMetadata

                      Operation.response:google.protobuf.Empty

                  DeleteNodeGroupRequest

                  Field Description
                  node_group_id string
                  Required. ID of the node group to delete. To get node group ID use a NodeGroupService.List request.

                  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 google.protobuf.Any<DeleteNodeGroupMetadata>
                  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.
                  result oneof: error or 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.
                    error google.rpc.Status
                  The error result of the operation in case of failure or cancellation.
                    response google.protobuf.Any<google.protobuf.Empty>
                  if operation finished successfully.

                  DeleteNodeGroupMetadata

                  Field Description
                  node_group_id string
                  ID of the node group that is being deleted.

                  ListOperations

                  Lists operations for the specified node group.

                  rpc ListOperations (ListNodeGroupOperationsRequest) returns (ListNodeGroupOperationsResponse)

                  ListNodeGroupOperationsRequest

                  Field Description
                  node_group_id string
                  Required. ID of the node group to list operations for.
                  page_size int64
                  The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListNodeGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
                  page_token string
                  Page token. To get the next page of results, set page_token to the ListNodeGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
                  filter string
                  A filter expression that filters resources listed in the response. Currently you can use filtering only on NodeGroup.name field. The maximum string length in characters is 1000.

                  ListNodeGroupOperationsResponse

                  Field Description
                  operations[] operation.Operation
                  List of operations for the specified node group.
                  next_page_token string
                  This token allows you to get the next page of results for list requests. If the number of results is larger than ListNodeGroupOperationsRequest.page_size, use the next_page_token as the value for the ListNodeGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                  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 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.
                  result oneof: error or 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.
                    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.