Managed Services for Kubernetes API, gRPC: ClusterService.ListNodeGroups

Field

Description

cluster_id

string

Required field. ID of the Kubernetes cluster to list node groups in.
To get the Kubernetes cluster ID use a ClusterService.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 ListClusterNodeGroupsResponse.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
ListClusterNodeGroupsResponse.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 Cluster.name field.

The maximum string length in characters is 1000.

Field

Description

node_groups[]

NodeGroup

List of node groups for the specified Kubernetes cluster.

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 ListClusterNodeGroupsRequest.page_size, use
the next_page_token as the value
for the ListClusterNodeGroupsRequest.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.

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

object (map<string, string>)

Resource labels as key:value pairs. Maximum 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.

deploy_policy

DeployPolicy

Deploy policy according to which the updates are rolled out.

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

Detailed information about the Kubernetes version that is running on the node.

maintenance_policy

NodeGroupMaintenancePolicy

Maintenance policy of the node group.

allowed_unsafe_sysctls[]

string

Support for unsafe sysctl parameters. For more details see documentation.

node_taints[]

Taint

Taints that are applied to the nodes of the node group at creation time.

node_labels

object (map<string, string>)

Labels that are assigned to the nodes of the node group at creation time.

Field

Description

name

string

Name of the instance.
In order to be unique it must contain at least on of instance unique placeholders:
{instance.short_id}
{instance.index}
combination of {instance.zone_id} and {instance.index_in_zone}
Example: my-instance-{instance.index}
If not set, default is used: {instance_group.id}-{instance.short_id}
It may also contain another placeholders, see metadata doc for full list.

The maximum string length in characters is 128.

labels

object (map<string, string>)

these labels will be assigned to compute nodes (instances), created by the nodegroup

No more than 32 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*.

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.

metadata

object (map<string, string>)

The metadata as key:value pairs assigned to this instance template. Only SSH keys are supported as metadata.

For more information, see Connecting to a node over SSH.

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.
Deprecated, please use network_interface_specs.

scheduling_policy

SchedulingPolicy

Scheduling policy configuration.

network_interface_specs[]

NetworkInterfaceSpec

New api, to specify network interfaces for the node group compute instances.
Can not be used together with 'v4_address_spec'

placement_policy

PlacementPolicy

Placement policy configuration that controls physical placement of node group instances
in the cloud infrastructure for optimizing performance and reliability.

network_settings

NetworkSettings

this parameter allows to specify type of network acceleration used on nodes (instances)

container_runtime_settings

ContainerRuntimeSettings

Container runtime settings for the node template.

container_network_settings

ContainerNetworkSettings

Container network settings for the node template.

gpu_settings

GpuSettings

GPU settings

Field

Description

memory

int64

Amount of memory available to the node, specified in bytes.

The minimum value is 0.

cores

int64

Number of cores available to the node.

The minimum value is 0.

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.

Acceptable values are 0 to 100, inclusive.

gpus

int64

Number of GPUs available to the node.

The minimum value is 0.

Field

Description

disk_type_id

string

ID of the disk type.

Value must match the regular expression \|network-ssd\|network-hdd\|network-ssd-nonreplicated\|network-ssd-io-m3.

disk_size

int64

Size of the disk, specified in bytes.

Acceptable values are 0 to 4398046511104, inclusive.

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.

dns_record_specs[]

DnsRecordSpec

Internal DNS configuration.

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.

Field

Description

fqdn

string

Required field. FQDN (required).

dns_zone_id

string

DNS zone id (optional, if not set, private zone is used).

ttl

int64

DNS record ttl, values in 0-86400 (optional).

Acceptable values are 0 to 86400, inclusive.

ptr

bool

When set to true, also create PTR DNS record (optional).

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.

Field

Description

subnet_ids[]

string

IDs of the subnets.

primary_v4_address_spec

NodeAddressSpec

Primary IPv4 address that is assigned to the instance for this network interface.

primary_v6_address_spec

NodeAddressSpec

Primary IPv6 address that is assigned to the instance for this network interface.

security_group_ids[]

string

IDs of security groups.

Field

Description

placement_group_id

string

Identifier of placement group

Field

Description

type

enum Type

Required field. Network type that specifies the network configuration for the node group instances.

• STANDARD: Standard network.
• SOFTWARE_ACCELERATED: Software accelerated network.

Field

Description

type

enum Type

Required field. Type of container runtime.

