Reference documentation and code samples for the Google Cloud Container V1 Client class NodePool.
NodePool contains the name and configuration for a cluster's node pool.
Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
Generated from protobuf message google.container.v1.NodePool
Namespace
Google \ Cloud \ Container \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of the node pool.
↳ config
↳ initial_node_count
int
The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
↳ locations
array
The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
↳ network_config
NodeNetworkConfig
Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
↳ self_link
string
Output only. Server-defined URL for the resource.
↳ version
string
The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here .
↳ instance_group_urls
array
Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
↳ status
int
Output only. The status of the nodes in this pool instance.
↳ status_message
string
Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
↳ autoscaling
NodePoolAutoscaling
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
↳ management
↳ max_pods_constraint
MaxPodsConstraint
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
↳ conditions
↳ pod_ipv4_cidr_size
int
Output only. The pod CIDR block size per node in this node pool.
↳ upgrade_settings
↳ placement_policy
↳ update_info
NodePool\UpdateInfo
Output only. Update info contains relevant information during a node pool update.
↳ etag
string
This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
↳ queued_provisioning
↳ best_effort_provisioning
getName
The name of the node pool.
string
setName
The name of the node pool.
var
string
$this
getConfig
The node configuration of the pool.
hasConfig
clearConfig
setConfig
The node configuration of the pool.
$this
getInitialNodeCount
The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
int
setInitialNodeCount
The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
var
int
$this
getLocations
The list of Google Compute Engine zones in which the NodePool's nodes should be located.
If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
setLocations
The list of Google Compute Engine zones in which the NodePool's nodes should be located.
If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
var
string[]
$this
getNetworkConfig
Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
$this
getSelfLink
Output only. Server-defined URL for the resource.
string
setSelfLink
Output only. Server-defined URL for the resource.
var
string
$this
getVersion
The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here .
string
setVersion
The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here .
var
string
$this
getInstanceGroupUrls
Output only. The resource URLs of the managed instance groups associated with this node pool.
During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
setInstanceGroupUrls
Output only. The resource URLs of the managed instance groups associated with this node pool.
During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
var
string[]
$this
getStatus
Output only. The status of the nodes in this pool instance.
int
setStatus
Output only. The status of the nodes in this pool instance.
var
int
$this
getStatusMessage
Output only. Deprecated. Use conditions instead.
Additional information about the current status of this node pool instance, if available.
string
setStatusMessage
Output only. Deprecated. Use conditions instead.
Additional information about the current status of this node pool instance, if available.
var
string
$this
getAutoscaling
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
hasAutoscaling
clearAutoscaling
setAutoscaling
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
$this
getManagement
NodeManagement configuration for this NodePool.
hasManagement
clearManagement
setManagement
NodeManagement configuration for this NodePool.
$this
getMaxPodsConstraint
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
hasMaxPodsConstraint
clearMaxPodsConstraint
setMaxPodsConstraint
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
$this
getConditions
Which conditions caused the current node pool state.
setConditions
Which conditions caused the current node pool state.
$this
getPodIpv4CidrSize
Output only. The pod CIDR block size per node in this node pool.
int
setPodIpv4CidrSize
Output only. The pod CIDR block size per node in this node pool.
var
int
$this
getUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
hasUpgradeSettings
clearUpgradeSettings
setUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
$this
getPlacementPolicy
Specifies the node placement policy.
hasPlacementPolicy
clearPlacementPolicy
setPlacementPolicy
Specifies the node placement policy.
$this
getUpdateInfo
Output only. Update info contains relevant information during a node pool update.
hasUpdateInfo
clearUpdateInfo
setUpdateInfo
Output only. Update info contains relevant information during a node pool update.
$this
getEtag
This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
string
setEtag
This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
var
string
$this
getQueuedProvisioning
Specifies the configuration of queued provisioning.
hasQueuedProvisioning
clearQueuedProvisioning
setQueuedProvisioning
Specifies the configuration of queued provisioning.
$this
getBestEffortProvisioning
Enable best effort provisioning for nodes
hasBestEffortProvisioning
clearBestEffortProvisioning
setBestEffortProvisioning
Enable best effort provisioning for nodes
$this
