Class: Google::Container::V1::NodePool

Inherits:

Object

Object
Google::Container::V1::NodePool

Defined in:: lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb

Overview

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.

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

#autoscaling ⇒ Google::Container::V1::NodePoolAutoscaling
Autoscaler configuration for this NodePool.
#conditions ⇒ Array<Google::Container::V1::StatusCondition>
Which conditions caused the current node pool state.
#config ⇒ Google::Container::V1::NodeConfig
The node configuration of the pool.
#initial_node_count ⇒ Integer
The initial node count for the pool.
#instance_group_urls ⇒ Array<String>
[Output only] The resource URLs of the managed instance groups associated with this node pool.
#management ⇒ Google::Container::V1::NodeManagement
NodeManagement configuration for this NodePool.
#max_pods_constraint ⇒ Google::Container::V1::MaxPodsConstraint
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
#name ⇒ String
The name of the node pool.
#pod_ipv4_cidr_size ⇒ Integer
[Output only] The pod CIDR block size per node in this node pool.
#self_link ⇒ String
[Output only] Server-defined URL for the resource.
#status ⇒ Google::Container::V1::NodePool::Status
[Output only] The status of the nodes in this pool instance.
#status_message ⇒ String
[Output only] Additional information about the current status of this node pool instance, if available.
#version ⇒ String
The version of the Kubernetes of this node.

Instance Attribute Details

#autoscaling ⇒ `Google::Container::V1::NodePoolAutoscaling`

Returns Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

Returns:

(Google::Container::V1::NodePoolAutoscaling) —
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#conditions ⇒ `Array<Google::Container::V1::StatusCondition>`

Returns Which conditions caused the current node pool state.

Returns:

(Array<Google::Container::V1::StatusCondition>) —
Which conditions caused the current node pool state.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#config ⇒ `Google::Container::V1::NodeConfig`

Returns The node configuration of the pool.

Returns:

(Google::Container::V1::NodeConfig) —
The node configuration of the pool.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#initial_node_count ⇒ `Integer`

Returns 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.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#instance_group_urls ⇒ `Array<String>`

Returns [Output only] The resource URLs of the managed instance groups associated with this node pool.

Returns:

(Array<String>) —
[Output only] The resource URLs of the managed instance groups associated with this node pool.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#management ⇒ `Google::Container::V1::NodeManagement`

Returns NodeManagement configuration for this NodePool.

Returns:

(Google::Container::V1::NodeManagement) —
NodeManagement configuration for this NodePool.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#max_pods_constraint ⇒ `Google::Container::V1::MaxPodsConstraint`

Returns The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Returns:

(Google::Container::V1::MaxPodsConstraint) —
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#name ⇒ `String`

Returns The name of the node pool.

Returns:

(String) —
The name of the node pool.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#pod_ipv4_cidr_size ⇒ `Integer`

Returns [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.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#self_link ⇒ `String`

Returns [Output only] Server-defined URL for the resource.

Returns:

(String) —
[Output only] Server-defined URL for the resource.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#status ⇒ `Google::Container::V1::NodePool::Status`

Returns [Output only] The status of the nodes in this pool instance.

Returns:

(Google::Container::V1::NodePool::Status) —
[Output only] The status of the nodes in this pool instance.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#status_message ⇒ `String`

Returns [Output only] Additional information about the current status of this node pool instance, if available.

Returns:

(String) —
[Output only] Additional information about the current status of this node pool instance, if available.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

#version ⇒ `String`

Returns The version of the Kubernetes of this node.

Returns:

(String) —
The version of the Kubernetes of this node.

# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1658

class NodePool
  # The current status of the node pool instance.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the node pool is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the node pool has been created
    # and is fully usable.
    RUNNING = 2

    # The RUNNING_WITH_ERROR state indicates the node pool has been created
    # and is partially usable. Some error state has occurred and some
    # functionality may be impaired. Customer may need to reissue a request
    # or trigger a new update.
    RUNNING_WITH_ERROR = 3

    # The RECONCILING state indicates that some work is actively being done on
    # the node pool, such as upgrading node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 4

    # The STOPPING state indicates the node pool is being deleted.
    STOPPING = 5

    # The ERROR state indicates the node pool may be unusable. Details
    # can be found in the `statusMessage` field.
    ERROR = 6
  end
end

Class: Google::Container::V1::NodePool

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#autoscaling ⇒ Google::Container::V1::NodePoolAutoscaling

#conditions ⇒ Array<Google::Container::V1::StatusCondition>

#config ⇒ Google::Container::V1::NodeConfig

#initial_node_count ⇒ Integer

#instance_group_urls ⇒ Array<String>

#management ⇒ Google::Container::V1::NodeManagement

#max_pods_constraint ⇒ Google::Container::V1::MaxPodsConstraint

#name ⇒ String

#pod_ipv4_cidr_size ⇒ Integer

#self_link ⇒ String

#status ⇒ Google::Container::V1::NodePool::Status

#status_message ⇒ String

#version ⇒ String

#autoscaling ⇒ `Google::Container::V1::NodePoolAutoscaling`

#conditions ⇒ `Array<Google::Container::V1::StatusCondition>`

#config ⇒ `Google::Container::V1::NodeConfig`

#initial_node_count ⇒ `Integer`

#instance_group_urls ⇒ `Array<String>`

#management ⇒ `Google::Container::V1::NodeManagement`

#max_pods_constraint ⇒ `Google::Container::V1::MaxPodsConstraint`

#name ⇒ `String`

#pod_ipv4_cidr_size ⇒ `Integer`

#self_link ⇒ `String`

#status ⇒ `Google::Container::V1::NodePool::Status`

#status_message ⇒ `String`

#version ⇒ `String`