Class: Google::Cloud::Container::V1::NodePool
- Inherits:
-
Object
- Object
- Google::Cloud::Container::V1::NodePool
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/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 Classes: PlacementPolicy, QueuedProvisioning, UpdateInfo, UpgradeSettings
Instance Attribute Summary collapse
-
#autoscaling ⇒ ::Google::Cloud::Container::V1::NodePoolAutoscaling
Autoscaler configuration for this NodePool.
-
#best_effort_provisioning ⇒ ::Google::Cloud::Container::V1::BestEffortProvisioning
Enable best effort provisioning for nodes.
-
#conditions ⇒ ::Array<::Google::Cloud::Container::V1::StatusCondition>
Which conditions caused the current node pool state.
-
#config ⇒ ::Google::Cloud::Container::V1::NodeConfig
The node configuration of the pool.
-
#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.
-
#initial_node_count ⇒ ::Integer
The initial node count for the pool.
-
#instance_group_urls ⇒ ::Array<::String>
readonly
Output only.
-
#locations ⇒ ::Array<::String>
The list of Google Compute Engine zones in which the NodePool's nodes should be located.
-
#management ⇒ ::Google::Cloud::Container::V1::NodeManagement
NodeManagement configuration for this NodePool.
-
#max_pods_constraint ⇒ ::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 ⇒ ::String
The name of the node pool.
-
#network_config ⇒ ::Google::Cloud::Container::V1::NodeNetworkConfig
Networking configuration for this NodePool.
-
#placement_policy ⇒ ::Google::Cloud::Container::V1::NodePool::PlacementPolicy
Specifies the node placement policy.
-
#pod_ipv4_cidr_size ⇒ ::Integer
readonly
Output only.
-
#queued_provisioning ⇒ ::Google::Cloud::Container::V1::NodePool::QueuedProvisioning
Specifies the configuration of queued provisioning.
-
#self_link ⇒ ::String
readonly
Output only.
-
#status ⇒ ::Google::Cloud::Container::V1::NodePool::Status
readonly
Output only.
-
#status_message ⇒ ::String
readonly
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#update_info ⇒ ::Google::Cloud::Container::V1::NodePool::UpdateInfo
readonly
Output only.
-
#upgrade_settings ⇒ ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
-
#version ⇒ ::String
The version of Kubernetes running on this NodePool's nodes.
Instance Attribute Details
#autoscaling ⇒ ::Google::Cloud::Container::V1::NodePoolAutoscaling
Returns Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#best_effort_provisioning ⇒ ::Google::Cloud::Container::V1::BestEffortProvisioning
Returns Enable best effort provisioning for nodes.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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::Cloud::Container::V1::StatusCondition>
Returns Which conditions caused the current node pool state.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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::Cloud::Container::V1::NodeConfig
Returns The node configuration of the pool.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#etag ⇒ ::String
Returns 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.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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> (readonly)
Returns 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.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#locations ⇒ ::Array<::String>
Returns 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.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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::Cloud::Container::V1::NodeManagement
Returns NodeManagement configuration for this NodePool.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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::Cloud::Container::V1::MaxPodsConstraint
Returns The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#network_config ⇒ ::Google::Cloud::Container::V1::NodeNetworkConfig
Returns Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#placement_policy ⇒ ::Google::Cloud::Container::V1::NodePool::PlacementPolicy
Returns Specifies the node placement policy.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 (readonly)
Returns Output only. The pod CIDR block size per node in this node pool.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#queued_provisioning ⇒ ::Google::Cloud::Container::V1::NodePool::QueuedProvisioning
Returns Specifies the configuration of queued provisioning.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 (readonly)
Returns Output only. Server-defined URL for the resource.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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::Cloud::Container::V1::NodePool::Status (readonly)
Returns Output only. The status of the nodes in this pool instance.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 (readonly)
This field is deprecated and may be removed in the next major version update.
Returns Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#update_info ⇒ ::Google::Cloud::Container::V1::NodePool::UpdateInfo (readonly)
Returns Output only. Update info contains relevant information during a node pool update.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |
#upgrade_settings ⇒ ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Returns Upgrade settings control disruption and speed of the upgrade.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 |
# File 'proto_docs/google/container/v1/cluster_service.rb', line 3448 class NodePool include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. # # maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # # maxSurge controls the number of additional nodes that can be added to the # node pool temporarily for the time of the upgrade to increase the number of # available nodes. # # (maxUnavailable + maxSurge) determines the level of parallelism (how many # nodes are being upgraded at the same time). # # Note: upgrades inevitably introduce some disruption since workloads need to # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, # this holds true. (Disruption stays within the limits of # PodDisruptionBudget, if it is configured.) # # Consider a hypothetical node pool with 5 nodes having maxSurge=2, # maxUnavailable=1. This means the upgrade process upgrades 3 nodes # simultaneously. It creates 2 additional (upgraded) nodes, then it brings # down 3 old (not yet upgraded) nodes at the same time. This ensures that # there are always at least 4 nodes available. # # These upgrade settings configure the upgrade strategy for the node pool. # Use strategy to switch between the strategies applied to the node pool. # # If the strategy is ROLLING, use max_surge and max_unavailable to control # the level of parallelism and the level of disruption caused by upgrade. # 1. maxSurge controls the number of additional nodes that can be added to # the node pool temporarily for the time of the upgrade to increase the # number of available nodes. # 2. maxUnavailable controls the number of nodes that can be simultaneously # unavailable. # 3. (maxUnavailable + maxSurge) determines the level of parallelism (how # many nodes are being upgraded at the same time). # # If the strategy is BLUE_GREEN, use blue_green_settings to configure the # blue-green upgrade related settings. # 1. standard_rollout_policy is the default policy. The policy is used to # control the way blue pool gets drained. The draining is executed in the # batch mode. The batch size could be specified as either percentage of the # node pool size or the number of nodes. batch_soak_duration is the soak # time after each batch gets drained. # 2. node_pool_soak_duration is the soak time after all blue nodes are # drained. After this period, the blue pool nodes will be deleted. # @!attribute [rw] max_surge # @return [::Integer] # The maximum number of nodes that can be created beyond the current size # of the node pool during the upgrade process. # @!attribute [rw] max_unavailable # @return [::Integer] # The maximum number of nodes that can be simultaneously unavailable during # the upgrade process. A node is considered available if its status is # Ready. # @!attribute [rw] strategy # @return [::Google::Cloud::Container::V1::NodePoolUpdateStrategy] # Update strategy of the node pool. # @!attribute [rw] blue_green_settings # @return [::Google::Cloud::Container::V1::BlueGreenSettings] # Settings for blue-green upgrade strategy. class UpgradeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # UpdateInfo contains resource (instance groups, etc), status and other # intermediate information relevant to a node pool upgrade. # @!attribute [rw] blue_green_info # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo] # Information of a blue-green upgrade. class UpdateInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information relevant to blue-green upgrade. # @!attribute [rw] phase # @return [::Google::Cloud::Container::V1::NodePool::UpdateInfo::BlueGreenInfo::Phase] # Current blue-green upgrade phase. # @!attribute [rw] blue_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with blue pool. # @!attribute [rw] green_instance_group_urls # @return [::Array<::String>] # The resource URLs of the [managed instance groups] # (/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with green pool. # @!attribute [rw] blue_pool_deletion_start_time # @return [::String] # Time to start deleting blue pool to complete blue-green upgrade, # in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # @!attribute [rw] green_pool_version # @return [::String] # Version of green pool. class BlueGreenInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Phase represents the different stages blue-green upgrade is running in. module Phase # Unspecified phase. PHASE_UNSPECIFIED = 0 # blue-green upgrade has been initiated. UPDATE_STARTED = 1 # Start creating green pool nodes. CREATING_GREEN_POOL = 2 # Start cordoning blue pool nodes. CORDONING_BLUE_POOL = 3 # Start draining blue pool nodes. DRAINING_BLUE_POOL = 4 # Start soaking time after draining entire blue pool. NODE_POOL_SOAKING = 5 # Start deleting blue nodes. DELETING_BLUE_POOL = 6 # Rollback has been initiated. ROLLBACK_STARTED = 7 end end end # PlacementPolicy defines the placement policy used by the node pool. # @!attribute [rw] type # @return [::Google::Cloud::Container::V1::NodePool::PlacementPolicy::Type] # The type of placement. # @!attribute [rw] tpu_topology # @return [::String] # Optional. TPU placement topology for pod slice node pool. # https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies # @!attribute [rw] policy_name # @return [::String] # If set, refers to the name of a custom resource policy supplied by the # user. The resource policy must be in the same project and region as the # node pool. If not found, InvalidArgument error is returned. class PlacementPolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Type defines the type of placement policy. module Type # TYPE_UNSPECIFIED specifies no requirements on nodes # placement. TYPE_UNSPECIFIED = 0 # COMPACT specifies node placement in the same availability domain to # ensure low communication latency. COMPACT = 1 end end # QueuedProvisioning defines the queued provisioning used by the node pool. # @!attribute [rw] enabled # @return [::Boolean] # Denotes that this nodepool is QRM specific, meaning nodes can be only # obtained through queuing via the Cluster Autoscaler ProvisioningRequest # API. class QueuedProvisioning include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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 |