Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / container_v1.projects.zones.clusters.nodePools.html
blob: 092a50efa93c531e2d973027fc0d8e08bb99159a [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.clusters.html">clusters</a> . <a href="container_v1.projects.zones.clusters.nodePools.html">nodePools</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Sets the autoscaling settings for the specified node pool.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#create">create(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Creates a node pool for a cluster.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]85<p class="firstline">Deletes a node pool from a cluster.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the requested node pool.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]91<p class="firstline">Lists the node pools for a cluster.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97<p class="firstline">Sets the NodeManagement options for a node pool.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#setSize">setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Sets the size for a specific node pool.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#update">update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Updates the version and/or image type for the specified node pool.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]104<h3>Method Details</h3>
105<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 <code class="details" id="autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 <pre>Sets the autoscaling settings for the specified node pool.
108
109Args:
110 projectId: string, Deprecated. The Google Developers Console [project ID or project
111number](https://support.google.com/cloud/answer/6158840).
112This field has been deprecated and replaced by the name field. (required)
113 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114[zone](https://cloud.google.com/compute/docs/zones#available) in which the
115cluster resides. This field has been deprecated and replaced by the name
116field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 clusterId: string, Deprecated. The name of the cluster to upgrade.
118This field has been deprecated and replaced by the name field. (required)
119 nodePoolId: string, Deprecated. The name of the node pool to upgrade.
120This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 The object takes the form of:
123
124{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
125 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set
126 # autoscaler settings. Specified in the format
127 # 'projects/*/locations/*/clusters/*/nodePools/*'.
128 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
130 # cluster resides. This field has been deprecated and replaced by the name
131 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
133 # number](https://support.google.com/cloud/answer/6158840).
134 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Required. Autoscaling configuration for the node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 # adjust the size of the node pool to the current cluster usage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 # max_node_count.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 "enabled": True or False, # Is autoscaling enabled for this node pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 # has to enough quota to scale up the cluster.
143 },
144 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
145 # This field has been deprecated and replaced by the name field.
146 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.
147 # This field has been deprecated and replaced by the name field.
148 }
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155Returns:
156 An object of the form:
157
158 { # This operation resource represents operations that may have happened or are
159 # happening on the cluster. All fields are output only.
160 "status": "A String", # The current status of the operation.
161 "selfLink": "A String", # Server-defined URL for the resource.
162 "name": "A String", # The server-assigned ID for the operation.
163 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
165 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "detail": "A String", # Detailed operation progress, if available.
167 "operationType": "A String", # The operation type.
168 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 "nodepoolConditions": [ # Which conditions caused the current node pool state.
170 { # StatusCondition describes why a cluster or a node pool has a certain status
171 # (e.g., ERROR or DEGRADED).
172 "message": "A String", # Human-friendly representation of the condition
173 "code": "A String", # Machine-friendly representation of the condition
174 },
175 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "clusterConditions": [ # Which conditions caused the current cluster state.
177 { # StatusCondition describes why a cluster or a node pool has a certain status
178 # (e.g., ERROR or DEGRADED).
179 "message": "A String", # Human-friendly representation of the condition
180 "code": "A String", # Machine-friendly representation of the condition
181 },
182 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 "startTime": "A String", # [Output only] The time the operation started, in
184 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
185 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
186 "status": "A String", # Status of an operation stage.
187 # Unset for single-stage operations.
188 "metrics": [ # Progress metric bundle, for example:
189 # metrics: [{name: "nodes done", int_value: 15},
190 # {name: "nodes total", int_value: 32}]
191 # or
192 # metrics: [{name: "progress", double_value: 0.56},
193 # {name: "progress scale", double_value: 1.0}]
194 { # Progress metric is (string, int|float|string) pair.
195 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
196 "intValue": "A String", # For metrics with integer value.
197 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
198 "doubleValue": 3.14, # For metrics with floating point value.
199 },
200 ],
201 "stages": [ # Substages of an operation or a stage.
202 # Object with schema name: OperationProgress
203 ],
204 "name": "A String", # A non-parameterized string describing an operation stage.
205 # Unset for single-stage operations.
206 },
207 "endTime": "A String", # [Output only] The time the operation completed, in
208 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
209 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
210 "location": "A String", # [Output only] The name of the Google Compute Engine
211 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
212 # or
213 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
214 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 }</pre>
216</div>
217
218<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 <code class="details" id="create">create(projectId, zone, clusterId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]220 <pre>Creates a node pool for a cluster.
221
222Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 projectId: string, Deprecated. The Google Developers Console [project ID or project
224number](https://developers.google.com/console/help/new/#projectnumber).
225This field has been deprecated and replaced by the parent field. (required)
226 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227[zone](https://cloud.google.com/compute/docs/zones#available) in which the
228cluster resides. This field has been deprecated and replaced by the parent
229field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 clusterId: string, Deprecated. The name of the cluster.
231This field has been deprecated and replaced by the parent field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]233 The object takes the form of:
234
235{ # CreateNodePoolRequest creates a node pool for a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 "parent": "A String", # The parent (project, location, cluster id) where the node pool will be
237 # created. Specified in the format
238 # 'projects/*/locations/*/clusters/*'.
239 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
240 # number](https://developers.google.com/console/help/new/#projectnumber).
241 # This field has been deprecated and replaced by the parent field.
242 "clusterId": "A String", # Deprecated. The name of the cluster.
243 # This field has been deprecated and replaced by the parent field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]244 "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # Required. The node pool to create.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]245 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
246 # specification, under the control of the cluster master. They may have a set
247 # of Kubernetes labels applied to them, which may be used to reference them
248 # during pod scheduling. They may also be resized up or down, to accommodate
249 # the workload.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]250 "status": "A String", # [Output only] The status of the nodes in this pool instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]252 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
253 # node pool.
254 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
255 # pool. If enabled, the nodes in this node pool will be monitored and, if
256 # they fail health checks too many times, an automatic repair action will be
257 # triggered.
258 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
259 # the Auto Upgrades will proceed.
260 "description": "A String", # [Output only] This field is set when upgrades are about to commence
261 # with the description of the upgrade.
262 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
263 # with the approximate start time for the upgrades, in
264 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
265 },
266 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
267 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
268 # up to date with the latest release version of Kubernetes.
269 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 "name": "A String", # The name of the node pool.
271 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
272 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
273 # associated with this node pool.
274 "A String",
275 ],
276 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
277 # only if a valid configuration is present.
278 # adjust the size of the node pool to the current cluster usage.
279 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
280 # max_node_count.
281 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
282 "enabled": True or False, # Is autoscaling enabled for this node pool.
283 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
284 # has to enough quota to scale up the cluster.
285 },
286 "locations": [ # The list of Google Compute Engine
287 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
288 # NodePool's nodes should be located.
289 "A String",
290 ],
291 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
292 # simultaneously on a node in the node pool.
293 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
294 },
295 "version": "A String", # The version of the Kubernetes of this node.
296 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
297 # disruption caused by an upgrade.
298 #
299 # maxUnavailable controls the number of nodes that can be simultaneously
300 # unavailable.
301 #
302 # maxSurge controls the number of additional nodes that can be added to the
303 # node pool temporarily for the time of the upgrade to increase the number of
304 # available nodes.
305 #
306 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
307 # nodes are being upgraded at the same time).
308 #
309 # Note: upgrades inevitably introduce some disruption since workloads need to
310 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
311 # this holds true. (Disruption stays within the limits of
312 # PodDisruptionBudget, if it is configured.)
313 #
314 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
315 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
316 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
317 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
318 # there are always at least 4 nodes available.
319 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
320 # of the node pool during the upgrade process.
321 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
322 # the upgrade process. A node is considered available if its status is
323 # Ready.
324 },
325 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
326 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
327 # is sufficient for this number of instances. You must also have available
328 # firewall and routes quota.
329 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]330 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
332 # the specified [Zonal Compute
333 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
334 # to this node pool.
335 # is the configuration of desired reservation which instances could take
336 # capacity from.
337 "values": [ # Corresponds to the label value(s) of reservation resource(s).
338 "A String",
339 ],
340 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
341 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
342 # the key and specify the name of your reservation as its value.
343 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
344 },
345 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
346 "type": "A String", # Type of the sandbox to use for the node.
347 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]348 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]350 # `n1-standard-1`).
351 #
352 # If unspecified, the default machine type is
353 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
355 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
356 #
357 # Enables monitoring and attestation of the boot integrity of the instance.
358 # The attestation is performed against the integrity policy baseline. This
359 # baseline is initially derived from the implicitly trusted boot image when
360 # the instance is created.
361 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
362 #
363 # Secure Boot helps ensure that the system only runs authentic software by
364 # verifying the digital signature of all boot components, and halting the
365 # boot process if signature verification fails.
366 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]367 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
368 # valid sources or targets for network firewalls and are specified by
369 # the client during cluster or node pool creation. Each tag within the list
370 # must comply with RFC1035.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]371 "A String",
372 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]373 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
374 # https://cloud.google.com/compute/docs/instances/preemptible for more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 # information about preemptible VM instances.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]376 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
377 # These will added in addition to any default label(s) that
378 # Kubernetes may apply to the node.
379 # In case of conflict in label keys, the applied set may differ depending on
380 # the Kubernetes version -- it's best to assume the behavior is undefined
381 # and conflicts should be avoided.
382 # For more information, including usage and the valid values, see:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]384 "a_key": "A String",
385 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
387 # Specify the email address of the Service Account; otherwise, if no Service
388 # Account is specified, the "default" service account is used.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]389 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
390 # node VMs under the "default" service account.
391 #
392 # The following scopes are recommended, but not required, and by default are
393 # not included:
394 #
395 # * `https://www.googleapis.com/auth/compute` is required for mounting
396 # persistent storage on your nodes.
397 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
398 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]399 # (the [Google Container
400 # Registry](https://cloud.google.com/container-registry/)).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]401 #
402 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
403 # Monitoring are enabled, in which case their required scopes will be added.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]404 "A String",
405 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
407 #
408 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
410 # workloads on the node pool.
411 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
412 # on the node pool.
413 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]414 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
415 # The smallest allowed disk size is 10GB.
416 #
417 # If unspecified, the default disk size is 100GB.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 "accelerators": [ # A list of hardware accelerators to be attached to each node.
419 # See https://cloud.google.com/compute/docs/gpus for more information about
420 # support for GPUs.
421 { # AcceleratorConfig represents a Hardware Accelerator request.
422 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
423 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]424 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]425 },
426 ],
427 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
428 # scheduled on the specified or newer CPU platform. Applicable values are the
429 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]430 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
431 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 # information, read [how to specify min CPU
433 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]434 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
435 #
436 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
437 # in length. These are reflected as part of a URL in the metadata server.
438 # Additionally, to avoid ambiguity, keys must not conflict with any other
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]439 # metadata keys for the project or be one of the reserved keys:
440 # "cluster-location"
441 # "cluster-name"
442 # "cluster-uid"
443 # "configure-sh"
444 # "containerd-configure-sh"
445 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]447 # "gci-metrics-enabled"
448 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 # "instance-template"
450 # "kube-env"
451 # "startup-script"
452 # "user-data"
453 # "disable-address-manager"
454 # "windows-startup-script-ps1"
455 # "common-psm1"
456 # "k8s-node-setup-psm1"
457 # "install-ssh-psm1"
458 # "user-profile-psm1"
459 # "serial-port-logging-enable"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]460 #
461 # Values are free-form strings, and only have meaning as interpreted by
462 # the image running in the instance. The only restriction placed on them is
463 # that each value's size must be less than or equal to 32 KB.
464 #
465 # The total size of all keys and values must be less than 512 KB.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]466 "a_key": "A String",
467 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]468 "taints": [ # List of kubernetes taints to be applied to each node.
469 #
470 # For more information, including usage and the valid values, see:
471 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
472 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
473 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
474 #
475 # For more information, including usage and the valid values, see:
476 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
477 "value": "A String", # Value for taint.
478 "key": "A String", # Key for taint.
479 "effect": "A String", # Effect for taint.
480 },
481 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]482 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
483 # the latest version of it will be used.
484 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
485 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]486 # The limit for this value is dependent upon the maximum number of
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]487 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]488 # https://cloud.google.com/compute/docs/disks/local-ssd
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]489 # for more information.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]490 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 "conditions": [ # Which conditions caused the current node pool state.
492 { # StatusCondition describes why a cluster or a node pool has a certain status
493 # (e.g., ERROR or DEGRADED).
494 "message": "A String", # Human-friendly representation of the condition
495 "code": "A String", # Machine-friendly representation of the condition
496 },
497 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 "statusMessage": "A String", # [Output only] Additional information about the current status of this
499 # node pool instance, if available.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]500 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]501 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]502 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
503 # cluster resides. This field has been deprecated and replaced by the parent
504 # field.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]505 }
506
507 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]508 Allowed values
509 1 - v1 error format
510 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]511
512Returns:
513 An object of the form:
514
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]515 { # This operation resource represents operations that may have happened or are
516 # happening on the cluster. All fields are output only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]517 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]519 "name": "A String", # The server-assigned ID for the operation.
520 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
522 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]523 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]524 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 "nodepoolConditions": [ # Which conditions caused the current node pool state.
527 { # StatusCondition describes why a cluster or a node pool has a certain status
528 # (e.g., ERROR or DEGRADED).
529 "message": "A String", # Human-friendly representation of the condition
530 "code": "A String", # Machine-friendly representation of the condition
531 },
532 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]533 "clusterConditions": [ # Which conditions caused the current cluster state.
534 { # StatusCondition describes why a cluster or a node pool has a certain status
535 # (e.g., ERROR or DEGRADED).
536 "message": "A String", # Human-friendly representation of the condition
537 "code": "A String", # Machine-friendly representation of the condition
538 },
539 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]540 "startTime": "A String", # [Output only] The time the operation started, in
541 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
542 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
543 "status": "A String", # Status of an operation stage.
544 # Unset for single-stage operations.
545 "metrics": [ # Progress metric bundle, for example:
546 # metrics: [{name: "nodes done", int_value: 15},
547 # {name: "nodes total", int_value: 32}]
548 # or
549 # metrics: [{name: "progress", double_value: 0.56},
550 # {name: "progress scale", double_value: 1.0}]
551 { # Progress metric is (string, int|float|string) pair.
552 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
553 "intValue": "A String", # For metrics with integer value.
554 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
555 "doubleValue": 3.14, # For metrics with floating point value.
556 },
557 ],
558 "stages": [ # Substages of an operation or a stage.
559 # Object with schema name: OperationProgress
560 ],
561 "name": "A String", # A non-parameterized string describing an operation stage.
562 # Unset for single-stage operations.
563 },
564 "endTime": "A String", # [Output only] The time the operation completed, in
565 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
566 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
567 "location": "A String", # [Output only] The name of the Google Compute Engine
568 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
569 # or
570 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
571 # in which the cluster resides.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]572 }</pre>
573</div>
574
575<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576 <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]577 <pre>Deletes a node pool from a cluster.
578
579Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 projectId: string, Deprecated. The Google Developers Console [project ID or project
581number](https://developers.google.com/console/help/new/#projectnumber).
582This field has been deprecated and replaced by the name field. (required)
583 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]584[zone](https://cloud.google.com/compute/docs/zones#available) in which the
585cluster resides. This field has been deprecated and replaced by the name
586field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 clusterId: string, Deprecated. The name of the cluster.
588This field has been deprecated and replaced by the name field. (required)
589 nodePoolId: string, Deprecated. The name of the node pool to delete.
590This field has been deprecated and replaced by the name field. (required)
591 name: string, The name (project, location, cluster, node pool id) of the node pool to
592delete. Specified in the format
593'projects/*/locations/*/clusters/*/nodePools/*'.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]594 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]595 Allowed values
596 1 - v1 error format
597 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]598
599Returns:
600 An object of the form:
601
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]602 { # This operation resource represents operations that may have happened or are
603 # happening on the cluster. All fields are output only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]604 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]605 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]606 "name": "A String", # The server-assigned ID for the operation.
607 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]608 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
609 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]610 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]611 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]613 "nodepoolConditions": [ # Which conditions caused the current node pool state.
614 { # StatusCondition describes why a cluster or a node pool has a certain status
615 # (e.g., ERROR or DEGRADED).
616 "message": "A String", # Human-friendly representation of the condition
617 "code": "A String", # Machine-friendly representation of the condition
618 },
619 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]620 "clusterConditions": [ # Which conditions caused the current cluster state.
621 { # StatusCondition describes why a cluster or a node pool has a certain status
622 # (e.g., ERROR or DEGRADED).
623 "message": "A String", # Human-friendly representation of the condition
624 "code": "A String", # Machine-friendly representation of the condition
625 },
626 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]627 "startTime": "A String", # [Output only] The time the operation started, in
628 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
629 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
630 "status": "A String", # Status of an operation stage.
631 # Unset for single-stage operations.
632 "metrics": [ # Progress metric bundle, for example:
633 # metrics: [{name: "nodes done", int_value: 15},
634 # {name: "nodes total", int_value: 32}]
635 # or
636 # metrics: [{name: "progress", double_value: 0.56},
637 # {name: "progress scale", double_value: 1.0}]
638 { # Progress metric is (string, int|float|string) pair.
639 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
640 "intValue": "A String", # For metrics with integer value.
641 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
642 "doubleValue": 3.14, # For metrics with floating point value.
643 },
644 ],
645 "stages": [ # Substages of an operation or a stage.
646 # Object with schema name: OperationProgress
647 ],
648 "name": "A String", # A non-parameterized string describing an operation stage.
649 # Unset for single-stage operations.
650 },
651 "endTime": "A String", # [Output only] The time the operation completed, in
652 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
653 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
654 "location": "A String", # [Output only] The name of the Google Compute Engine
655 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
656 # or
657 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
658 # in which the cluster resides.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]659 }</pre>
660</div>
661
662<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]663 <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code>
664 <pre>Retrieves the requested node pool.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]665
666Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 projectId: string, Deprecated. The Google Developers Console [project ID or project
668number](https://developers.google.com/console/help/new/#projectnumber).
669This field has been deprecated and replaced by the name field. (required)
670 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]671[zone](https://cloud.google.com/compute/docs/zones#available) in which the
672cluster resides. This field has been deprecated and replaced by the name
673field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]674 clusterId: string, Deprecated. The name of the cluster.
675This field has been deprecated and replaced by the name field. (required)
676 nodePoolId: string, Deprecated. The name of the node pool.
677This field has been deprecated and replaced by the name field. (required)
678 name: string, The name (project, location, cluster, node pool id) of the node pool to
679get. Specified in the format
680'projects/*/locations/*/clusters/*/nodePools/*'.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]681 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]682 Allowed values
683 1 - v1 error format
684 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]685
686Returns:
687 An object of the form:
688
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]689 { # NodePool contains the name and configuration for a cluster's node pool.
690 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
691 # specification, under the control of the cluster master. They may have a set
692 # of Kubernetes labels applied to them, which may be used to reference them
693 # during pod scheduling. They may also be resized up or down, to accommodate
694 # the workload.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 "status": "A String", # [Output only] The status of the nodes in this pool instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]696 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]697 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
698 # node pool.
699 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
700 # pool. If enabled, the nodes in this node pool will be monitored and, if
701 # they fail health checks too many times, an automatic repair action will be
702 # triggered.
703 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
704 # the Auto Upgrades will proceed.
705 "description": "A String", # [Output only] This field is set when upgrades are about to commence
706 # with the description of the upgrade.
707 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
708 # with the approximate start time for the upgrades, in
709 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
710 },
711 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
712 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
713 # up to date with the latest release version of Kubernetes.
714 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 "name": "A String", # The name of the node pool.
716 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
717 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
718 # associated with this node pool.
719 "A String",
720 ],
721 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
722 # only if a valid configuration is present.
723 # adjust the size of the node pool to the current cluster usage.
724 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
725 # max_node_count.
726 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
727 "enabled": True or False, # Is autoscaling enabled for this node pool.
728 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
729 # has to enough quota to scale up the cluster.
730 },
731 "locations": [ # The list of Google Compute Engine
732 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
733 # NodePool's nodes should be located.
734 "A String",
735 ],
736 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
737 # simultaneously on a node in the node pool.
738 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
739 },
740 "version": "A String", # The version of the Kubernetes of this node.
741 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
742 # disruption caused by an upgrade.
743 #
744 # maxUnavailable controls the number of nodes that can be simultaneously
745 # unavailable.
746 #
747 # maxSurge controls the number of additional nodes that can be added to the
748 # node pool temporarily for the time of the upgrade to increase the number of
749 # available nodes.
750 #
751 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
752 # nodes are being upgraded at the same time).
753 #
754 # Note: upgrades inevitably introduce some disruption since workloads need to
755 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
756 # this holds true. (Disruption stays within the limits of
757 # PodDisruptionBudget, if it is configured.)
758 #
759 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
760 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
761 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
762 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
763 # there are always at least 4 nodes available.
764 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
765 # of the node pool during the upgrade process.
766 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
767 # the upgrade process. A node is considered available if its status is
768 # Ready.
769 },
770 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
771 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
772 # is sufficient for this number of instances. You must also have available
773 # firewall and routes quota.
774 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]775 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]776 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
777 # the specified [Zonal Compute
778 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
779 # to this node pool.
780 # is the configuration of desired reservation which instances could take
781 # capacity from.
782 "values": [ # Corresponds to the label value(s) of reservation resource(s).
783 "A String",
784 ],
785 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
786 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
787 # the key and specify the name of your reservation as its value.
788 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
789 },
790 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
791 "type": "A String", # Type of the sandbox to use for the node.
792 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]793 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]794 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]795 # `n1-standard-1`).
796 #
797 # If unspecified, the default machine type is
798 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]799 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
800 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
801 #
802 # Enables monitoring and attestation of the boot integrity of the instance.
803 # The attestation is performed against the integrity policy baseline. This
804 # baseline is initially derived from the implicitly trusted boot image when
805 # the instance is created.
806 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
807 #
808 # Secure Boot helps ensure that the system only runs authentic software by
809 # verifying the digital signature of all boot components, and halting the
810 # boot process if signature verification fails.
811 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]812 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
813 # valid sources or targets for network firewalls and are specified by
814 # the client during cluster or node pool creation. Each tag within the list
815 # must comply with RFC1035.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]816 "A String",
817 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]818 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
819 # https://cloud.google.com/compute/docs/instances/preemptible for more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]820 # information about preemptible VM instances.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]821 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
822 # These will added in addition to any default label(s) that
823 # Kubernetes may apply to the node.
824 # In case of conflict in label keys, the applied set may differ depending on
825 # the Kubernetes version -- it's best to assume the behavior is undefined
826 # and conflicts should be avoided.
827 # For more information, including usage and the valid values, see:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]828 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]829 "a_key": "A String",
830 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]831 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
832 # Specify the email address of the Service Account; otherwise, if no Service
833 # Account is specified, the "default" service account is used.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]834 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
835 # node VMs under the "default" service account.
836 #
837 # The following scopes are recommended, but not required, and by default are
838 # not included:
839 #
840 # * `https://www.googleapis.com/auth/compute` is required for mounting
841 # persistent storage on your nodes.
842 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
843 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]844 # (the [Google Container
845 # Registry](https://cloud.google.com/container-registry/)).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]846 #
847 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
848 # Monitoring are enabled, in which case their required scopes will be added.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]849 "A String",
850 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]851 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
852 #
853 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]854 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
855 # workloads on the node pool.
856 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
857 # on the node pool.
858 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]859 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
860 # The smallest allowed disk size is 10GB.
861 #
862 # If unspecified, the default disk size is 100GB.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]863 "accelerators": [ # A list of hardware accelerators to be attached to each node.
864 # See https://cloud.google.com/compute/docs/gpus for more information about
865 # support for GPUs.
866 { # AcceleratorConfig represents a Hardware Accelerator request.
867 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
868 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]869 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]870 },
871 ],
872 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
873 # scheduled on the specified or newer CPU platform. Applicable values are the
874 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]875 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
876 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]877 # information, read [how to specify min CPU
878 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]879 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
880 #
881 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
882 # in length. These are reflected as part of a URL in the metadata server.
883 # Additionally, to avoid ambiguity, keys must not conflict with any other
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]884 # metadata keys for the project or be one of the reserved keys:
885 # "cluster-location"
886 # "cluster-name"
887 # "cluster-uid"
888 # "configure-sh"
889 # "containerd-configure-sh"
890 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]891 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]892 # "gci-metrics-enabled"
893 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]894 # "instance-template"
895 # "kube-env"
896 # "startup-script"
897 # "user-data"
898 # "disable-address-manager"
899 # "windows-startup-script-ps1"
900 # "common-psm1"
901 # "k8s-node-setup-psm1"
902 # "install-ssh-psm1"
903 # "user-profile-psm1"
904 # "serial-port-logging-enable"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]905 #
906 # Values are free-form strings, and only have meaning as interpreted by
907 # the image running in the instance. The only restriction placed on them is
908 # that each value's size must be less than or equal to 32 KB.
909 #
910 # The total size of all keys and values must be less than 512 KB.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]911 "a_key": "A String",
912 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]913 "taints": [ # List of kubernetes taints to be applied to each node.
914 #
915 # For more information, including usage and the valid values, see:
916 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
917 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
918 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
919 #
920 # For more information, including usage and the valid values, see:
921 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
922 "value": "A String", # Value for taint.
923 "key": "A String", # Key for taint.
924 "effect": "A String", # Effect for taint.
925 },
926 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]927 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
928 # the latest version of it will be used.
929 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
930 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]931 # The limit for this value is dependent upon the maximum number of
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]932 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]933 # https://cloud.google.com/compute/docs/disks/local-ssd
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]934 # for more information.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]935 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936 "conditions": [ # Which conditions caused the current node pool state.
937 { # StatusCondition describes why a cluster or a node pool has a certain status
938 # (e.g., ERROR or DEGRADED).
939 "message": "A String", # Human-friendly representation of the condition
940 "code": "A String", # Machine-friendly representation of the condition
941 },
942 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]943 "statusMessage": "A String", # [Output only] Additional information about the current status of this
944 # node pool instance, if available.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]945 }</pre>
946</div>
947
948<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]949 <code class="details" id="list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]950 <pre>Lists the node pools for a cluster.
951
952Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]953 projectId: string, Deprecated. The Google Developers Console [project ID or project
954number](https://developers.google.com/console/help/new/#projectnumber).
955This field has been deprecated and replaced by the parent field. (required)
956 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]957[zone](https://cloud.google.com/compute/docs/zones#available) in which the
958cluster resides. This field has been deprecated and replaced by the parent
959field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]960 clusterId: string, Deprecated. The name of the cluster.
961This field has been deprecated and replaced by the parent field. (required)
962 parent: string, The parent (project, location, cluster id) where the node pools will be
963listed. Specified in the format 'projects/*/locations/*/clusters/*'.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]964 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]965 Allowed values
966 1 - v1 error format
967 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]968
969Returns:
970 An object of the form:
971
972 { # ListNodePoolsResponse is the result of ListNodePoolsRequest.
973 "nodePools": [ # A list of node pools for a cluster.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]974 { # NodePool contains the name and configuration for a cluster's node pool.
975 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
976 # specification, under the control of the cluster master. They may have a set
977 # of Kubernetes labels applied to them, which may be used to reference them
978 # during pod scheduling. They may also be resized up or down, to accommodate
979 # the workload.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]980 "status": "A String", # [Output only] The status of the nodes in this pool instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]981 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]982 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
983 # node pool.
984 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
985 # pool. If enabled, the nodes in this node pool will be monitored and, if
986 # they fail health checks too many times, an automatic repair action will be
987 # triggered.
988 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
989 # the Auto Upgrades will proceed.
990 "description": "A String", # [Output only] This field is set when upgrades are about to commence
991 # with the description of the upgrade.
992 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
993 # with the approximate start time for the upgrades, in
994 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
995 },
996 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
997 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
998 # up to date with the latest release version of Kubernetes.
999 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1000 "name": "A String", # The name of the node pool.
1001 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
1002 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
1003 # associated with this node pool.
1004 "A String",
1005 ],
1006 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
1007 # only if a valid configuration is present.
1008 # adjust the size of the node pool to the current cluster usage.
1009 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
1010 # max_node_count.
1011 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
1012 "enabled": True or False, # Is autoscaling enabled for this node pool.
1013 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
1014 # has to enough quota to scale up the cluster.
1015 },
1016 "locations": [ # The list of Google Compute Engine
1017 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1018 # NodePool's nodes should be located.
1019 "A String",
1020 ],
1021 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
1022 # simultaneously on a node in the node pool.
1023 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
1024 },
1025 "version": "A String", # The version of the Kubernetes of this node.
1026 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
1027 # disruption caused by an upgrade.
1028 #
1029 # maxUnavailable controls the number of nodes that can be simultaneously
1030 # unavailable.
1031 #
1032 # maxSurge controls the number of additional nodes that can be added to the
1033 # node pool temporarily for the time of the upgrade to increase the number of
1034 # available nodes.
1035 #
1036 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
1037 # nodes are being upgraded at the same time).
1038 #
1039 # Note: upgrades inevitably introduce some disruption since workloads need to
1040 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
1041 # this holds true. (Disruption stays within the limits of
1042 # PodDisruptionBudget, if it is configured.)
1043 #
1044 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
1045 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
1046 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
1047 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
1048 # there are always at least 4 nodes available.
1049 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
1050 # of the node pool during the upgrade process.
1051 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
1052 # the upgrade process. A node is considered available if its status is
1053 # Ready.
1054 },
1055 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
1056 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
1057 # is sufficient for this number of instances. You must also have available
1058 # firewall and routes quota.
1059 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1060 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1061 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
1062 # the specified [Zonal Compute
1063 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
1064 # to this node pool.
1065 # is the configuration of desired reservation which instances could take
1066 # capacity from.
1067 "values": [ # Corresponds to the label value(s) of reservation resource(s).
1068 "A String",
1069 ],
1070 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
1071 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
1072 # the key and specify the name of your reservation as its value.
1073 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
1074 },
1075 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1076 "type": "A String", # Type of the sandbox to use for the node.
1077 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1078 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1079 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1080 # `n1-standard-1`).
1081 #
1082 # If unspecified, the default machine type is
1083 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1084 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
1085 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
1086 #
1087 # Enables monitoring and attestation of the boot integrity of the instance.
1088 # The attestation is performed against the integrity policy baseline. This
1089 # baseline is initially derived from the implicitly trusted boot image when
1090 # the instance is created.
1091 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
1092 #
1093 # Secure Boot helps ensure that the system only runs authentic software by
1094 # verifying the digital signature of all boot components, and halting the
1095 # boot process if signature verification fails.
1096 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1097 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
1098 # valid sources or targets for network firewalls and are specified by
1099 # the client during cluster or node pool creation. Each tag within the list
1100 # must comply with RFC1035.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1101 "A String",
1102 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1103 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
1104 # https://cloud.google.com/compute/docs/instances/preemptible for more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1105 # information about preemptible VM instances.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1106 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
1107 # These will added in addition to any default label(s) that
1108 # Kubernetes may apply to the node.
1109 # In case of conflict in label keys, the applied set may differ depending on
1110 # the Kubernetes version -- it's best to assume the behavior is undefined
1111 # and conflicts should be avoided.
1112 # For more information, including usage and the valid values, see:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1113 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1114 "a_key": "A String",
1115 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1116 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
1117 # Specify the email address of the Service Account; otherwise, if no Service
1118 # Account is specified, the "default" service account is used.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1119 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
1120 # node VMs under the "default" service account.
1121 #
1122 # The following scopes are recommended, but not required, and by default are
1123 # not included:
1124 #
1125 # * `https://www.googleapis.com/auth/compute` is required for mounting
1126 # persistent storage on your nodes.
1127 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
1128 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1129 # (the [Google Container
1130 # Registry](https://cloud.google.com/container-registry/)).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1131 #
1132 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
1133 # Monitoring are enabled, in which case their required scopes will be added.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1134 "A String",
1135 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1136 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
1137 #
1138 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1139 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
1140 # workloads on the node pool.
1141 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
1142 # on the node pool.
1143 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1144 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
1145 # The smallest allowed disk size is 10GB.
1146 #
1147 # If unspecified, the default disk size is 100GB.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1148 "accelerators": [ # A list of hardware accelerators to be attached to each node.
1149 # See https://cloud.google.com/compute/docs/gpus for more information about
1150 # support for GPUs.
1151 { # AcceleratorConfig represents a Hardware Accelerator request.
1152 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
1153 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1154 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1155 },
1156 ],
1157 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
1158 # scheduled on the specified or newer CPU platform. Applicable values are the
1159 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1160 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
1161 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Sandy Bridge&amp;quot;&lt;/code&gt;. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1162 # information, read [how to specify min CPU
1163 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1164 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
1165 #
1166 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
1167 # in length. These are reflected as part of a URL in the metadata server.
1168 # Additionally, to avoid ambiguity, keys must not conflict with any other
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1169 # metadata keys for the project or be one of the reserved keys:
1170 # "cluster-location"
1171 # "cluster-name"
1172 # "cluster-uid"
1173 # "configure-sh"
1174 # "containerd-configure-sh"
1175 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1176 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1177 # "gci-metrics-enabled"
1178 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1179 # "instance-template"
1180 # "kube-env"
1181 # "startup-script"
1182 # "user-data"
1183 # "disable-address-manager"
1184 # "windows-startup-script-ps1"
1185 # "common-psm1"
1186 # "k8s-node-setup-psm1"
1187 # "install-ssh-psm1"
1188 # "user-profile-psm1"
1189 # "serial-port-logging-enable"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1190 #
1191 # Values are free-form strings, and only have meaning as interpreted by
1192 # the image running in the instance. The only restriction placed on them is
1193 # that each value's size must be less than or equal to 32 KB.
1194 #
1195 # The total size of all keys and values must be less than 512 KB.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1196 "a_key": "A String",
1197 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1198 "taints": [ # List of kubernetes taints to be applied to each node.
1199 #
1200 # For more information, including usage and the valid values, see:
1201 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1202 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
1203 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
1204 #
1205 # For more information, including usage and the valid values, see:
1206 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1207 "value": "A String", # Value for taint.
1208 "key": "A String", # Key for taint.
1209 "effect": "A String", # Effect for taint.
1210 },
1211 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1212 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
1213 # the latest version of it will be used.
1214 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
1215 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1216 # The limit for this value is dependent upon the maximum number of
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1217 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1218 # https://cloud.google.com/compute/docs/disks/local-ssd
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1219 # for more information.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1220 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1221 "conditions": [ # Which conditions caused the current node pool state.
1222 { # StatusCondition describes why a cluster or a node pool has a certain status
1223 # (e.g., ERROR or DEGRADED).
1224 "message": "A String", # Human-friendly representation of the condition
1225 "code": "A String", # Machine-friendly representation of the condition
1226 },
1227 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1228 "statusMessage": "A String", # [Output only] Additional information about the current status of this
1229 # node pool instance, if available.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1230 },
1231 ],
1232 }</pre>
1233</div>
1234
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1235<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1236 <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1237 <pre>Rolls back a previously Aborted or Failed NodePool upgrade.
1238This makes no changes if the last upgrade successfully completed.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1239
1240Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1241 projectId: string, Deprecated. The Google Developers Console [project ID or project
1242number](https://support.google.com/cloud/answer/6158840).
1243This field has been deprecated and replaced by the name field. (required)
1244 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1245[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1246cluster resides. This field has been deprecated and replaced by the name
1247field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1248 clusterId: string, Deprecated. The name of the cluster to rollback.
1249This field has been deprecated and replaced by the name field. (required)
1250 nodePoolId: string, Deprecated. The name of the node pool to rollback.
1251This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1252 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1253 The object takes the form of:
1254
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1255{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed
1256 # NodePool upgrade. This will be an no-op if the last upgrade successfully
1257 # completed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1258 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1259 # number](https://support.google.com/cloud/answer/6158840).
1260 # This field has been deprecated and replaced by the name field.
1261 "clusterId": "A String", # Deprecated. The name of the cluster to rollback.
1262 # This field has been deprecated and replaced by the name field.
1263 "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to
1264 # rollback upgrade.
1265 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
1266 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1267 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1268 # cluster resides. This field has been deprecated and replaced by the name
1269 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1270 "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback.
1271 # This field has been deprecated and replaced by the name field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1272 }
1273
1274 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1275 Allowed values
1276 1 - v1 error format
1277 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1278
1279Returns:
1280 An object of the form:
1281
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1282 { # This operation resource represents operations that may have happened or are
1283 # happening on the cluster. All fields are output only.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1284 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1285 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1286 "name": "A String", # The server-assigned ID for the operation.
1287 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1288 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1289 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1290 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1291 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1292 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1293 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1294 { # StatusCondition describes why a cluster or a node pool has a certain status
1295 # (e.g., ERROR or DEGRADED).
1296 "message": "A String", # Human-friendly representation of the condition
1297 "code": "A String", # Machine-friendly representation of the condition
1298 },
1299 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1300 "clusterConditions": [ # Which conditions caused the current cluster state.
1301 { # StatusCondition describes why a cluster or a node pool has a certain status
1302 # (e.g., ERROR or DEGRADED).
1303 "message": "A String", # Human-friendly representation of the condition
1304 "code": "A String", # Machine-friendly representation of the condition
1305 },
1306 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1307 "startTime": "A String", # [Output only] The time the operation started, in
1308 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1309 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1310 "status": "A String", # Status of an operation stage.
1311 # Unset for single-stage operations.
1312 "metrics": [ # Progress metric bundle, for example:
1313 # metrics: [{name: "nodes done", int_value: 15},
1314 # {name: "nodes total", int_value: 32}]
1315 # or
1316 # metrics: [{name: "progress", double_value: 0.56},
1317 # {name: "progress scale", double_value: 1.0}]
1318 { # Progress metric is (string, int|float|string) pair.
1319 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1320 "intValue": "A String", # For metrics with integer value.
1321 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1322 "doubleValue": 3.14, # For metrics with floating point value.
1323 },
1324 ],
1325 "stages": [ # Substages of an operation or a stage.
1326 # Object with schema name: OperationProgress
1327 ],
1328 "name": "A String", # A non-parameterized string describing an operation stage.
1329 # Unset for single-stage operations.
1330 },
1331 "endTime": "A String", # [Output only] The time the operation completed, in
1332 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1333 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1334 "location": "A String", # [Output only] The name of the Google Compute Engine
1335 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1336 # or
1337 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1338 # in which the cluster resides.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1339 }</pre>
1340</div>
1341
1342<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1343 <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1344 <pre>Sets the NodeManagement options for a node pool.
1345
1346Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1347 projectId: string, Deprecated. The Google Developers Console [project ID or project
1348number](https://support.google.com/cloud/answer/6158840).
1349This field has been deprecated and replaced by the name field. (required)
1350 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1351[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1352cluster resides. This field has been deprecated and replaced by the name
1353field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1354 clusterId: string, Deprecated. The name of the cluster to update.
1355This field has been deprecated and replaced by the name field. (required)
1356 nodePoolId: string, Deprecated. The name of the node pool to update.
1357This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1358 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1359 The object takes the form of:
1360
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1361{ # SetNodePoolManagementRequest sets the node management properties of a node
1362 # pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1363 "management": { # NodeManagement defines the set of node management services turned on for the # Required. NodeManagement configuration for the node pool.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1364 # node pool.
1365 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
1366 # pool. If enabled, the nodes in this node pool will be monitored and, if
1367 # they fail health checks too many times, an automatic repair action will be
1368 # triggered.
1369 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1370 # the Auto Upgrades will proceed.
1371 "description": "A String", # [Output only] This field is set when upgrades are about to commence
1372 # with the description of the upgrade.
1373 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
1374 # with the approximate start time for the upgrades, in
1375 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1376 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1377 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
1378 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
1379 # up to date with the latest release version of Kubernetes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1380 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1381 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set
1382 # management properties. Specified in the format
1383 # 'projects/*/locations/*/clusters/*/nodePools/*'.
1384 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1385 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1386 # cluster resides. This field has been deprecated and replaced by the name
1387 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1388 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1389 # number](https://support.google.com/cloud/answer/6158840).
1390 # This field has been deprecated and replaced by the name field.
1391 "clusterId": "A String", # Deprecated. The name of the cluster to update.
1392 # This field has been deprecated and replaced by the name field.
1393 "nodePoolId": "A String", # Deprecated. The name of the node pool to update.
1394 # This field has been deprecated and replaced by the name field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1395 }
1396
1397 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1398 Allowed values
1399 1 - v1 error format
1400 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1401
1402Returns:
1403 An object of the form:
1404
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1405 { # This operation resource represents operations that may have happened or are
1406 # happening on the cluster. All fields are output only.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1407 "status": "A String", # The current status of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1408 "selfLink": "A String", # Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1409 "name": "A String", # The server-assigned ID for the operation.
1410 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1411 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1412 # operation is taking place. This field is deprecated, use location instead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1413 "detail": "A String", # Detailed operation progress, if available.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1414 "operationType": "A String", # The operation type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1415 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1416 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1417 { # StatusCondition describes why a cluster or a node pool has a certain status
1418 # (e.g., ERROR or DEGRADED).
1419 "message": "A String", # Human-friendly representation of the condition
1420 "code": "A String", # Machine-friendly representation of the condition
1421 },
1422 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1423 "clusterConditions": [ # Which conditions caused the current cluster state.
1424 { # StatusCondition describes why a cluster or a node pool has a certain status
1425 # (e.g., ERROR or DEGRADED).
1426 "message": "A String", # Human-friendly representation of the condition
1427 "code": "A String", # Machine-friendly representation of the condition
1428 },
1429 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1430 "startTime": "A String", # [Output only] The time the operation started, in
1431 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1432 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1433 "status": "A String", # Status of an operation stage.
1434 # Unset for single-stage operations.
1435 "metrics": [ # Progress metric bundle, for example:
1436 # metrics: [{name: "nodes done", int_value: 15},
1437 # {name: "nodes total", int_value: 32}]
1438 # or
1439 # metrics: [{name: "progress", double_value: 0.56},
1440 # {name: "progress scale", double_value: 1.0}]
1441 { # Progress metric is (string, int|float|string) pair.
1442 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1443 "intValue": "A String", # For metrics with integer value.
1444 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1445 "doubleValue": 3.14, # For metrics with floating point value.
1446 },
1447 ],
1448 "stages": [ # Substages of an operation or a stage.
1449 # Object with schema name: OperationProgress
1450 ],
1451 "name": "A String", # A non-parameterized string describing an operation stage.
1452 # Unset for single-stage operations.
1453 },
1454 "endTime": "A String", # [Output only] The time the operation completed, in
1455 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1456 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1457 "location": "A String", # [Output only] The name of the Google Compute Engine
1458 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1459 # or
1460 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1461 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1462 }</pre>
1463</div>
1464
1465<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1466 <code class="details" id="setSize">setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1467 <pre>Sets the size for a specific node pool.
1468
1469Args:
1470 projectId: string, Deprecated. The Google Developers Console [project ID or project
1471number](https://support.google.com/cloud/answer/6158840).
1472This field has been deprecated and replaced by the name field. (required)
1473 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1474[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1475cluster resides. This field has been deprecated and replaced by the name
1476field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1477 clusterId: string, Deprecated. The name of the cluster to update.
1478This field has been deprecated and replaced by the name field. (required)
1479 nodePoolId: string, Deprecated. The name of the node pool to update.
1480This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1481 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1482 The object takes the form of:
1483
1484{ # SetNodePoolSizeRequest sets the size a node
1485 # pool.
1486 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set
1487 # size.
1488 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
1489 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1490 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1491 # cluster resides. This field has been deprecated and replaced by the name
1492 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1493 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1494 # number](https://support.google.com/cloud/answer/6158840).
1495 # This field has been deprecated and replaced by the name field.
1496 "clusterId": "A String", # Deprecated. The name of the cluster to update.
1497 # This field has been deprecated and replaced by the name field.
1498 "nodePoolId": "A String", # Deprecated. The name of the node pool to update.
1499 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1500 "nodeCount": 42, # Required. The desired node count for the pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1501 }
1502
1503 x__xgafv: string, V1 error format.
1504 Allowed values
1505 1 - v1 error format
1506 2 - v2 error format
1507
1508Returns:
1509 An object of the form:
1510
1511 { # This operation resource represents operations that may have happened or are
1512 # happening on the cluster. All fields are output only.
1513 "status": "A String", # The current status of the operation.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1514 "selfLink": "A String", # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1515 "name": "A String", # The server-assigned ID for the operation.
1516 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1517 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1518 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1519 "detail": "A String", # Detailed operation progress, if available.
1520 "operationType": "A String", # The operation type.
1521 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1522 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1523 { # StatusCondition describes why a cluster or a node pool has a certain status
1524 # (e.g., ERROR or DEGRADED).
1525 "message": "A String", # Human-friendly representation of the condition
1526 "code": "A String", # Machine-friendly representation of the condition
1527 },
1528 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1529 "clusterConditions": [ # Which conditions caused the current cluster state.
1530 { # StatusCondition describes why a cluster or a node pool has a certain status
1531 # (e.g., ERROR or DEGRADED).
1532 "message": "A String", # Human-friendly representation of the condition
1533 "code": "A String", # Machine-friendly representation of the condition
1534 },
1535 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1536 "startTime": "A String", # [Output only] The time the operation started, in
1537 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1538 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1539 "status": "A String", # Status of an operation stage.
1540 # Unset for single-stage operations.
1541 "metrics": [ # Progress metric bundle, for example:
1542 # metrics: [{name: "nodes done", int_value: 15},
1543 # {name: "nodes total", int_value: 32}]
1544 # or
1545 # metrics: [{name: "progress", double_value: 0.56},
1546 # {name: "progress scale", double_value: 1.0}]
1547 { # Progress metric is (string, int|float|string) pair.
1548 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1549 "intValue": "A String", # For metrics with integer value.
1550 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1551 "doubleValue": 3.14, # For metrics with floating point value.
1552 },
1553 ],
1554 "stages": [ # Substages of an operation or a stage.
1555 # Object with schema name: OperationProgress
1556 ],
1557 "name": "A String", # A non-parameterized string describing an operation stage.
1558 # Unset for single-stage operations.
1559 },
1560 "endTime": "A String", # [Output only] The time the operation completed, in
1561 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1562 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1563 "location": "A String", # [Output only] The name of the Google Compute Engine
1564 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1565 # or
1566 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1567 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1568 }</pre>
1569</div>
1570
1571<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1572 <code class="details" id="update">update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1573 <pre>Updates the version and/or image type for the specified node pool.
1574
1575Args:
1576 projectId: string, Deprecated. The Google Developers Console [project ID or project
1577number](https://support.google.com/cloud/answer/6158840).
1578This field has been deprecated and replaced by the name field. (required)
1579 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1580[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1581cluster resides. This field has been deprecated and replaced by the name
1582field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1583 clusterId: string, Deprecated. The name of the cluster to upgrade.
1584This field has been deprecated and replaced by the name field. (required)
1585 nodePoolId: string, Deprecated. The name of the node pool to upgrade.
1586This field has been deprecated and replaced by the name field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1587 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1588 The object takes the form of:
1589
1590{ # UpdateNodePoolRequests update a node pool's image and/or version.
1591 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to
1592 # update. Specified in the format
1593 # 'projects/*/locations/*/clusters/*/nodePools/*'.
1594 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1595 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1596 # cluster resides. This field has been deprecated and replaced by the name
1597 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1598 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1599 # number](https://support.google.com/cloud/answer/6158840).
1600 # This field has been deprecated and replaced by the name field.
1601 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
1602 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1603 "locations": [ # The desired list of Google Compute Engine
1604 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1605 # node pool's nodes should be located. Changing the locations for a node pool
1606 # will result in nodes being either created or removed from the node pool,
1607 # depending on whether locations are being added or removed.
1608 "A String",
1609 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1610 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.
1611 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1612 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired workload metadata config for the node pool.
1613 # workloads on the node pool.
1614 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
1615 # on the node pool.
1616 },
1617 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
1618 # disruption caused by an upgrade.
1619 #
1620 # maxUnavailable controls the number of nodes that can be simultaneously
1621 # unavailable.
1622 #
1623 # maxSurge controls the number of additional nodes that can be added to the
1624 # node pool temporarily for the time of the upgrade to increase the number of
1625 # available nodes.
1626 #
1627 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
1628 # nodes are being upgraded at the same time).
1629 #
1630 # Note: upgrades inevitably introduce some disruption since workloads need to
1631 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
1632 # this holds true. (Disruption stays within the limits of
1633 # PodDisruptionBudget, if it is configured.)
1634 #
1635 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
1636 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
1637 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
1638 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
1639 # there are always at least 4 nodes available.
1640 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
1641 # of the node pool during the upgrade process.
1642 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
1643 # the upgrade process. A node is considered available if its status is
1644 # Ready.
1645 },
1646 "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1647 # upgrade).
1648 #
1649 # Users may specify either explicit versions offered by Kubernetes Engine or
1650 # version aliases, which have the following behavior:
1651 #
1652 # - "latest": picks the highest valid Kubernetes version
1653 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
1654 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
1655 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
1656 # - "-": picks the Kubernetes master version
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1657 "imageType": "A String", # Required. The desired image type for the node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1658 }
1659
1660 x__xgafv: string, V1 error format.
1661 Allowed values
1662 1 - v1 error format
1663 2 - v2 error format
1664
1665Returns:
1666 An object of the form:
1667
1668 { # This operation resource represents operations that may have happened or are
1669 # happening on the cluster. All fields are output only.
1670 "status": "A String", # The current status of the operation.
1671 "selfLink": "A String", # Server-defined URL for the resource.
1672 "name": "A String", # The server-assigned ID for the operation.
1673 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1674 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1675 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1676 "detail": "A String", # Detailed operation progress, if available.
1677 "operationType": "A String", # The operation type.
1678 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1679 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1680 { # StatusCondition describes why a cluster or a node pool has a certain status
1681 # (e.g., ERROR or DEGRADED).
1682 "message": "A String", # Human-friendly representation of the condition
1683 "code": "A String", # Machine-friendly representation of the condition
1684 },
1685 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1686 "clusterConditions": [ # Which conditions caused the current cluster state.
1687 { # StatusCondition describes why a cluster or a node pool has a certain status
1688 # (e.g., ERROR or DEGRADED).
1689 "message": "A String", # Human-friendly representation of the condition
1690 "code": "A String", # Machine-friendly representation of the condition
1691 },
1692 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1693 "startTime": "A String", # [Output only] The time the operation started, in
1694 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1695 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1696 "status": "A String", # Status of an operation stage.
1697 # Unset for single-stage operations.
1698 "metrics": [ # Progress metric bundle, for example:
1699 # metrics: [{name: "nodes done", int_value: 15},
1700 # {name: "nodes total", int_value: 32}]
1701 # or
1702 # metrics: [{name: "progress", double_value: 0.56},
1703 # {name: "progress scale", double_value: 1.0}]
1704 { # Progress metric is (string, int|float|string) pair.
1705 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1706 "intValue": "A String", # For metrics with integer value.
1707 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1708 "doubleValue": 3.14, # For metrics with floating point value.
1709 },
1710 ],
1711 "stages": [ # Substages of an operation or a stage.
1712 # Object with schema name: OperationProgress
1713 ],
1714 "name": "A String", # A non-parameterized string describing an operation stage.
1715 # Unset for single-stage operations.
1716 },
1717 "endTime": "A String", # [Output only] The time the operation completed, in
1718 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1719 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1720 "location": "A String", # [Output only] The name of the Google Compute Engine
1721 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1722 # or
1723 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1724 # in which the cluster resides.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1725 }</pre>
1726</div>
1727
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1728</body></html>