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