• DOCKER: Docker container runtime.
• CONTAINERD: Containerd container runtime.

Field

Description

pod_mtu

int64

MTU (Maximum Transmission Unit) size for pod network interfaces.

Field

Description

gpu_cluster_id

string

GPU cluster id, that mk8s node will join.

gpu_environment

enum GpuEnvironment

GPU environment configured on node.

• RUNC_DRIVERS_CUDA: Use a node image with the pre-installed GPU toolkit, drivers and CUDA.
• RUNC: Use a node image with the pre-installed GPU toolkit but without drivers.
  You should install drivers on a node yourself in that case.
  There are tools to help you to do that, for example gpu-operator.

Field

Description

fixed_scale

FixedScale

Fixed scale policy of the node group.

Includes only one of the fields fixed_scale, auto_scale.

auto_scale

AutoScale

Auto scale policy of the node group.

Includes only one of the fields fixed_scale, auto_scale.

Field

Description

size

int64

Number of nodes in the node group.

Acceptable values are 0 to 100, inclusive.

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.

Field

Description

locations[]

NodeGroupLocation

List of locations where resources for the node group will be allocated.

Field

Description

zone_id

string

Required field. 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.

Field

Description

max_unavailable

int64

The maximum number of running instances that can be taken offline (i.e.,
stopped or deleted) at the same time during the update process.
If max_expansion is not specified or set to zero, max_unavailable must
be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

max_expansion

int64

The maximum number of instances that can be temporarily allocated above
the group's target size during the update process.
If max_unavailable is not specified or set to zero, max_expansion must
be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

Field

Description

current_version

string

Current Kubernetes version, format: 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 platform specific
components either on the master or nodes.

new_revision_summary

string

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.

Field

Description

auto_upgrade

bool

If set to true, automatic updates are installed in the specified period of time with no interaction from the user.
If set to false, automatic upgrades are disabled.

auto_repair

bool

If set to true, automatic repairs are enabled. Default value is false.

maintenance_window

MaintenanceWindow

Maintenance window settings. Update will start at the specified time and last no more than the specified duration.
The time is set in UTC.

Field

Description

anytime

AnytimeMaintenanceWindow

Updating the master at any time.

Includes only one of the fields anytime, daily_maintenance_window, weekly_maintenance_window.

Maintenance policy.

daily_maintenance_window

DailyMaintenanceWindow

Updating the master on any day during the specified time window.

Includes only one of the fields anytime, daily_maintenance_window, weekly_maintenance_window.

Maintenance policy.

weekly_maintenance_window

WeeklyMaintenanceWindow

Updating the master on selected days during the specified time window.

Includes only one of the fields anytime, daily_maintenance_window, weekly_maintenance_window.

Maintenance policy.

Field

Description

Empty

Field

Description

start_time

google.type.TimeOfDay

Required field. Window start time, in the UTC timezone.

duration

google.protobuf.Duration

Window duration.

Field

Description

days_of_week[]

DaysOfWeekMaintenanceWindow

Days of the week and the maintenance window for these days when automatic updates are allowed.

The number of elements must be in the range 1-7.

Field

Description

days[]

enum DayOfWeek

Days of the week when automatic updates are allowed.

The number of elements must be in the range 1-7.

• MONDAY: The day-of-week of Monday.
• TUESDAY: The day-of-week of Tuesday.
• WEDNESDAY: The day-of-week of Wednesday.
• THURSDAY: The day-of-week of Thursday.
• FRIDAY: The day-of-week of Friday.
• SATURDAY: The day-of-week of Saturday.
• SUNDAY: The day-of-week of Sunday.

start_time

google.type.TimeOfDay

Required field. Window start time, in the UTC timezone.

duration

google.protobuf.Duration

Window duration.

Field

Description

key

string

The taint key to be applied to a node.

value

string

The taint value corresponding to the taint key.

effect

enum Effect

The effect of the taint on pods that do not tolerate the taint.

• NO_SCHEDULE: Do not allow new pods to schedule onto the node unless they tolerate the taint,
  but allow all pods submitted to Kubelet without going through the scheduler
  to start, and allow all already-running pods to continue running.
• PREFER_NO_SCHEDULE: Like NO_SCHEDULE, but the scheduler tries not to schedule
  new pods onto the node, rather than prohibiting new pods from scheduling
  onto the node entirely. Enforced by the scheduler.
• NO_EXECUTE: Evict any already-running pods that do not tolerate the taint.