blob: 1ccd020d28ac5d44826f10ddb07808f56f48c3ee [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.locations.html">locations</a> . <a href="container_v1beta1.projects.locations.clusters.html">clusters</a> . <a href="container_v1beta1.projects.locations.clusters.nodePools.html">nodePools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Creates a node pool for a cluster.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(name, clusterId=None, projectId=None, zone=None, nodePoolId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Deletes a node pool from a cluster.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#get">get(name, clusterId=None, projectId=None, zone=None, nodePoolId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Retrieves the requested node pool.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#list">list(parent, projectId=None, clusterId=None, zone=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists the node pools for a cluster.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#rollback">rollback(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Sets the autoscaling settings of a specific node pool.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#setManagement">setManagement(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Sets the NodeManagement options for a node pool.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#setSize">setSize(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Sets the size for a specific node pool.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Updates the version and/or image type of a specific node pool.</p>
104<h3>Method Details</h3>
105<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 <pre>Creates a node pool for a cluster.
108
109Args:
110 parent: string, The parent (project, location, cluster id) where the node pool will be
111created. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -0700112`projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 The object takes the form of:
115
116{ # CreateNodePoolRequest creates a node pool for a cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
118 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
119 # cluster resides. This field has been deprecated and replaced by the parent
120 # field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700121 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
122 # number](https://developers.google.com/console/help/new/#projectnumber).
123 # This field has been deprecated and replaced by the parent field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;nodePool&quot;: { # NodePool contains the name and configuration for a cluster&#x27;s node pool. # Required. The node pool to create.
125 # Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126 # specification, under the control of the cluster master. They may have a set
127 # of Kubernetes labels applied to them, which may be used to reference them
128 # during pod scheduling. They may also be resized up or down, to accommodate
129 # the workload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700130 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
132 # disruption caused by an upgrade.
133 #
134 # maxUnavailable controls the number of nodes that can be simultaneously
135 # unavailable.
136 #
137 # maxSurge controls the number of additional nodes that can be added to the
138 # node pool temporarily for the time of the upgrade to increase the number of
139 # available nodes.
140 #
141 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
142 # nodes are being upgraded at the same time).
143 #
144 # Note: upgrades inevitably introduce some disruption since workloads need to
145 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
146 # this holds true. (Disruption stays within the limits of
147 # PodDisruptionBudget, if it is configured.)
148 #
149 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
150 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
151 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
152 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
153 # there are always at least 4 nodes available.
154 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during
155 # the upgrade process. A node is considered available if its status is
156 # Ready.
157 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size
158 # of the node pool during the upgrade process.
159 },
160 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance
161 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
162 # associated with this node pool.
163 &quot;A String&quot;,
164 ],
165 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
166 # only if a valid configuration is present.
167 # adjust the size of the node pool to the current cluster usage.
168 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
169 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
170 # max_node_count.
171 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
172 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
173 # has to enough quota to scale up the cluster.
174 },
175 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your
176 # Compute Engine [resource quota](https://cloud.google.com/compute/quotas)
177 # is sufficient for this number of instances. You must also have available
178 # firewall and routes quota.
Bu Sun Kim65020912020-05-20 12:08:20 -0700179 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700180 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the
181 # node VMs under the &quot;default&quot; service account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700182 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 # The following scopes are recommended, but not required, and by default are
184 # not included:
185 #
186 # * `https://www.googleapis.com/auth/compute` is required for mounting
187 # persistent storage on your nodes.
188 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
189 # communicating with **gcr.io**
190 # (the [Google Container
191 # Registry](https://cloud.google.com/container-registry/)).
192 #
193 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
194 # Monitoring are enabled, in which case their required scopes will be added.
195 &quot;A String&quot;,
196 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster.
198 #
199 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
200 # in length. These are reflected as part of a URL in the metadata server.
201 # Additionally, to avoid ambiguity, keys must not conflict with any other
202 # metadata keys for the project or be one of the reserved keys:
203 # &quot;cluster-location&quot;
204 # &quot;cluster-name&quot;
205 # &quot;cluster-uid&quot;
206 # &quot;configure-sh&quot;
207 # &quot;containerd-configure-sh&quot;
208 # &quot;enable-oslogin&quot;
209 # &quot;gci-ensure-gke-docker&quot;
210 # &quot;gci-metrics-enabled&quot;
211 # &quot;gci-update-strategy&quot;
212 # &quot;instance-template&quot;
213 # &quot;kube-env&quot;
214 # &quot;startup-script&quot;
215 # &quot;user-data&quot;
216 # &quot;disable-address-manager&quot;
217 # &quot;windows-startup-script-ps1&quot;
218 # &quot;common-psm1&quot;
219 # &quot;k8s-node-setup-psm1&quot;
220 # &quot;install-ssh-psm1&quot;
221 # &quot;user-profile-psm1&quot;
222 # &quot;serial-port-logging-enable&quot;
223 # Values are free-form strings, and only have meaning as interpreted by
224 # the image running in the instance. The only restriction placed on them is
225 # that each value&#x27;s size must be less than or equal to 32 KB.
226 #
227 # The total size of all keys and values must be less than 512 KB.
228 &quot;a_key&quot;: &quot;A String&quot;,
229 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700230 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine
231 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
232 # `n1-standard-1`).
233 #
234 # If unspecified, the default machine type is
235 # `n1-standard-1`.
236 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this
237 # pool to run on the specified node group. This is useful for running
238 # workloads on [sole tenant
239 # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
240 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
241 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
242 #
243 # Secure Boot helps ensure that the system only runs authentic software by
244 # verifying the digital signature of all boot components, and halting the
245 # boot process if signature verification fails.
246 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
247 #
248 # Enables monitoring and attestation of the boot integrity of the instance.
249 # The attestation is performed against the integrity policy baseline. This
250 # baseline is initially derived from the implicitly trusted boot image when
251 # the instance is created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700252 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700254 # Specify the email address of the Service Account; otherwise, if no Service
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 # Account is specified, the &quot;default&quot; service account is used.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700256 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
257 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running
258 # on the nodes.
259 #
260 # The following parameters are supported.
261 #
262 # net.core.netdev_max_backlog
263 # net.core.rmem_max
264 # net.core.wmem_default
265 # net.core.wmem_max
266 # net.core.optmem_max
267 # net.core.somaxconn
268 # net.ipv4.tcp_rmem
269 # net.ipv4.tcp_wmem
270 # net.ipv4.tcp_tw_reuse
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 },
274 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
275 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
276 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
277 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700279 #
280 # For more information, including usage and the valid values, see:
281 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
282 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
283 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
284 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700285 # See
286 # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)
287 # for more information, including usage and the valid values.
Bu Sun Kim65020912020-05-20 12:08:20 -0700288 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700289 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700290 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700291 },
292 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700293 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
294 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;.
295 #
296 # The string must be a sequence of decimal numbers, each with optional
297 # fraction and a unit suffix, such as &quot;300ms&quot;.
298 # Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.
299 # The value must be a positive duration.
300 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.
301 #
302 # If this option is enabled, kubelet uses CFS quota
303 # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
304 # enforce container CPU limits. Otherwise, CPU limits will not be enforced at
305 # all.
306 #
307 # Disable this option to mitigate CPU throttling problems while still having
308 # your pods to be in Guaranteed QoS class by specifying the CPU limits.
309 #
310 # The default value is &#x27;true&#x27; if unspecified.
311 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node.
312 # See
313 # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
314 #
315 # The following values are allowed.
316 # - &quot;none&quot;: the default, which represents the existing scheduling behavior.
317 # - &quot;static&quot;: allows pods with certain resource characteristics to be
318 # granted increased CPU affinity and exclusivity on the node.
319 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
321 # These will added in addition to any default label(s) that
322 # Kubernetes may apply to the node.
323 # In case of conflict in label keys, the applied set may differ depending on
324 # the Kubernetes version -- it&#x27;s best to assume the behavior is undefined
325 # and conflicts should be avoided.
326 # For more information, including usage and the valid values, see:
327 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
328 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700329 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700330 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700331 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700332 # If unspecified, the default disk type is &#x27;pd-standard&#x27;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700333 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
334 # workloads on the node pool.
335 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the
336 # workloads running on the node.
337 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running
338 # on the node pool.
339 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700340 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, #
341 # The Customer Managed Encryption Key used to encrypt the boot disk attached
342 # to each node in the node pool. This should be of the form
343 # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
344 # For more information about protecting resources with Cloud KMS Keys please
345 # see:
346 # https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700347 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB.
348 # The smallest allowed disk size is 10GB.
349 #
350 # If unspecified, the default disk size is 100GB.
351 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
352 # the specified [Zonal Compute
353 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
354 # to this node pool.
355 # is the configuration of desired reservation which instances could take
356 # capacity from.
357 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
358 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a
359 # SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as
360 # the key and specify the name of your reservation as its value.
361 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
362 &quot;A String&quot;,
363 ],
364 },
365 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See:
366 # https://cloud.google.com/compute/docs/instances/preemptible for more
367 # inforamtion about preemptible VM instances.
368 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be
369 # scheduled on the specified or newer CPU platform. Applicable values are the
370 # friendly names of CPU platforms, such as
371 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
372 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
373 # information, read [how to specify min CPU
374 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
375 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify
376 # valid sources or targets for network firewalls and are specified by
377 # the client during cluster or node pool creation. Each tag within the list
378 # must comply with RFC1035.
379 &quot;A String&quot;,
380 ],
381 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node.
382 # See https://cloud.google.com/compute/docs/gpus for more information about
383 # support for GPUs.
384 { # AcceleratorConfig represents a Hardware Accelerator request.
385 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
386 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators
387 # [here](https://cloud.google.com/compute/docs/gpus)
388 },
389 ],
390 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node.
391 #
392 # The limit for this value is dependent upon the maximum number of
393 # disks available on a machine per zone. See:
394 # https://cloud.google.com/compute/docs/disks/local-ssd
395 # for more information.
396 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type,
397 # the latest version of it will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700398 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700399 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700400 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
401 # node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -0700402 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700403 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700404 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
405 # the Auto Upgrades will proceed.
406 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
407 # with the description of the upgrade.
408 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
409 # with the approximate start time for the upgrades, in
410 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
411 },
412 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700413 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
414 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
415 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
416 # simultaneously on a node in the node pool.
417 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
418 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700419 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this
420 # node pool instance, if available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700421 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
422 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
423 { # StatusCondition describes why a cluster or a node pool has a certain status
424 # (e.g., ERROR or DEGRADED).
425 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
426 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
427 },
428 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700429 &quot;locations&quot;: [ # The list of Google Compute Engine
430 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
431 # NodePool&#x27;s nodes should be located.
432 &quot;A String&quot;,
433 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700435 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster.
436 # This field has been deprecated and replaced by the parent field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700437 &quot;parent&quot;: &quot;A String&quot;, # The parent (project, location, cluster id) where the node pool will be
438 # created. Specified in the format
439 # `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440 }
441
442 x__xgafv: string, V1 error format.
443 Allowed values
444 1 - v1 error format
445 2 - v2 error format
446
447Returns:
448 An object of the form:
449
450 { # This operation resource represents operations that may have happened or are
451 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700452 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700453 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700454 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700455 &quot;stages&quot;: [ # Substages of an operation or a stage.
456 # Object with schema name: OperationProgress
457 ],
458 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
459 # Unset for single-stage operations.
460 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
461 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700462 &quot;metrics&quot;: [ # Progress metric bundle, for example:
463 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
464 # {name: &quot;nodes total&quot;, int_value: 32}]
465 # or
466 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
467 # {name: &quot;progress scale&quot;, double_value: 1.0}]
468 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -0700469 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700470 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700471 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
472 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700473 },
474 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700475 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700476 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
477 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
478 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
479 # or
480 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
481 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700482 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
483 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
484 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700485 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
486 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700487 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700488 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
489 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
490 { # StatusCondition describes why a cluster or a node pool has a certain status
491 # (e.g., ERROR or DEGRADED).
492 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
493 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
494 },
495 ],
496 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
497 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
498 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
499 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
500 { # StatusCondition describes why a cluster or a node pool has a certain status
501 # (e.g., ERROR or DEGRADED).
502 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
503 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
504 },
505 ],
506 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507 }</pre>
508</div>
509
510<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700511 <code class="details" id="delete">delete(name, clusterId=None, projectId=None, zone=None, nodePoolId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700512 <pre>Deletes a node pool from a cluster.
513
514Args:
515 name: string, The name (project, location, cluster, node pool id) of the node pool to
516delete. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -0700517`projects/*/locations/*/clusters/*/nodePools/*`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700518 clusterId: string, Required. Deprecated. The name of the cluster.
519This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700520 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
521number](https://developers.google.com/console/help/new/#projectnumber).
522This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700523 zone: string, Required. Deprecated. The name of the Google Compute Engine
524[zone](https://cloud.google.com/compute/docs/zones#available) in which the
525cluster resides. This field has been deprecated and replaced by the name
526field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700527 nodePoolId: string, Required. Deprecated. The name of the node pool to delete.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700528This field has been deprecated and replaced by the name field.
529 x__xgafv: string, V1 error format.
530 Allowed values
531 1 - v1 error format
532 2 - v2 error format
533
534Returns:
535 An object of the form:
536
537 { # This operation resource represents operations that may have happened or are
538 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700539 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700540 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700541 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700542 &quot;stages&quot;: [ # Substages of an operation or a stage.
543 # Object with schema name: OperationProgress
544 ],
545 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
546 # Unset for single-stage operations.
547 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
548 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700549 &quot;metrics&quot;: [ # Progress metric bundle, for example:
550 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
551 # {name: &quot;nodes total&quot;, int_value: 32}]
552 # or
553 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
554 # {name: &quot;progress scale&quot;, double_value: 1.0}]
555 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -0700556 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700557 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700558 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
559 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700560 },
561 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700562 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700563 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
564 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
565 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
566 # or
567 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
568 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700569 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
570 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
571 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700572 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
573 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700574 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700575 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
576 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
577 { # StatusCondition describes why a cluster or a node pool has a certain status
578 # (e.g., ERROR or DEGRADED).
579 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
580 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
581 },
582 ],
583 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
584 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
585 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
586 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
587 { # StatusCondition describes why a cluster or a node pool has a certain status
588 # (e.g., ERROR or DEGRADED).
589 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
590 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
591 },
592 ],
593 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700594 }</pre>
595</div>
596
597<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700598 <code class="details" id="get">get(name, clusterId=None, projectId=None, zone=None, nodePoolId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700599 <pre>Retrieves the requested node pool.
600
601Args:
602 name: string, The name (project, location, cluster, node pool id) of the node pool to
603get. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -0700604`projects/*/locations/*/clusters/*/nodePools/*`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700605 clusterId: string, Required. Deprecated. The name of the cluster.
606This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700607 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
608number](https://developers.google.com/console/help/new/#projectnumber).
609This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700610 zone: string, Required. Deprecated. The name of the Google Compute Engine
611[zone](https://cloud.google.com/compute/docs/zones#available) in which the
612cluster resides. This field has been deprecated and replaced by the name
613field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700614 nodePoolId: string, Required. Deprecated. The name of the node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700615This field has been deprecated and replaced by the name field.
616 x__xgafv: string, V1 error format.
617 Allowed values
618 1 - v1 error format
619 2 - v2 error format
620
621Returns:
622 An object of the form:
623
Bu Sun Kim65020912020-05-20 12:08:20 -0700624 { # NodePool contains the name and configuration for a cluster&#x27;s node pool.
625 # Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700626 # specification, under the control of the cluster master. They may have a set
627 # of Kubernetes labels applied to them, which may be used to reference them
628 # during pod scheduling. They may also be resized up or down, to accommodate
629 # the workload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700630 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700631 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
632 # disruption caused by an upgrade.
633 #
634 # maxUnavailable controls the number of nodes that can be simultaneously
635 # unavailable.
636 #
637 # maxSurge controls the number of additional nodes that can be added to the
638 # node pool temporarily for the time of the upgrade to increase the number of
639 # available nodes.
640 #
641 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
642 # nodes are being upgraded at the same time).
643 #
644 # Note: upgrades inevitably introduce some disruption since workloads need to
645 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
646 # this holds true. (Disruption stays within the limits of
647 # PodDisruptionBudget, if it is configured.)
648 #
649 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
650 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
651 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
652 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
653 # there are always at least 4 nodes available.
654 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during
655 # the upgrade process. A node is considered available if its status is
656 # Ready.
657 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size
658 # of the node pool during the upgrade process.
659 },
660 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance
661 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
662 # associated with this node pool.
663 &quot;A String&quot;,
664 ],
665 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
666 # only if a valid configuration is present.
667 # adjust the size of the node pool to the current cluster usage.
668 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
669 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
670 # max_node_count.
671 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
672 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
673 # has to enough quota to scale up the cluster.
674 },
675 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your
676 # Compute Engine [resource quota](https://cloud.google.com/compute/quotas)
677 # is sufficient for this number of instances. You must also have available
678 # firewall and routes quota.
Bu Sun Kim65020912020-05-20 12:08:20 -0700679 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700680 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the
681 # node VMs under the &quot;default&quot; service account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700682 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700683 # The following scopes are recommended, but not required, and by default are
684 # not included:
685 #
686 # * `https://www.googleapis.com/auth/compute` is required for mounting
687 # persistent storage on your nodes.
688 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
689 # communicating with **gcr.io**
690 # (the [Google Container
691 # Registry](https://cloud.google.com/container-registry/)).
692 #
693 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
694 # Monitoring are enabled, in which case their required scopes will be added.
695 &quot;A String&quot;,
696 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700697 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster.
698 #
699 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
700 # in length. These are reflected as part of a URL in the metadata server.
701 # Additionally, to avoid ambiguity, keys must not conflict with any other
702 # metadata keys for the project or be one of the reserved keys:
703 # &quot;cluster-location&quot;
704 # &quot;cluster-name&quot;
705 # &quot;cluster-uid&quot;
706 # &quot;configure-sh&quot;
707 # &quot;containerd-configure-sh&quot;
708 # &quot;enable-oslogin&quot;
709 # &quot;gci-ensure-gke-docker&quot;
710 # &quot;gci-metrics-enabled&quot;
711 # &quot;gci-update-strategy&quot;
712 # &quot;instance-template&quot;
713 # &quot;kube-env&quot;
714 # &quot;startup-script&quot;
715 # &quot;user-data&quot;
716 # &quot;disable-address-manager&quot;
717 # &quot;windows-startup-script-ps1&quot;
718 # &quot;common-psm1&quot;
719 # &quot;k8s-node-setup-psm1&quot;
720 # &quot;install-ssh-psm1&quot;
721 # &quot;user-profile-psm1&quot;
722 # &quot;serial-port-logging-enable&quot;
723 # Values are free-form strings, and only have meaning as interpreted by
724 # the image running in the instance. The only restriction placed on them is
725 # that each value&#x27;s size must be less than or equal to 32 KB.
726 #
727 # The total size of all keys and values must be less than 512 KB.
728 &quot;a_key&quot;: &quot;A String&quot;,
729 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700730 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine
731 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
732 # `n1-standard-1`).
733 #
734 # If unspecified, the default machine type is
735 # `n1-standard-1`.
736 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this
737 # pool to run on the specified node group. This is useful for running
738 # workloads on [sole tenant
739 # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
740 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
741 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
742 #
743 # Secure Boot helps ensure that the system only runs authentic software by
744 # verifying the digital signature of all boot components, and halting the
745 # boot process if signature verification fails.
746 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
747 #
748 # Enables monitoring and attestation of the boot integrity of the instance.
749 # The attestation is performed against the integrity policy baseline. This
750 # baseline is initially derived from the implicitly trusted boot image when
751 # the instance is created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700752 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700753 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700754 # Specify the email address of the Service Account; otherwise, if no Service
Bu Sun Kim65020912020-05-20 12:08:20 -0700755 # Account is specified, the &quot;default&quot; service account is used.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700756 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
757 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running
758 # on the nodes.
759 #
760 # The following parameters are supported.
761 #
762 # net.core.netdev_max_backlog
763 # net.core.rmem_max
764 # net.core.wmem_default
765 # net.core.wmem_max
766 # net.core.optmem_max
767 # net.core.somaxconn
768 # net.ipv4.tcp_rmem
769 # net.ipv4.tcp_wmem
770 # net.ipv4.tcp_tw_reuse
771 &quot;a_key&quot;: &quot;A String&quot;,
772 },
773 },
774 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
775 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
776 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
777 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700778 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700779 #
780 # For more information, including usage and the valid values, see:
781 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
782 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
783 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
784 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700785 # See
786 # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)
787 # for more information, including usage and the valid values.
Bu Sun Kim65020912020-05-20 12:08:20 -0700788 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700789 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700790 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700791 },
792 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700793 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
794 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;.
795 #
796 # The string must be a sequence of decimal numbers, each with optional
797 # fraction and a unit suffix, such as &quot;300ms&quot;.
798 # Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.
799 # The value must be a positive duration.
800 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.
801 #
802 # If this option is enabled, kubelet uses CFS quota
803 # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
804 # enforce container CPU limits. Otherwise, CPU limits will not be enforced at
805 # all.
806 #
807 # Disable this option to mitigate CPU throttling problems while still having
808 # your pods to be in Guaranteed QoS class by specifying the CPU limits.
809 #
810 # The default value is &#x27;true&#x27; if unspecified.
811 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node.
812 # See
813 # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
814 #
815 # The following values are allowed.
816 # - &quot;none&quot;: the default, which represents the existing scheduling behavior.
817 # - &quot;static&quot;: allows pods with certain resource characteristics to be
818 # granted increased CPU affinity and exclusivity on the node.
819 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700820 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
821 # These will added in addition to any default label(s) that
822 # Kubernetes may apply to the node.
823 # In case of conflict in label keys, the applied set may differ depending on
824 # the Kubernetes version -- it&#x27;s best to assume the behavior is undefined
825 # and conflicts should be avoided.
826 # For more information, including usage and the valid values, see:
827 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
828 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700829 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700830 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700831 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700832 # If unspecified, the default disk type is &#x27;pd-standard&#x27;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700833 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
834 # workloads on the node pool.
835 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the
836 # workloads running on the node.
837 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running
838 # on the node pool.
839 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700840 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, #
841 # The Customer Managed Encryption Key used to encrypt the boot disk attached
842 # to each node in the node pool. This should be of the form
843 # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
844 # For more information about protecting resources with Cloud KMS Keys please
845 # see:
846 # https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700847 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB.
848 # The smallest allowed disk size is 10GB.
849 #
850 # If unspecified, the default disk size is 100GB.
851 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
852 # the specified [Zonal Compute
853 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
854 # to this node pool.
855 # is the configuration of desired reservation which instances could take
856 # capacity from.
857 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
858 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a
859 # SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as
860 # the key and specify the name of your reservation as its value.
861 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
862 &quot;A String&quot;,
863 ],
864 },
865 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See:
866 # https://cloud.google.com/compute/docs/instances/preemptible for more
867 # inforamtion about preemptible VM instances.
868 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be
869 # scheduled on the specified or newer CPU platform. Applicable values are the
870 # friendly names of CPU platforms, such as
871 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
872 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
873 # information, read [how to specify min CPU
874 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
875 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify
876 # valid sources or targets for network firewalls and are specified by
877 # the client during cluster or node pool creation. Each tag within the list
878 # must comply with RFC1035.
879 &quot;A String&quot;,
880 ],
881 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node.
882 # See https://cloud.google.com/compute/docs/gpus for more information about
883 # support for GPUs.
884 { # AcceleratorConfig represents a Hardware Accelerator request.
885 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
886 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators
887 # [here](https://cloud.google.com/compute/docs/gpus)
888 },
889 ],
890 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node.
891 #
892 # The limit for this value is dependent upon the maximum number of
893 # disks available on a machine per zone. See:
894 # https://cloud.google.com/compute/docs/disks/local-ssd
895 # for more information.
896 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type,
897 # the latest version of it will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700898 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700899 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700900 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
901 # node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -0700902 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700903 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700904 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
905 # the Auto Upgrades will proceed.
906 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
907 # with the description of the upgrade.
908 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
909 # with the approximate start time for the upgrades, in
910 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
911 },
912 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700913 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
914 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
915 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
916 # simultaneously on a node in the node pool.
917 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
918 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700919 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this
920 # node pool instance, if available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700921 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
922 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
923 { # StatusCondition describes why a cluster or a node pool has a certain status
924 # (e.g., ERROR or DEGRADED).
925 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
926 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
927 },
928 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700929 &quot;locations&quot;: [ # The list of Google Compute Engine
930 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
931 # NodePool&#x27;s nodes should be located.
932 &quot;A String&quot;,
933 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700934 }</pre>
935</div>
936
937<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700938 <code class="details" id="list">list(parent, projectId=None, clusterId=None, zone=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700939 <pre>Lists the node pools for a cluster.
940
941Args:
942 parent: string, The parent (project, location, cluster id) where the node pools will be
Bu Sun Kim65020912020-05-20 12:08:20 -0700943listed. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700944 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700945number](https://developers.google.com/console/help/new/#projectnumber).
946This field has been deprecated and replaced by the parent field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700947 clusterId: string, Required. Deprecated. The name of the cluster.
948This field has been deprecated and replaced by the parent field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700949 zone: string, Required. Deprecated. The name of the Google Compute Engine
950[zone](https://cloud.google.com/compute/docs/zones#available) in which the
951cluster resides. This field has been deprecated and replaced by the parent
952field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700953 x__xgafv: string, V1 error format.
954 Allowed values
955 1 - v1 error format
956 2 - v2 error format
957
958Returns:
959 An object of the form:
960
961 { # ListNodePoolsResponse is the result of ListNodePoolsRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700962 &quot;nodePools&quot;: [ # A list of node pools for a cluster.
963 { # NodePool contains the name and configuration for a cluster&#x27;s node pool.
964 # Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700965 # specification, under the control of the cluster master. They may have a set
966 # of Kubernetes labels applied to them, which may be used to reference them
967 # during pod scheduling. They may also be resized up or down, to accommodate
968 # the workload.
Bu Sun Kim65020912020-05-20 12:08:20 -0700969 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700970 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
971 # disruption caused by an upgrade.
972 #
973 # maxUnavailable controls the number of nodes that can be simultaneously
974 # unavailable.
975 #
976 # maxSurge controls the number of additional nodes that can be added to the
977 # node pool temporarily for the time of the upgrade to increase the number of
978 # available nodes.
979 #
980 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
981 # nodes are being upgraded at the same time).
982 #
983 # Note: upgrades inevitably introduce some disruption since workloads need to
984 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
985 # this holds true. (Disruption stays within the limits of
986 # PodDisruptionBudget, if it is configured.)
987 #
988 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
989 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
990 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
991 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
992 # there are always at least 4 nodes available.
993 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during
994 # the upgrade process. A node is considered available if its status is
995 # Ready.
996 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size
997 # of the node pool during the upgrade process.
998 },
999 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance
1000 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
1001 # associated with this node pool.
1002 &quot;A String&quot;,
1003 ],
1004 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
1005 # only if a valid configuration is present.
1006 # adjust the size of the node pool to the current cluster usage.
1007 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
1008 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
1009 # max_node_count.
1010 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
1011 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
1012 # has to enough quota to scale up the cluster.
1013 },
1014 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your
1015 # Compute Engine [resource quota](https://cloud.google.com/compute/quotas)
1016 # is sufficient for this number of instances. You must also have available
1017 # firewall and routes quota.
Bu Sun Kim65020912020-05-20 12:08:20 -07001018 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001019 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the
1020 # node VMs under the &quot;default&quot; service account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001021 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001022 # The following scopes are recommended, but not required, and by default are
1023 # not included:
1024 #
1025 # * `https://www.googleapis.com/auth/compute` is required for mounting
1026 # persistent storage on your nodes.
1027 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
1028 # communicating with **gcr.io**
1029 # (the [Google Container
1030 # Registry](https://cloud.google.com/container-registry/)).
1031 #
1032 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
1033 # Monitoring are enabled, in which case their required scopes will be added.
1034 &quot;A String&quot;,
1035 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001036 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster.
1037 #
1038 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
1039 # in length. These are reflected as part of a URL in the metadata server.
1040 # Additionally, to avoid ambiguity, keys must not conflict with any other
1041 # metadata keys for the project or be one of the reserved keys:
1042 # &quot;cluster-location&quot;
1043 # &quot;cluster-name&quot;
1044 # &quot;cluster-uid&quot;
1045 # &quot;configure-sh&quot;
1046 # &quot;containerd-configure-sh&quot;
1047 # &quot;enable-oslogin&quot;
1048 # &quot;gci-ensure-gke-docker&quot;
1049 # &quot;gci-metrics-enabled&quot;
1050 # &quot;gci-update-strategy&quot;
1051 # &quot;instance-template&quot;
1052 # &quot;kube-env&quot;
1053 # &quot;startup-script&quot;
1054 # &quot;user-data&quot;
1055 # &quot;disable-address-manager&quot;
1056 # &quot;windows-startup-script-ps1&quot;
1057 # &quot;common-psm1&quot;
1058 # &quot;k8s-node-setup-psm1&quot;
1059 # &quot;install-ssh-psm1&quot;
1060 # &quot;user-profile-psm1&quot;
1061 # &quot;serial-port-logging-enable&quot;
1062 # Values are free-form strings, and only have meaning as interpreted by
1063 # the image running in the instance. The only restriction placed on them is
1064 # that each value&#x27;s size must be less than or equal to 32 KB.
1065 #
1066 # The total size of all keys and values must be less than 512 KB.
1067 &quot;a_key&quot;: &quot;A String&quot;,
1068 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001069 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine
1070 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
1071 # `n1-standard-1`).
1072 #
1073 # If unspecified, the default machine type is
1074 # `n1-standard-1`.
1075 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this
1076 # pool to run on the specified node group. This is useful for running
1077 # workloads on [sole tenant
1078 # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
1079 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
1080 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
1081 #
1082 # Secure Boot helps ensure that the system only runs authentic software by
1083 # verifying the digital signature of all boot components, and halting the
1084 # boot process if signature verification fails.
1085 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
1086 #
1087 # Enables monitoring and attestation of the boot integrity of the instance.
1088 # The attestation is performed against the integrity policy baseline. This
1089 # baseline is initially derived from the implicitly trusted boot image when
1090 # the instance is created.
Bu Sun Kim65020912020-05-20 12:08:20 -07001091 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001092 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
Dan O'Mearadd494642020-05-01 07:42:23 -07001093 # Specify the email address of the Service Account; otherwise, if no Service
Bu Sun Kim65020912020-05-20 12:08:20 -07001094 # Account is specified, the &quot;default&quot; service account is used.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001095 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
1096 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running
1097 # on the nodes.
1098 #
1099 # The following parameters are supported.
1100 #
1101 # net.core.netdev_max_backlog
1102 # net.core.rmem_max
1103 # net.core.wmem_default
1104 # net.core.wmem_max
1105 # net.core.optmem_max
1106 # net.core.somaxconn
1107 # net.ipv4.tcp_rmem
1108 # net.ipv4.tcp_wmem
1109 # net.ipv4.tcp_tw_reuse
1110 &quot;a_key&quot;: &quot;A String&quot;,
1111 },
1112 },
1113 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1114 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
1115 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
1116 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001117 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001118 #
1119 # For more information, including usage and the valid values, see:
1120 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1121 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
1122 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
1123 #
Bu Sun Kim65020912020-05-20 12:08:20 -07001124 # See
1125 # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)
1126 # for more information, including usage and the valid values.
Bu Sun Kim65020912020-05-20 12:08:20 -07001127 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001128 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001129 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001130 },
1131 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001132 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
1133 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;.
1134 #
1135 # The string must be a sequence of decimal numbers, each with optional
1136 # fraction and a unit suffix, such as &quot;300ms&quot;.
1137 # Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.
1138 # The value must be a positive duration.
1139 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.
1140 #
1141 # If this option is enabled, kubelet uses CFS quota
1142 # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
1143 # enforce container CPU limits. Otherwise, CPU limits will not be enforced at
1144 # all.
1145 #
1146 # Disable this option to mitigate CPU throttling problems while still having
1147 # your pods to be in Guaranteed QoS class by specifying the CPU limits.
1148 #
1149 # The default value is &#x27;true&#x27; if unspecified.
1150 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node.
1151 # See
1152 # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
1153 #
1154 # The following values are allowed.
1155 # - &quot;none&quot;: the default, which represents the existing scheduling behavior.
1156 # - &quot;static&quot;: allows pods with certain resource characteristics to be
1157 # granted increased CPU affinity and exclusivity on the node.
1158 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001159 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
1160 # These will added in addition to any default label(s) that
1161 # Kubernetes may apply to the node.
1162 # In case of conflict in label keys, the applied set may differ depending on
1163 # the Kubernetes version -- it&#x27;s best to assume the behavior is undefined
1164 # and conflicts should be avoided.
1165 # For more information, including usage and the valid values, see:
1166 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1167 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001168 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001169 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001170 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001171 # If unspecified, the default disk type is &#x27;pd-standard&#x27;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001172 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
1173 # workloads on the node pool.
1174 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the
1175 # workloads running on the node.
1176 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running
1177 # on the node pool.
1178 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001179 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, #
1180 # The Customer Managed Encryption Key used to encrypt the boot disk attached
1181 # to each node in the node pool. This should be of the form
1182 # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
1183 # For more information about protecting resources with Cloud KMS Keys please
1184 # see:
1185 # https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001186 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB.
1187 # The smallest allowed disk size is 10GB.
1188 #
1189 # If unspecified, the default disk size is 100GB.
1190 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
1191 # the specified [Zonal Compute
1192 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
1193 # to this node pool.
1194 # is the configuration of desired reservation which instances could take
1195 # capacity from.
1196 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
1197 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a
1198 # SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as
1199 # the key and specify the name of your reservation as its value.
1200 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
1201 &quot;A String&quot;,
1202 ],
1203 },
1204 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See:
1205 # https://cloud.google.com/compute/docs/instances/preemptible for more
1206 # inforamtion about preemptible VM instances.
1207 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be
1208 # scheduled on the specified or newer CPU platform. Applicable values are the
1209 # friendly names of CPU platforms, such as
1210 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
1211 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
1212 # information, read [how to specify min CPU
1213 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1214 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify
1215 # valid sources or targets for network firewalls and are specified by
1216 # the client during cluster or node pool creation. Each tag within the list
1217 # must comply with RFC1035.
1218 &quot;A String&quot;,
1219 ],
1220 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node.
1221 # See https://cloud.google.com/compute/docs/gpus for more information about
1222 # support for GPUs.
1223 { # AcceleratorConfig represents a Hardware Accelerator request.
1224 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
1225 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators
1226 # [here](https://cloud.google.com/compute/docs/gpus)
1227 },
1228 ],
1229 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node.
1230 #
1231 # The limit for this value is dependent upon the maximum number of
1232 # disks available on a machine per zone. See:
1233 # https://cloud.google.com/compute/docs/disks/local-ssd
1234 # for more information.
1235 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type,
1236 # the latest version of it will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001237 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001238 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -07001239 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
1240 # node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -07001241 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001242 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
Bu Sun Kim65020912020-05-20 12:08:20 -07001243 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1244 # the Auto Upgrades will proceed.
1245 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
1246 # with the description of the upgrade.
1247 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
1248 # with the approximate start time for the upgrades, in
1249 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1250 },
1251 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001252 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
1253 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
1254 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
1255 # simultaneously on a node in the node pool.
1256 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
1257 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001258 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this
1259 # node pool instance, if available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001260 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
1261 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
1262 { # StatusCondition describes why a cluster or a node pool has a certain status
1263 # (e.g., ERROR or DEGRADED).
1264 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1265 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1266 },
1267 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001268 &quot;locations&quot;: [ # The list of Google Compute Engine
1269 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1270 # NodePool&#x27;s nodes should be located.
1271 &quot;A String&quot;,
1272 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001273 },
1274 ],
1275 }</pre>
1276</div>
1277
1278<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001279 <code class="details" id="rollback">rollback(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001280 <pre>Rolls back a previously Aborted or Failed NodePool upgrade.
1281This makes no changes if the last upgrade successfully completed.
1282
1283Args:
1284 name: string, The name (project, location, cluster, node pool id) of the node poll to
1285rollback upgrade.
Bu Sun Kim65020912020-05-20 12:08:20 -07001286Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001287 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001288 The object takes the form of:
1289
1290{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed
1291 # NodePool upgrade. This will be an no-op if the last upgrade successfully
1292 # completed.
Bu Sun Kim65020912020-05-20 12:08:20 -07001293 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -07001294 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1295 # cluster resides. This field has been deprecated and replaced by the name
1296 # field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001297 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node poll to
1298 # rollback upgrade.
1299 # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
1300 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to rollback.
1301 # This field has been deprecated and replaced by the name field.
1302 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
1303 # number](https://support.google.com/cloud/answer/6158840).
1304 # This field has been deprecated and replaced by the name field.
1305 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to rollback.
1306 # This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001307 }
1308
1309 x__xgafv: string, V1 error format.
1310 Allowed values
1311 1 - v1 error format
1312 2 - v2 error format
1313
1314Returns:
1315 An object of the form:
1316
1317 { # This operation resource represents operations that may have happened or are
1318 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001319 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001320 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -07001321 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001322 &quot;stages&quot;: [ # Substages of an operation or a stage.
1323 # Object with schema name: OperationProgress
1324 ],
1325 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
1326 # Unset for single-stage operations.
1327 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
1328 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -07001329 &quot;metrics&quot;: [ # Progress metric bundle, for example:
1330 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
1331 # {name: &quot;nodes total&quot;, int_value: 32}]
1332 # or
1333 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
1334 # {name: &quot;progress scale&quot;, double_value: 1.0}]
1335 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -07001336 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001337 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001338 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1339 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001340 },
1341 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001342 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001343 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1344 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
1345 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1346 # or
1347 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1348 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001349 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
1350 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1351 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001352 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
1353 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -07001354 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001355 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1356 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1357 { # StatusCondition describes why a cluster or a node pool has a certain status
1358 # (e.g., ERROR or DEGRADED).
1359 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1360 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1361 },
1362 ],
1363 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
1364 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1365 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1366 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1367 { # StatusCondition describes why a cluster or a node pool has a certain status
1368 # (e.g., ERROR or DEGRADED).
1369 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1370 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1371 },
1372 ],
1373 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001374 }</pre>
1375</div>
1376
1377<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001378 <code class="details" id="setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001379 <pre>Sets the autoscaling settings of a specific node pool.
1380
1381Args:
1382 name: string, The name (project, location, cluster, node pool) of the node pool to set
1383autoscaler settings. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -07001384`projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001385 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001386 The object takes the form of:
1387
1388{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -07001389 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to # Required. Autoscaling configuration for the node pool.
1390 # adjust the size of the node pool to the current cluster usage.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001391 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
1392 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
1393 # max_node_count.
1394 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001395 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
1396 # has to enough quota to scale up the cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -07001397 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001398 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
1399 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1400 # cluster resides. This field has been deprecated and replaced by the name
1401 # field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001402 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
1403 # number](https://support.google.com/cloud/answer/6158840).
1404 # This field has been deprecated and replaced by the name field.
1405 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to upgrade.
1406 # This field has been deprecated and replaced by the name field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001407 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool) of the node pool to set
1408 # autoscaler settings. Specified in the format
1409 # `projects/*/locations/*/clusters/*/nodePools/*`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001410 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to upgrade.
1411 # This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001412 }
1413
1414 x__xgafv: string, V1 error format.
1415 Allowed values
1416 1 - v1 error format
1417 2 - v2 error format
1418
1419Returns:
1420 An object of the form:
1421
1422 { # This operation resource represents operations that may have happened or are
1423 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001424 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001425 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -07001426 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001427 &quot;stages&quot;: [ # Substages of an operation or a stage.
1428 # Object with schema name: OperationProgress
1429 ],
1430 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
1431 # Unset for single-stage operations.
1432 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
1433 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -07001434 &quot;metrics&quot;: [ # Progress metric bundle, for example:
1435 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
1436 # {name: &quot;nodes total&quot;, int_value: 32}]
1437 # or
1438 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
1439 # {name: &quot;progress scale&quot;, double_value: 1.0}]
1440 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -07001441 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001442 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001443 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1444 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001445 },
1446 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001447 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001448 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1449 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
1450 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1451 # or
1452 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1453 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001454 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
1455 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1456 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001457 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
1458 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -07001459 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001460 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1461 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1462 { # StatusCondition describes why a cluster or a node pool has a certain status
1463 # (e.g., ERROR or DEGRADED).
1464 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1465 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1466 },
1467 ],
1468 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
1469 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1470 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1471 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1472 { # StatusCondition describes why a cluster or a node pool has a certain status
1473 # (e.g., ERROR or DEGRADED).
1474 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1475 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1476 },
1477 ],
1478 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001479 }</pre>
1480</div>
1481
1482<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001483 <code class="details" id="setManagement">setManagement(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001484 <pre>Sets the NodeManagement options for a node pool.
1485
1486Args:
1487 name: string, The name (project, location, cluster, node pool id) of the node pool to set
1488management properties. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -07001489`projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001490 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001491 The object takes the form of:
1492
1493{ # SetNodePoolManagementRequest sets the node management properties of a node
1494 # pool.
Bu Sun Kim65020912020-05-20 12:08:20 -07001495 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001496 # number](https://support.google.com/cloud/answer/6158840).
1497 # This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001498 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the # Required. NodeManagement configuration for the node pool.
1499 # node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -07001500 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001501 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
Bu Sun Kim65020912020-05-20 12:08:20 -07001502 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1503 # the Auto Upgrades will proceed.
1504 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
1505 # with the description of the upgrade.
1506 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence
1507 # with the approximate start time for the upgrades, in
1508 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1509 },
1510 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001511 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
1512 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1513 # cluster resides. This field has been deprecated and replaced by the name
1514 # field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001515 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to update.
1516 # This field has been deprecated and replaced by the name field.
1517 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node pool to set
1518 # management properties. Specified in the format
1519 # `projects/*/locations/*/clusters/*/nodePools/*`.
1520 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to update.
1521 # This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001522 }
1523
1524 x__xgafv: string, V1 error format.
1525 Allowed values
1526 1 - v1 error format
1527 2 - v2 error format
1528
1529Returns:
1530 An object of the form:
1531
1532 { # This operation resource represents operations that may have happened or are
1533 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001534 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001535 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -07001536 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001537 &quot;stages&quot;: [ # Substages of an operation or a stage.
1538 # Object with schema name: OperationProgress
1539 ],
1540 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
1541 # Unset for single-stage operations.
1542 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
1543 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -07001544 &quot;metrics&quot;: [ # Progress metric bundle, for example:
1545 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
1546 # {name: &quot;nodes total&quot;, int_value: 32}]
1547 # or
1548 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
1549 # {name: &quot;progress scale&quot;, double_value: 1.0}]
1550 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -07001551 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001552 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001553 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1554 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001555 },
1556 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001557 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001558 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1559 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
1560 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1561 # or
1562 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1563 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001564 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
1565 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1566 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001567 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
1568 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -07001569 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001570 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1571 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1572 { # StatusCondition describes why a cluster or a node pool has a certain status
1573 # (e.g., ERROR or DEGRADED).
1574 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1575 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1576 },
1577 ],
1578 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
1579 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1580 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1581 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1582 { # StatusCondition describes why a cluster or a node pool has a certain status
1583 # (e.g., ERROR or DEGRADED).
1584 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1585 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1586 },
1587 ],
1588 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001589 }</pre>
1590</div>
1591
1592<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001593 <code class="details" id="setSize">setSize(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001594 <pre>Sets the size for a specific node pool.
1595
1596Args:
1597 name: string, The name (project, location, cluster, node pool id) of the node pool to set
1598size.
Bu Sun Kim65020912020-05-20 12:08:20 -07001599Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001600 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001601 The object takes the form of:
1602
1603{ # SetNodePoolSizeRequest sets the size a node
1604 # pool.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001605 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node pool to set
1606 # size.
1607 # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
1608 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to update.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001609 # This field has been deprecated and replaced by the name field.
1610 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to update.
1611 # This field has been deprecated and replaced by the name field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001612 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
1613 # number](https://support.google.com/cloud/answer/6158840).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001614 # This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001615 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -07001616 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1617 # cluster resides. This field has been deprecated and replaced by the name
1618 # field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001619 &quot;nodeCount&quot;: 42, # Required. The desired node count for the pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001620 }
1621
1622 x__xgafv: string, V1 error format.
1623 Allowed values
1624 1 - v1 error format
1625 2 - v2 error format
1626
1627Returns:
1628 An object of the form:
1629
1630 { # This operation resource represents operations that may have happened or are
1631 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001632 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001633 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -07001634 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001635 &quot;stages&quot;: [ # Substages of an operation or a stage.
1636 # Object with schema name: OperationProgress
1637 ],
1638 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
1639 # Unset for single-stage operations.
1640 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
1641 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -07001642 &quot;metrics&quot;: [ # Progress metric bundle, for example:
1643 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
1644 # {name: &quot;nodes total&quot;, int_value: 32}]
1645 # or
1646 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
1647 # {name: &quot;progress scale&quot;, double_value: 1.0}]
1648 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -07001649 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001650 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001651 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1652 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001653 },
1654 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001655 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001656 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1657 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
1658 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1659 # or
1660 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1661 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001662 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
1663 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1664 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001665 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
1666 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -07001667 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001668 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1669 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1670 { # StatusCondition describes why a cluster or a node pool has a certain status
1671 # (e.g., ERROR or DEGRADED).
1672 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1673 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1674 },
1675 ],
1676 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
1677 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1678 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1679 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1680 { # StatusCondition describes why a cluster or a node pool has a certain status
1681 # (e.g., ERROR or DEGRADED).
1682 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1683 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1684 },
1685 ],
1686 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001687 }</pre>
1688</div>
1689
1690<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001691 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001692 <pre>Updates the version and/or image type of a specific node pool.
1693
1694Args:
1695 name: string, The name (project, location, cluster, node pool) of the node pool to
1696update. Specified in the format
Bu Sun Kim65020912020-05-20 12:08:20 -07001697`projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001698 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001699 The object takes the form of:
1700
1701{ # SetNodePoolVersionRequest updates the version of a node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -07001702 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001703 # number](https://support.google.com/cloud/answer/6158840).
1704 # This field has been deprecated and replaced by the name field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001705 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
Dan O'Mearadd494642020-05-01 07:42:23 -07001706 # disruption caused by an upgrade.
1707 #
1708 # maxUnavailable controls the number of nodes that can be simultaneously
1709 # unavailable.
1710 #
1711 # maxSurge controls the number of additional nodes that can be added to the
1712 # node pool temporarily for the time of the upgrade to increase the number of
1713 # available nodes.
1714 #
1715 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
1716 # nodes are being upgraded at the same time).
1717 #
1718 # Note: upgrades inevitably introduce some disruption since workloads need to
1719 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
1720 # this holds true. (Disruption stays within the limits of
1721 # PodDisruptionBudget, if it is configured.)
1722 #
1723 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
1724 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
1725 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
1726 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
1727 # there are always at least 4 nodes available.
Bu Sun Kim65020912020-05-20 12:08:20 -07001728 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during
Dan O'Mearadd494642020-05-01 07:42:23 -07001729 # the upgrade process. A node is considered available if its status is
1730 # Ready.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001731 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size
1732 # of the node pool during the upgrade process.
Dan O'Mearadd494642020-05-01 07:42:23 -07001733 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001734 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to upgrade.
1735 # This field has been deprecated and replaced by the name field.
1736 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to upgrade.
1737 # This field has been deprecated and replaced by the name field.
1738 &quot;nodeVersion&quot;: &quot;A String&quot;, # Required. The Kubernetes version to change the nodes to (typically an
1739 # upgrade).
1740 #
1741 # Users may specify either explicit versions offered by Kubernetes Engine or
1742 # version aliases, which have the following behavior:
1743 #
1744 # - &quot;latest&quot;: picks the highest valid Kubernetes version
1745 # - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version
1746 # - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version
1747 # - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version
1748 # - &quot;-&quot;: picks the Kubernetes master version
1749 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine
1750 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1751 # cluster resides. This field has been deprecated and replaced by the name
1752 # field.
Bu Sun Kim65020912020-05-20 12:08:20 -07001753 &quot;locations&quot;: [ # The desired list of Google Compute Engine
1754 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1755 # node pool&#x27;s nodes should be located. Changing the locations for a node pool
1756 # will result in nodes being either created or removed from the node pool,
1757 # depending on whether locations are being added or removed.
1758 &quot;A String&quot;,
1759 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001760 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
1761 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;.
1762 #
1763 # The string must be a sequence of decimal numbers, each with optional
1764 # fraction and a unit suffix, such as &quot;300ms&quot;.
1765 # Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.
1766 # The value must be a positive duration.
1767 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits.
1768 #
1769 # If this option is enabled, kubelet uses CFS quota
1770 # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
1771 # enforce container CPU limits. Otherwise, CPU limits will not be enforced at
1772 # all.
1773 #
1774 # Disable this option to mitigate CPU throttling problems while still having
1775 # your pods to be in Guaranteed QoS class by specifying the CPU limits.
1776 #
1777 # The default value is &#x27;true&#x27; if unspecified.
1778 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node.
1779 # See
1780 # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
1781 #
1782 # The following values are allowed.
1783 # - &quot;none&quot;: the default, which represents the existing scheduling behavior.
1784 # - &quot;static&quot;: allows pods with certain resource characteristics to be
1785 # granted increased CPU affinity and exclusivity on the node.
1786 },
1787 &quot;imageType&quot;: &quot;A String&quot;, # Required. The desired image type for the node pool.
1788 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired workload metadata config for the node pool.
1789 # workloads on the node pool.
1790 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the
1791 # workloads running on the node.
1792 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running
1793 # on the node pool.
1794 },
1795 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
1796 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running
1797 # on the nodes.
1798 #
1799 # The following parameters are supported.
1800 #
1801 # net.core.netdev_max_backlog
1802 # net.core.rmem_max
1803 # net.core.wmem_default
1804 # net.core.wmem_max
1805 # net.core.optmem_max
1806 # net.core.somaxconn
1807 # net.ipv4.tcp_rmem
1808 # net.ipv4.tcp_wmem
1809 # net.ipv4.tcp_tw_reuse
1810 &quot;a_key&quot;: &quot;A String&quot;,
1811 },
1812 },
1813 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool) of the node pool to
1814 # update. Specified in the format
1815 # `projects/*/locations/*/clusters/*/nodePools/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001816 }
1817
1818 x__xgafv: string, V1 error format.
1819 Allowed values
1820 1 - v1 error format
1821 2 - v2 error format
1822
1823Returns:
1824 An object of the form:
1825
1826 { # This operation resource represents operations that may have happened or are
1827 # happening on the cluster. All fields are output only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001828 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001829 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
Bu Sun Kim65020912020-05-20 12:08:20 -07001830 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001831 &quot;stages&quot;: [ # Substages of an operation or a stage.
1832 # Object with schema name: OperationProgress
1833 ],
1834 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage.
1835 # Unset for single-stage operations.
1836 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage.
1837 # Unset for single-stage operations.
Bu Sun Kim65020912020-05-20 12:08:20 -07001838 &quot;metrics&quot;: [ # Progress metric bundle, for example:
1839 # metrics: [{name: &quot;nodes done&quot;, int_value: 15},
1840 # {name: &quot;nodes total&quot;, int_value: 32}]
1841 # or
1842 # metrics: [{name: &quot;progress&quot;, double_value: 0.56},
1843 # {name: &quot;progress scale&quot;, double_value: 1.0}]
1844 { # Progress metric is (string, int|float|string) pair.
Bu Sun Kim65020912020-05-20 12:08:20 -07001845 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001846 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001847 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1848 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
Bu Sun Kim65020912020-05-20 12:08:20 -07001849 },
1850 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001851 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001852 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1853 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine
1854 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1855 # or
1856 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1857 # in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001858 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
1859 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1860 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001861 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in
1862 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Bu Sun Kim65020912020-05-20 12:08:20 -07001863 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001864 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1865 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1866 { # StatusCondition describes why a cluster or a node pool has a certain status
1867 # (e.g., ERROR or DEGRADED).
1868 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1869 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1870 },
1871 ],
1872 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in
1873 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1874 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1875 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1876 { # StatusCondition describes why a cluster or a node pool has a certain status
1877 # (e.g., ERROR or DEGRADED).
1878 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1879 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1880 },
1881 ],
1882 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001883 }</pre>
1884</div>
1885
1886</body></html>