Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#autoscaling
def autoscaling() -> ::Google::Cloud::Container::V1::NodePoolAutoscaling
Returns
- (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
#autoscaling=
def autoscaling=(value) -> ::Google::Cloud::Container::V1::NodePoolAutoscaling
Parameter
- value (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
Returns
- (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
#best_effort_provisioning
def best_effort_provisioning() -> ::Google::Cloud::Container::V1::BestEffortProvisioning
Returns
- (::Google::Cloud::Container::V1::BestEffortProvisioning) — Enable best effort provisioning for nodes
#best_effort_provisioning=
def best_effort_provisioning=(value) -> ::Google::Cloud::Container::V1::BestEffortProvisioning
Parameter
- value (::Google::Cloud::Container::V1::BestEffortProvisioning) — Enable best effort provisioning for nodes
Returns
- (::Google::Cloud::Container::V1::BestEffortProvisioning) — Enable best effort provisioning for nodes
#conditions
def conditions() -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
Returns
- (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current node pool state.
#conditions=
def conditions=(value) -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
Parameter
- value (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current node pool state.
Returns
- (::Array<::Google::Cloud::Container::V1::StatusCondition>) — Which conditions caused the current node pool state.
#config
def config() -> ::Google::Cloud::Container::V1::NodeConfig
Returns
- (::Google::Cloud::Container::V1::NodeConfig) — The node configuration of the pool.
#config=
def config=(value) -> ::Google::Cloud::Container::V1::NodeConfig
Parameter
- value (::Google::Cloud::Container::V1::NodeConfig) — The node configuration of the pool.
Returns
- (::Google::Cloud::Container::V1::NodeConfig) — The node configuration of the pool.
#etag
def etag() -> ::String
Returns
- (::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.
#etag=
def etag=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#initial_node_count
def initial_node_count() -> ::Integer
Returns
- (::Integer) — 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.
#initial_node_count=
def initial_node_count=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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.
#instance_group_urls
def instance_group_urls() -> ::Array<::String>
Returns
- (::Array<::String>) — [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.
#instance_group_urls=
def instance_group_urls=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — [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.
Returns
- (::Array<::String>) — [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.
#locations
def locations() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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.
#locations=
def locations=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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.
Returns
-
(::Array<::String>) — 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.
#management
def management() -> ::Google::Cloud::Container::V1::NodeManagement
Returns
- (::Google::Cloud::Container::V1::NodeManagement) — NodeManagement configuration for this NodePool.
#management=
def management=(value) -> ::Google::Cloud::Container::V1::NodeManagement
Parameter
- value (::Google::Cloud::Container::V1::NodeManagement) — NodeManagement configuration for this NodePool.
Returns
- (::Google::Cloud::Container::V1::NodeManagement) — NodeManagement configuration for this NodePool.
#max_pods_constraint
def max_pods_constraint() -> ::Google::Cloud::Container::V1::MaxPodsConstraint
Returns
- (::Google::Cloud::Container::V1::MaxPodsConstraint) — The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
#max_pods_constraint=
def max_pods_constraint=(value) -> ::Google::Cloud::Container::V1::MaxPodsConstraint
Parameter
- value (::Google::Cloud::Container::V1::MaxPodsConstraint) — The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
Returns
- (::Google::Cloud::Container::V1::MaxPodsConstraint) — The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
#name
def name() -> ::String
Returns
- (::String) — The name of the node pool.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — The name of the node pool.
Returns
- (::String) — The name of the node pool.
#network_config
def network_config() -> ::Google::Cloud::Container::V1::NodeNetworkConfig
Returns
- (::Google::Cloud::Container::V1::NodeNetworkConfig) — Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
#network_config=
def network_config=(value) -> ::Google::Cloud::Container::V1::NodeNetworkConfig
Parameter
- value (::Google::Cloud::Container::V1::NodeNetworkConfig) — Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
Returns
- (::Google::Cloud::Container::V1::NodeNetworkConfig) — Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
#placement_policy
def placement_policy() -> ::Google::Cloud::Container::V1::NodePool::PlacementPolicy
Returns
- (::Google::Cloud::Container::V1::NodePool::PlacementPolicy) — Specifies the node placement policy.
#placement_policy=
def placement_policy=(value) -> ::Google::Cloud::Container::V1::NodePool::PlacementPolicy
Parameter
- value (::Google::Cloud::Container::V1::NodePool::PlacementPolicy) — Specifies the node placement policy.
Returns
- (::Google::Cloud::Container::V1::NodePool::PlacementPolicy) — Specifies the node placement policy.
#pod_ipv4_cidr_size
def pod_ipv4_cidr_size() -> ::Integer
Returns
- (::Integer) — [Output only] The pod CIDR block size per node in this node pool.
#pod_ipv4_cidr_size=
def pod_ipv4_cidr_size=(value) -> ::Integer
Parameter
- value (::Integer) — [Output only] The pod CIDR block size per node in this node pool.
Returns
- (::Integer) — [Output only] The pod CIDR block size per node in this node pool.
#self_link
def self_link() -> ::String
Returns
- (::String) — [Output only] Server-defined URL for the resource.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — [Output only] Server-defined URL for the resource.
Returns
- (::String) — [Output only] Server-defined URL for the resource.
#status
def status() -> ::Google::Cloud::Container::V1::NodePool::Status
Returns
- (::Google::Cloud::Container::V1::NodePool::Status) — [Output only] The status of the nodes in this pool instance.
#status=
def status=(value) -> ::Google::Cloud::Container::V1::NodePool::Status
Parameter
- value (::Google::Cloud::Container::V1::NodePool::Status) — [Output only] The status of the nodes in this pool instance.
Returns
- (::Google::Cloud::Container::V1::NodePool::Status) — [Output only] The status of the nodes in this pool instance.
#status_message
def status_message() -> ::String
Returns
- (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
#status_message=
def status_message=(value) -> ::String
Parameter
- value (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
Returns
- (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
#update_info
def update_info() -> ::Google::Cloud::Container::V1::NodePool::UpdateInfo
Returns
- (::Google::Cloud::Container::V1::NodePool::UpdateInfo) — Output only. [Output only] Update info contains relevant information during a node pool update.
#upgrade_settings
def upgrade_settings() -> ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Returns
- (::Google::Cloud::Container::V1::NodePool::UpgradeSettings) — Upgrade settings control disruption and speed of the upgrade.
#upgrade_settings=
def upgrade_settings=(value) -> ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Parameter
- value (::Google::Cloud::Container::V1::NodePool::UpgradeSettings) — Upgrade settings control disruption and speed of the upgrade.
Returns
- (::Google::Cloud::Container::V1::NodePool::UpgradeSettings) — Upgrade settings control disruption and speed of the upgrade.
#version
def version() -> ::String
Returns
- (::String) — The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
#version=
def version=(value) -> ::String
Parameter
- value (::String) — The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
Returns
- (::String) — The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.