blob: 3c36a5723c8902963b79a1727fe43d1fd0be79c8 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Creates a node pool for a cluster.</p>
83<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080084 <code><a href="#delete">delete(name, nodePoolId=None, clusterId=None, projectId=None, zone=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Deletes a node pool from a cluster.</p>
86<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080087 <code><a href="#get">get(name, projectId=None, zone=None, clusterId=None, nodePoolId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Retrieves the requested node pool.</p>
89<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080090 <code><a href="#list">list(parent, zone=None, projectId=None, clusterId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Lists the node pools for a cluster.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#rollback">rollback(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Sets the autoscaling settings of a specific node pool.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#setManagement">setManagement(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Sets the NodeManagement options for a node pool.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#setSize">setSize(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Sets the size for a specific node pool.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="firstline">Updates the version and/or image type of a specific node pool.</p>
107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115 <pre>Creates a node pool for a cluster.
116
117Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700118 parent: string, The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700119 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 The object takes the form of:
121
122{ # CreateNodePoolRequest creates a node pool for a cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800123 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800124 &quot;parent&quot;: &quot;A String&quot;, # The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800125 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700126 &quot;nodePool&quot;: { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800127 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800128 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
129 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
130 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800132 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800133 },
134 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800135 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
136 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
137 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
138 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
139 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
140 },
141 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
142 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
143 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
144 },
145 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
146 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
147 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800148 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700149 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
150 &quot;A String&quot;,
151 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800152 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700153 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
154 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
155 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
156 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
157 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
158 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700160 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800161 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
162 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
163 &quot;ephemeralStorageConfig&quot;: { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
164 &quot;localSsdCount&quot;: 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.
165 },
166 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
167 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
168 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
169 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
170 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
171 },
172 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
173 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
174 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
175 },
176 &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;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
177 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
178 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
179 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
180 &quot;a_key&quot;: &quot;A String&quot;,
181 },
182 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
183 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
184 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
185 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
186 },
187 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-oslogin&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
188 &quot;a_key&quot;: &quot;A String&quot;,
189 },
190 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
191 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
192 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - &quot;none&quot;: the default, which represents the existing scheduling behavior. - &quot;static&quot;: allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is &#x27;none&#x27; if unspecified.
193 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as &quot;300ms&quot;. 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;. The value must be a positive duration.
194 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is &#x27;true&#x27; if unspecified.
195 },
196 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
197 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
198 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
199 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
200 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
201 },
202 ],
203 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
204 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
205 &quot;a_key&quot;: &quot;A String&quot;,
206 },
207 },
208 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
209 &quot;A String&quot;,
210 ],
211 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.
212 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
213 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
214 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
215 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
216 &quot;A String&quot;,
217 ],
218 },
219 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
220 &quot;A String&quot;,
221 ],
222 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
223 { # AcceleratorConfig represents a Hardware Accelerator request.
224 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
225 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
226 },
227 ],
228 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
229 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700230 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800231 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
232 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
233 &quot;A String&quot;,
234 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800235 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800236 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700237 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800238 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239 }
240
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246Returns:
247 An object of the form:
248
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800250 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800251 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800252 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
253 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
254 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800255 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800256 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800257 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700258 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800259 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800260 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800261 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
262 { # Progress metric is (string, int|float|string) pair.
263 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800264 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
265 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800266 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800267 },
268 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800269 &quot;stages&quot;: [ # Substages of an operation or a stage.
270 # Object with schema name: OperationProgress
271 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700272 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700273 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700274 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700275 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
276 {
277 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
278 },
279 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800280 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700281 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800282 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
283 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
284 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
285 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
286 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
287 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
288 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
289 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
290 },
291 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800292 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
293 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
294 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800295 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800296 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800297 },
298 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 }</pre>
300</div>
301
302<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800303 <code class="details" id="delete">delete(name, nodePoolId=None, clusterId=None, projectId=None, zone=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304 <pre>Deletes a node pool from a cluster.
305
306Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700307 name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700308 nodePoolId: string, Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800309 clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800310 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800311 zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317Returns:
318 An object of the form:
319
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700320 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800321 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800322 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800323 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
324 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
325 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800326 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800327 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800328 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700329 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800330 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800331 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800332 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
333 { # Progress metric is (string, int|float|string) pair.
334 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800335 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
336 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800337 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800338 },
339 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800340 &quot;stages&quot;: [ # Substages of an operation or a stage.
341 # Object with schema name: OperationProgress
342 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700344 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700345 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700346 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
347 {
348 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
349 },
350 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800351 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700352 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800353 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
354 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
355 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
356 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
357 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
358 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
359 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
360 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
361 },
362 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800363 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
364 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
365 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800366 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800367 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800368 },
369 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 }</pre>
371</div>
372
373<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800374 <code class="details" id="get">get(name, projectId=None, zone=None, clusterId=None, nodePoolId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 <pre>Retrieves the requested node pool.
376
377Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700378 name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700379 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800380 zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
381 clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
382 nodePoolId: string, Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700383 x__xgafv: string, V1 error format.
384 Allowed values
385 1 - v1 error format
386 2 - v2 error format
387
388Returns:
389 An object of the form:
390
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700391 { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800392 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800393 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
394 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
395 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800396 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800397 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800398 },
399 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800400 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
401 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
402 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
403 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
404 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
405 },
406 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
407 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
408 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
409 },
410 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
411 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
412 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800413 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700414 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
415 &quot;A String&quot;,
416 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800417 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700418 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
419 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
420 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
421 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
422 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
423 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
424 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700425 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800426 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
427 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
428 &quot;ephemeralStorageConfig&quot;: { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
429 &quot;localSsdCount&quot;: 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.
430 },
431 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
432 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
433 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
434 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
435 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
436 },
437 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
438 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
439 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
440 },
441 &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;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
442 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
443 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
444 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
445 &quot;a_key&quot;: &quot;A String&quot;,
446 },
447 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
448 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
449 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
450 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
451 },
452 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-oslogin&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
453 &quot;a_key&quot;: &quot;A String&quot;,
454 },
455 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
456 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
457 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - &quot;none&quot;: the default, which represents the existing scheduling behavior. - &quot;static&quot;: allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is &#x27;none&#x27; if unspecified.
458 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as &quot;300ms&quot;. 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;. The value must be a positive duration.
459 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is &#x27;true&#x27; if unspecified.
460 },
461 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
462 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
463 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
464 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
465 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
466 },
467 ],
468 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
469 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
470 &quot;a_key&quot;: &quot;A String&quot;,
471 },
472 },
473 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
474 &quot;A String&quot;,
475 ],
476 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.
477 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
478 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
479 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
480 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
481 &quot;A String&quot;,
482 ],
483 },
484 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
485 &quot;A String&quot;,
486 ],
487 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
488 { # AcceleratorConfig represents a Hardware Accelerator request.
489 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
490 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
491 },
492 ],
493 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
494 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700495 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800496 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
497 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
498 &quot;A String&quot;,
499 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800500 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800501 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700502 }</pre>
503</div>
504
505<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800506 <code class="details" id="list">list(parent, zone=None, projectId=None, clusterId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507 <pre>Lists the node pools for a cluster.
508
509Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700510 parent: string, The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700511 zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800512 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.
513 clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700514 x__xgafv: string, V1 error format.
515 Allowed values
516 1 - v1 error format
517 2 - v2 error format
518
519Returns:
520 An object of the form:
521
522 { # ListNodePoolsResponse is the result of ListNodePoolsRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700523 &quot;nodePools&quot;: [ # A list of node pools for a cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700524 { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800525 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800526 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
527 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
528 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800529 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800530 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800531 },
532 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800533 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
534 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
535 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
536 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
537 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
538 },
539 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
540 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
541 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
542 },
543 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
544 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
545 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800546 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700547 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
548 &quot;A String&quot;,
549 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800550 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700551 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
552 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
553 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
554 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
555 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
556 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
557 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700558 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800559 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
560 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
561 &quot;ephemeralStorageConfig&quot;: { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
562 &quot;localSsdCount&quot;: 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.
563 },
564 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
565 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
566 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
567 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
568 &quot;sandboxType&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node (e.g. &#x27;gvisor&#x27;)
569 },
570 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
571 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
572 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
573 },
574 &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;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
575 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
576 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
577 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
578 &quot;a_key&quot;: &quot;A String&quot;,
579 },
580 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
581 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
582 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
583 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
584 },
585 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-oslogin&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
586 &quot;a_key&quot;: &quot;A String&quot;,
587 },
588 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
589 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
590 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - &quot;none&quot;: the default, which represents the existing scheduling behavior. - &quot;static&quot;: allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is &#x27;none&#x27; if unspecified.
591 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as &quot;300ms&quot;. 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;. The value must be a positive duration.
592 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is &#x27;true&#x27; if unspecified.
593 },
594 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
595 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
596 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
597 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
598 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
599 },
600 ],
601 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
602 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
603 &quot;a_key&quot;: &quot;A String&quot;,
604 },
605 },
606 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
607 &quot;A String&quot;,
608 ],
609 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.
610 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
611 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
612 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
613 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
614 &quot;A String&quot;,
615 ],
616 },
617 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
618 &quot;A String&quot;,
619 ],
620 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
621 { # AcceleratorConfig represents a Hardware Accelerator request.
622 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
623 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
624 },
625 ],
626 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
627 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700628 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800629 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
630 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
631 &quot;A String&quot;,
632 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800633 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800634 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700635 },
636 ],
637 }</pre>
638</div>
639
640<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700641 <code class="details" id="rollback">rollback(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700642 <pre>Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700643
644Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700645 name: string, The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700646 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700647 The object takes the form of:
648
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700649{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800650 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
651 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800652 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
653 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
654 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700655 }
656
657 x__xgafv: string, V1 error format.
658 Allowed values
659 1 - v1 error format
660 2 - v2 error format
661
662Returns:
663 An object of the form:
664
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700665 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800666 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800667 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800668 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
669 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
670 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800671 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800672 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800673 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700674 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800675 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800676 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800677 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
678 { # Progress metric is (string, int|float|string) pair.
679 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800680 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
681 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800682 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800683 },
684 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800685 &quot;stages&quot;: [ # Substages of an operation or a stage.
686 # Object with schema name: OperationProgress
687 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700688 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700689 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700690 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700691 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
692 {
693 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
694 },
695 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800696 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700697 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800698 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
699 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
700 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
701 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
702 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
703 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
704 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
705 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
706 },
707 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800708 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
709 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
710 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800711 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800712 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800713 },
714 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700715 }</pre>
716</div>
717
718<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700719 <code class="details" id="setAutoscaling">setAutoscaling(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700720 <pre>Sets the autoscaling settings of a specific node pool.
721
722Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700723 name: string, The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700724 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700725 The object takes the form of:
726
727{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800728 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800729 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
730 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800731 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
732 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800733 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800734 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
735 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
736 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800737 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800738 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700739 }
740
741 x__xgafv: string, V1 error format.
742 Allowed values
743 1 - v1 error format
744 2 - v2 error format
745
746Returns:
747 An object of the form:
748
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700749 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800750 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800751 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800752 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
753 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
754 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800755 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800756 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800757 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700758 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800759 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800760 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800761 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
762 { # Progress metric is (string, int|float|string) pair.
763 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800764 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
765 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800766 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800767 },
768 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800769 &quot;stages&quot;: [ # Substages of an operation or a stage.
770 # Object with schema name: OperationProgress
771 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700772 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700773 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700774 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700775 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
776 {
777 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
778 },
779 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800780 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700781 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800782 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
783 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
784 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
785 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
786 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
787 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
788 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
789 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
790 },
791 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800792 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
793 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
794 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800795 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800796 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800797 },
798 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700799 }</pre>
800</div>
801
802<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700803 <code class="details" id="setManagement">setManagement(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700804 <pre>Sets the NodeManagement options for a node pool.
805
806Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700807 name: string, The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700808 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700809 The object takes the form of:
810
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700811{ # SetNodePoolManagementRequest sets the node management properties of a node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700812 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800813 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
814 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800815 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800816 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700817 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # Required. NodeManagement configuration for the node pool.
Bu Sun Kim65020912020-05-20 12:08:20 -0700818 &quot;autoRepair&quot;: True or False, # Whether the nodes will be automatically repaired.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700819 &quot;autoUpgrade&quot;: True or False, # Whether the nodes will be automatically upgraded.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700820 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
821 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
822 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
823 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700824 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700825 }
826
827 x__xgafv: string, V1 error format.
828 Allowed values
829 1 - v1 error format
830 2 - v2 error format
831
832Returns:
833 An object of the form:
834
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700835 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800836 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800837 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800838 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
839 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
840 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800841 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800842 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800843 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700844 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800845 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800846 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800847 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
848 { # Progress metric is (string, int|float|string) pair.
849 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800850 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
851 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800852 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800853 },
854 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800855 &quot;stages&quot;: [ # Substages of an operation or a stage.
856 # Object with schema name: OperationProgress
857 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700858 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700859 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700860 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700861 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
862 {
863 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
864 },
865 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800866 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700867 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800868 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
869 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
870 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
871 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
872 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
873 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
874 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
875 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
876 },
877 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800878 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
879 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
880 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800881 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800882 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800883 },
884 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700885 }</pre>
886</div>
887
888<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700889 <code class="details" id="setSize">setSize(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700890 <pre>Sets the size for a specific node pool.
891
892Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700893 name: string, The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700894 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700895 The object takes the form of:
896
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700897{ # SetNodePoolSizeRequest sets the size a node pool.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800898 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800899 &quot;nodeCount&quot;: 42, # Required. The desired node count for the pool.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800900 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800901 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800902 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700903 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700904 }
905
906 x__xgafv: string, V1 error format.
907 Allowed values
908 1 - v1 error format
909 2 - v2 error format
910
911Returns:
912 An object of the form:
913
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700914 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800915 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800916 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800917 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
918 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
919 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800920 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800921 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800922 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700923 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800924 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800925 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800926 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
927 { # Progress metric is (string, int|float|string) pair.
928 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800929 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
930 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800931 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800932 },
933 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800934 &quot;stages&quot;: [ # Substages of an operation or a stage.
935 # Object with schema name: OperationProgress
936 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700937 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700938 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700939 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700940 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
941 {
942 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
943 },
944 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800945 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700946 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800947 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
948 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
949 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
950 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
951 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
952 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
953 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
954 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
955 },
956 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800957 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
958 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
959 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800960 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800961 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800962 },
963 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700964 }</pre>
965</div>
966
967<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700968 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700969 <pre>Updates the version and/or image type of a specific node pool.
970
971Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700972 name: string, The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700973 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700974 The object takes the form of:
975
976{ # SetNodePoolVersionRequest updates the version of a node pool.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800977 &quot;nodeVersion&quot;: &quot;A String&quot;, # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;-&quot;: picks the Kubernetes master version
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800978 &quot;projectId&quot;: &quot;A String&quot;, # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800979 &quot;zone&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800980 &quot;clusterId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700981 &quot;linuxNodeConfig&quot;: { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700982 &quot;sysctls&quot;: { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700983 &quot;a_key&quot;: &quot;A String&quot;,
984 },
985 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800986 &quot;kubeletConfig&quot;: { # Node kubelet configs. # Node kubelet configs.
987 &quot;cpuManagerPolicy&quot;: &quot;A String&quot;, # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. - &quot;none&quot;: the default, which represents the existing scheduling behavior. - &quot;static&quot;: allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is &#x27;none&#x27; if unspecified.
988 &quot;cpuCfsQuotaPeriod&quot;: &quot;A String&quot;, # Set the CPU CFS quota period value &#x27;cpu.cfs_period_us&#x27;. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as &quot;300ms&quot;. 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;. The value must be a positive duration.
989 &quot;cpuCfsQuota&quot;: True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is &#x27;true&#x27; if unspecified.
990 },
991 &quot;nodePoolId&quot;: &quot;A String&quot;, # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
992 &quot;imageType&quot;: &quot;A String&quot;, # Required. The desired image type for the node pool.
993 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
994 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool.
995 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
996 &quot;nodeMetadata&quot;: &quot;A String&quot;, # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
997 },
998 &quot;locations&quot;: [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool&#x27;s nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
999 &quot;A String&quot;,
1000 ],
1001 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
1002 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
1003 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
1004 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001005 }
1006
1007 x__xgafv: string, V1 error format.
1008 Allowed values
1009 1 - v1 error format
1010 2 - v2 error format
1011
1012Returns:
1013 An object of the form:
1014
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001015 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001016 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001017 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001018 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1019 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
1020 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001021 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001022 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001023 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
Bu Sun Kim65020912020-05-20 12:08:20 -07001024 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001025 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001026 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001027 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1028 { # Progress metric is (string, int|float|string) pair.
1029 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001030 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1031 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001032 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001033 },
1034 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001035 &quot;stages&quot;: [ # Substages of an operation or a stage.
1036 # Object with schema name: OperationProgress
1037 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001038 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001039 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001040 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001041 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1042 {
1043 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1044 },
1045 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001046 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001047 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001048 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1049 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
1050 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1051 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
1052 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1053 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
1054 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
1055 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1056 },
1057 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001058 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
1059 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1060 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001061 &quot;canonicalCode&quot;: &quot;A String&quot;, # Canonical code of the condition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -08001062 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
Yoshi Automation Botc2228be2020-11-24 15:48:03 -08001063 },
1064 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001065 }</pre>
1066</div>
1067
1068</body></html>