REST Resource: nodeGroups

Resource: NodeGroup

Represents a sole-tenant Node Group resource.

A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "nodeTemplate": string,
  "zone": string,
  "selfLink": string,
  "status": enum (Status),
  "size": integer,
  "autoscalingPolicy": {
    object (AutoscalingPolicy)
  },
  "maintenancePolicy": enum (MaintenancePolicy),
  "locationHint": string,
  "fingerprint": string,
  "maintenanceWindow": {
    object (MaintenanceWindow)
  },
  "shareSettings": {
    object (ShareSettings)
  },
  "maintenanceInterval": enum (MaintenanceInterval)
}
Fields
kind

string

[Output Only] The type of the resource. Always

compute#nodeGroup

for node group.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

An optional description of this resource. Provide this property when you create the resource.
nodeTemplate

string

URL of the node template to create the node group from.
zone

string

[Output Only] The name of the zone where the node group resides, such as us-central1-a.
status

enum (Status)
size

integer

[Output Only] The total number of nodes in the node group.
autoscalingPolicy

object (AutoscalingPolicy)

Specifies how autoscaling should behave.
maintenancePolicy

enum (MaintenancePolicy)

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of:

DEFAULT

,

RESTART_IN_PLACE

, or

MIGRATE_WITHIN_NODE_GROUP

. The default value is

DEFAULT

. For more information, see Maintenance policies.
locationHint

string

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any locationHint present in the NodeTemplate.
fingerprint

string (bytes format)

A base64-encoded string.
maintenanceWindow

object (MaintenanceWindow)
shareSettings

object (ShareSettings)

Share-settings for the node group
maintenanceInterval

enum (MaintenanceInterval)

Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT.

Status

Enums
INVALID
CREATING
READY
DELETING

AutoscalingPolicy

JSON representation 
{
  "mode": enum (Mode),
  "minNodes": integer,
  "maxNodes": integer
}
Fields
mode

enum (Mode)

The autoscaling mode. Set to one of:

ON

,

OFF

, or

ONLY_SCALE_OUT

. For more information, see Autoscaler modes.
minNodes

integer

The minimum number of nodes that the group should have.
maxNodes

integer

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

Mode

Enums
MODE_UNSPECIFIED
ON Autocaling is fully enabled.
OFF Autoscaling is disabled.
ONLY_SCALE_OUT Autoscaling will only scale out and will not remove nodes.

MaintenancePolicy

Enums
MAINTENANCE_POLICY_UNSPECIFIED
DEFAULT Allow the node and corresponding instances to retain default maintenance behavior.
MIGRATE_WITHIN_NODE_GROUP When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
RESTART_IN_PLACE Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.

MaintenanceWindow

Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

JSON representation 
{
  "startTime": string,
  "maintenanceDuration": {
    object (Duration)
  }
}
Fields
startTime

string

Start time of the window. This must be in UTC format that resolves to one of

00:00

,

04:00

,

08:00

,

12:00

,

16:00

, or

20:00

. For example, both

13:00-5

and

08:00

are valid.
maintenanceDuration

object (Duration)

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

MaintenanceInterval

Allows selecting how infrastructure upgrades should be applied to this VM.

AS_NEEDED

pushes updates as soon as they become available while

PERIODIC

and

RECURRENT

attempts to follow a less frequent, fixed schedule.

RECURRENT

is used for GEN3 and Slice of Hardware VMs.

Enums
AS_NEEDED

VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the

PERIODIC

and

RECURRENT

options.
RECURRENT

VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for

AS_NEEDED

. Security updates will still be applied as soon as they are available.

RECURRENT

is used for GEN3 and Slice of Hardware VMs.

Methods

addNodes

 The method compute.v1.NodeGroupsService.AddNodes is not available in this (s3nsapis.fr) universe.

aggregatedList

 The method compute.v1.NodeGroupsService.AggregatedList is not available in this (s3nsapis.fr) universe.

delete

 The method compute.v1.NodeGroupsService.Delete is not available in this (s3nsapis.fr) universe.

deleteNodes

 The method compute.v1.NodeGroupsService.DeleteNodes is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.NodeGroupsService.Get is not available in this (s3nsapis.fr) universe.

getIamPolicy

 The method compute.v1.NodeGroupsService.GetPolicy is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.NodeGroupsService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.NodeGroupsService.List is not available in this (s3nsapis.fr) universe.

listNodes

 The method compute.v1.NodeGroupsService.ListNodes is not available in this (s3nsapis.fr) universe.

patch

 The method compute.v1.NodeGroupsService.Patch is not available in this (s3nsapis.fr) universe.

performMaintenance

 The method compute.v1.NodeGroupsService.PerformMaintenance is not available in this (s3nsapis.fr) universe.

setIamPolicy

 The method compute.v1.NodeGroupsService.SetPolicy is not available in this (s3nsapis.fr) universe.

setNodeTemplate

 The method compute.v1.NodeGroupsService.SetNodeTemplate is not available in this (s3nsapis.fr) universe.

simulateMaintenanceEvent

 The method compute.v1.NodeGroupsService.SimulateMaintenanceEvent is not available in this (s3nsapis.fr) universe.

testIamPermissions

 The method compute.v1.NodeGroupsService.TestPermissions is not available in this (s3nsapis.fr) universe.