Class: Google::Apis::ContainerV1beta1::UpdateNodePoolRequest
- Inherits:
-
Object
- Object
- Google::Apis::ContainerV1beta1::UpdateNodePoolRequest
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/container_v1beta1/classes.rb,
lib/google/apis/container_v1beta1/representations.rb,
lib/google/apis/container_v1beta1/representations.rb
Overview
SetNodePoolVersionRequest updates the version of a node pool.
Instance Attribute Summary collapse
-
#accelerators ⇒ Array<Google::Apis::ContainerV1beta1::AcceleratorConfig>
A list of hardware accelerators to be attached to each node.
-
#cluster_id ⇒ String
Required.
-
#confidential_nodes ⇒ Google::Apis::ContainerV1beta1::ConfidentialNodes
ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.
-
#containerd_config ⇒ Google::Apis::ContainerV1beta1::ContainerdConfig
ContainerdConfig contains configuration to customize containerd.
-
#disk_size_gb ⇒ Fixnum
Optional.
-
#disk_type ⇒ String
Optional.
-
#etag ⇒ String
The current etag of the node pool.
-
#fast_socket ⇒ Google::Apis::ContainerV1beta1::FastSocket
Configuration of Fast Socket feature.
-
#gcfs_config ⇒ Google::Apis::ContainerV1beta1::GcfsConfig
GcfsConfig contains configurations of Google Container File System.
-
#gvnic ⇒ Google::Apis::ContainerV1beta1::VirtualNic
Configuration of gVNIC feature.
-
#image_type ⇒ String
Required.
-
#kubelet_config ⇒ Google::Apis::ContainerV1beta1::NodeKubeletConfig
Node kubelet configs.
-
#labels ⇒ Google::Apis::ContainerV1beta1::NodeLabels
Collection of node-level Kubernetes labels.
-
#linux_node_config ⇒ Google::Apis::ContainerV1beta1::LinuxNodeConfig
Parameters that can be configured on Linux nodes.
-
#locations ⇒ Array<String>
The desired list of Google Compute Engine zones in which the node pool's nodes should be located.
-
#logging_config ⇒ Google::Apis::ContainerV1beta1::NodePoolLoggingConfig
NodePoolLoggingConfig specifies logging configuration for nodepools.
-
#machine_type ⇒ String
Optional.
-
#name ⇒ String
The name (project, location, cluster, node pool) of the node pool to update.
-
#node_network_config ⇒ Google::Apis::ContainerV1beta1::NodeNetworkConfig
Parameters for node pool-level network config.
-
#node_pool_id ⇒ String
Required.
-
#node_version ⇒ String
Required.
-
#project_id ⇒ String
Required.
-
#queued_provisioning ⇒ Google::Apis::ContainerV1beta1::QueuedProvisioning
QueuedProvisioning defines the queued provisioning used by the node pool.
-
#resource_labels ⇒ Google::Apis::ContainerV1beta1::ResourceLabels
Collection of GCP labels.
-
#resource_manager_tags ⇒ Google::Apis::ContainerV1beta1::ResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
-
#tags ⇒ Google::Apis::ContainerV1beta1::NetworkTags
Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.
-
#taints ⇒ Google::Apis::ContainerV1beta1::NodeTaints
Collection of Kubernetes node taints.
-
#upgrade_settings ⇒ Google::Apis::ContainerV1beta1::UpgradeSettings
These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.
-
#windows_node_config ⇒ Google::Apis::ContainerV1beta1::WindowsNodeConfig
Parameters that can be configured on Windows nodes.
-
#workload_metadata_config ⇒ Google::Apis::ContainerV1beta1::WorkloadMetadataConfig
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.
-
#zone ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ UpdateNodePoolRequest
constructor
A new instance of UpdateNodePoolRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ UpdateNodePoolRequest
Returns a new instance of UpdateNodePoolRequest.
8114 8115 8116 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8114 def initialize(**args) update!(**args) end |
Instance Attribute Details
#accelerators ⇒ Array<Google::Apis::ContainerV1beta1::AcceleratorConfig>
A list of hardware accelerators to be attached to each node. See https://cloud.
google.com/compute/docs/gpus for more information about support for GPUs.
Corresponds to the JSON property accelerators
7892 7893 7894 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7892 def accelerators @accelerators end |
#cluster_id ⇒ String
Required. Deprecated. The name of the cluster to upgrade. This field has been
deprecated and replaced by the name field.
Corresponds to the JSON property clusterId
7898 7899 7900 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7898 def cluster_id @cluster_id end |
#confidential_nodes ⇒ Google::Apis::ContainerV1beta1::ConfidentialNodes
ConfidentialNodes is configuration for the confidential nodes feature, which
makes nodes run on confidential VMs.
Corresponds to the JSON property confidentialNodes
7904 7905 7906 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7904 def confidential_nodes @confidential_nodes end |
#containerd_config ⇒ Google::Apis::ContainerV1beta1::ContainerdConfig
ContainerdConfig contains configuration to customize containerd.
Corresponds to the JSON property containerdConfig
7909 7910 7911 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7909 def containerd_config @containerd_config end |
#disk_size_gb ⇒ Fixnum
Optional. The desired disk size for nodes in the node pool. Initiates an
upgrade operation that migrates the nodes in the node pool to the specified
disk size.
Corresponds to the JSON property diskSizeGb
7916 7917 7918 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7916 def disk_size_gb @disk_size_gb end |
#disk_type ⇒ String
Optional. The desired disk type for nodes in the node pool. Initiates an
upgrade operation that migrates the nodes in the node pool to the specified
disk type.
Corresponds to the JSON property diskType
7923 7924 7925 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7923 def disk_type @disk_type end |
#etag ⇒ String
The current etag of the node pool. If an etag is provided and does not match
the current etag of the node pool, update will be blocked and an ABORTED error
will be returned.
Corresponds to the JSON property etag
7930 7931 7932 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7930 def etag @etag end |
#fast_socket ⇒ Google::Apis::ContainerV1beta1::FastSocket
Configuration of Fast Socket feature.
Corresponds to the JSON property fastSocket
7935 7936 7937 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7935 def fast_socket @fast_socket end |
#gcfs_config ⇒ Google::Apis::ContainerV1beta1::GcfsConfig
GcfsConfig contains configurations of Google Container File System.
Corresponds to the JSON property gcfsConfig
7940 7941 7942 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7940 def gcfs_config @gcfs_config end |
#gvnic ⇒ Google::Apis::ContainerV1beta1::VirtualNic
Configuration of gVNIC feature.
Corresponds to the JSON property gvnic
7945 7946 7947 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7945 def gvnic @gvnic end |
#image_type ⇒ String
Required. The desired image type for the node pool. Please see https://cloud.
google.com/kubernetes-engine/docs/concepts/node-images for available image
types.
Corresponds to the JSON property imageType
7952 7953 7954 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7952 def image_type @image_type end |
#kubelet_config ⇒ Google::Apis::ContainerV1beta1::NodeKubeletConfig
Node kubelet configs.
Corresponds to the JSON property kubeletConfig
7957 7958 7959 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7957 def kubelet_config @kubelet_config end |
#labels ⇒ Google::Apis::ContainerV1beta1::NodeLabels
Collection of node-level Kubernetes labels.
Corresponds to the JSON property labels
7963 7964 7965 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7963 def labels @labels end |
#linux_node_config ⇒ Google::Apis::ContainerV1beta1::LinuxNodeConfig
Parameters that can be configured on Linux nodes.
Corresponds to the JSON property linuxNodeConfig
7968 7969 7970 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7968 def linux_node_config @linux_node_config end |
#locations ⇒ Array<String>
The desired list of Google Compute Engine zones in which the node pool's nodes should be located.
Changing the locations for a node pool will result in nodes being either
created or removed from the node pool, depending on whether locations are
being added or removed.
Corresponds to the JSON property locations
7977 7978 7979 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7977 def locations @locations end |
#logging_config ⇒ Google::Apis::ContainerV1beta1::NodePoolLoggingConfig
NodePoolLoggingConfig specifies logging configuration for nodepools.
Corresponds to the JSON property loggingConfig
7982 7983 7984 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7982 def logging_config @logging_config end |
#machine_type ⇒ String
Optional. The desired machine type for nodes in the node pool. Initiates an
upgrade operation that migrates the nodes in the node pool to the specified
machine type.
Corresponds to the JSON property machineType
7989 7990 7991 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7989 def machine_type @machine_type end |
#name ⇒ String
The name (project, location, cluster, node pool) of the node pool to update.
Specified in the format projects/*/locations/*/clusters/*/nodePools/*
.
Corresponds to the JSON property name
7995 7996 7997 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 7995 def name @name end |
#node_network_config ⇒ Google::Apis::ContainerV1beta1::NodeNetworkConfig
Parameters for node pool-level network config.
Corresponds to the JSON property nodeNetworkConfig
8000 8001 8002 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8000 def node_network_config @node_network_config end |
#node_pool_id ⇒ String
Required. Deprecated. The name of the node pool to upgrade. This field has
been deprecated and replaced by the name field.
Corresponds to the JSON property nodePoolId
8006 8007 8008 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8006 def node_pool_id @node_pool_id end |
#node_version ⇒ String
Required. The Kubernetes version to change the nodes to (typically an upgrade).
Users may specify either explicit versions offered by Kubernetes Engine or
version aliases, which have the following behavior: - "latest": picks the
highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N
patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the
1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-":
picks the Kubernetes master version
Corresponds to the JSON property nodeVersion
8017 8018 8019 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8017 def node_version @node_version end |
#project_id ⇒ String
Required. Deprecated. The Google Developers Console project ID or project
number. This field has been deprecated and replaced by the name field.
Corresponds to the JSON property projectId
8024 8025 8026 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8024 def project_id @project_id end |
#queued_provisioning ⇒ Google::Apis::ContainerV1beta1::QueuedProvisioning
QueuedProvisioning defines the queued provisioning used by the node pool.
Corresponds to the JSON property queuedProvisioning
8029 8030 8031 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8029 def queued_provisioning @queued_provisioning end |
#resource_labels ⇒ Google::Apis::ContainerV1beta1::ResourceLabels
Collection of GCP labels.
Corresponds to the JSON property resourceLabels
8035 8036 8037 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8035 def resource_labels @resource_labels end |
#resource_manager_tags ⇒ Google::Apis::ContainerV1beta1::ResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes for
managing Compute Engine firewalls using Network Firewall Policies. Tags must
be according to specifications in https://cloud.google.com/vpc/docs/tags-
firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be
specified. Existing tags will be replaced with new values.
Corresponds to the JSON property resourceManagerTags
8044 8045 8046 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8044 def @resource_manager_tags end |
#tags ⇒ Google::Apis::ContainerV1beta1::NetworkTags
Collection of Compute Engine network tags that can be applied to a node's
underlying VM instance. (See tags
field in NodeConfig
).
Corresponds to the JSON property tags
8051 8052 8053 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8051 def @tags end |
#taints ⇒ Google::Apis::ContainerV1beta1::NodeTaints
Collection of Kubernetes node taints.
Corresponds to the JSON property taints
8057 8058 8059 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8057 def taints @taints end |
#upgrade_settings ⇒ Google::Apis::ContainerV1beta1::UpgradeSettings
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 SURGE, 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.
Corresponds to the JSON property upgradeSettings
8092 8093 8094 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8092 def upgrade_settings @upgrade_settings end |
#windows_node_config ⇒ Google::Apis::ContainerV1beta1::WindowsNodeConfig
Parameters that can be configured on Windows nodes. Windows Node Config that
define the parameters that will be used to configure the Windows node pool
settings
Corresponds to the JSON property windowsNodeConfig
8099 8100 8101 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8099 def windows_node_config @windows_node_config end |
#workload_metadata_config ⇒ Google::Apis::ContainerV1beta1::WorkloadMetadataConfig
WorkloadMetadataConfig defines the metadata configuration to expose to
workloads on the node pool.
Corresponds to the JSON property workloadMetadataConfig
8105 8106 8107 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8105 def @workload_metadata_config end |
#zone ⇒ String
Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides.
This field has been deprecated and replaced by the name field.
Corresponds to the JSON property zone
8112 8113 8114 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8112 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 |
# File 'lib/google/apis/container_v1beta1/classes.rb', line 8119 def update!(**args) @accelerators = args[:accelerators] if args.key?(:accelerators) @cluster_id = args[:cluster_id] if args.key?(:cluster_id) @confidential_nodes = args[:confidential_nodes] if args.key?(:confidential_nodes) @containerd_config = args[:containerd_config] if args.key?(:containerd_config) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @disk_type = args[:disk_type] if args.key?(:disk_type) @etag = args[:etag] if args.key?(:etag) @fast_socket = args[:fast_socket] if args.key?(:fast_socket) @gcfs_config = args[:gcfs_config] if args.key?(:gcfs_config) @gvnic = args[:gvnic] if args.key?(:gvnic) @image_type = args[:image_type] if args.key?(:image_type) @kubelet_config = args[:kubelet_config] if args.key?(:kubelet_config) @labels = args[:labels] if args.key?(:labels) @linux_node_config = args[:linux_node_config] if args.key?(:linux_node_config) @locations = args[:locations] if args.key?(:locations) @logging_config = args[:logging_config] if args.key?(:logging_config) @machine_type = args[:machine_type] if args.key?(:machine_type) @name = args[:name] if args.key?(:name) @node_network_config = args[:node_network_config] if args.key?(:node_network_config) @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) @node_version = args[:node_version] if args.key?(:node_version) @project_id = args[:project_id] if args.key?(:project_id) @queued_provisioning = args[:queued_provisioning] if args.key?(:queued_provisioning) @resource_labels = args[:resource_labels] if args.key?(:resource_labels) @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags) @tags = args[:tags] if args.key?(:tags) @taints = args[:taints] if args.key?(:taints) @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings) @windows_node_config = args[:windows_node_config] if args.key?(:windows_node_config) @workload_metadata_config = args[:workload_metadata_config] if args.key?(:workload_metadata_config) @zone = args[:zone] if args.key?(:zone) end |