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