Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / container_v1.projects.locations.clusters.html
blob: 71b185202682a1059643d7a32b927b6a2d1db884 [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_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.locations.html">locations</a> . <a href="container_v1.projects.locations.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="container_v1.projects.locations.clusters.nodePools.html">nodePools()</a></code>
79</p>
80<p class="firstline">Returns the nodePools Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="container_v1.projects.locations.clusters.well_known.html">well_known()</a></code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]85<p class="firstline">Returns the well_known Resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86
87<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]88 <code><a href="#completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="firstline">Completes master IP rotation.</p>
90<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]91 <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]92<p class="firstline">Creates a cluster, consisting of the specified number and type of Google</p>
93<p class="toc_element">
94 <code><a href="#delete">delete(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</a></code></p>
95<p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker</p>
96<p class="toc_element">
97 <code><a href="#get">get(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</a></code></p>
98<p class="firstline">Gets the details of a specific cluster.</p>
99<p class="toc_element">
100 <code><a href="#getJwks">getJwks(parent, x__xgafv=None)</a></code></p>
101<p class="firstline">Gets the public component of the cluster signing keys in</p>
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code><a href="#list">list(parent, zone=None, projectId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="firstline">Lists all clusters owned by a project in either the specified zone or all</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106 <code><a href="#setAddons">setAddons(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107<p class="firstline">Sets the addons for a specific cluster.</p>
108<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 <code><a href="#setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110<p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p>
111<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 <code><a href="#setLocations">setLocations(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113<p class="firstline">Sets the locations for a specific cluster.</p>
114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 <code><a href="#setLogging">setLogging(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116<p class="firstline">Sets the logging service for a specific cluster.</p>
117<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code><a href="#setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<p class="firstline">Sets the maintenance policy for a cluster.</p>
120<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 <code><a href="#setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122<p class="firstline">Sets master auth materials. Currently supports changing the admin password</p>
123<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 <code><a href="#setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125<p class="firstline">Sets the monitoring service for a specific cluster.</p>
126<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 <code><a href="#setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128<p class="firstline">Enables or disables Network Policy for a cluster.</p>
129<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 <code><a href="#setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131<p class="firstline">Sets labels on a cluster.</p>
132<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 <code><a href="#startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134<p class="firstline">Starts master IP rotation.</p>
135<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 <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]137<p class="firstline">Updates the settings of a specific cluster.</p>
138<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139 <code><a href="#updateMaster">updateMaster(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140<p class="firstline">Updates the master for a specific cluster.</p>
141<h3>Method Details</h3>
142<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]143 <code class="details" id="completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 <pre>Completes master IP rotation.
145
146Args:
147 name: string, The name (project, location, cluster id) of the cluster to complete IP
148rotation. Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 The object takes the form of:
151
152{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
153 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
154 # number](https://developers.google.com/console/help/new/#projectnumber).
155 # This field has been deprecated and replaced by the name field.
156 "clusterId": "A String", # Deprecated. The name of the cluster.
157 # This field has been deprecated and replaced by the name field.
158 "name": "A String", # The name (project, location, cluster id) of the cluster to complete IP
159 # rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
160 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
162 # cluster resides. This field has been deprecated and replaced by the name
163 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 }
165
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
174 { # This operation resource represents operations that may have happened or are
175 # happening on the cluster. All fields are output only.
176 "status": "A String", # The current status of the operation.
177 "selfLink": "A String", # Server-defined URL for the resource.
178 "name": "A String", # The server-assigned ID for the operation.
179 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
181 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 "detail": "A String", # Detailed operation progress, if available.
183 "operationType": "A String", # The operation type.
184 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 "nodepoolConditions": [ # Which conditions caused the current node pool state.
186 { # StatusCondition describes why a cluster or a node pool has a certain status
187 # (e.g., ERROR or DEGRADED).
188 "message": "A String", # Human-friendly representation of the condition
189 "code": "A String", # Machine-friendly representation of the condition
190 },
191 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "clusterConditions": [ # Which conditions caused the current cluster state.
193 { # StatusCondition describes why a cluster or a node pool has a certain status
194 # (e.g., ERROR or DEGRADED).
195 "message": "A String", # Human-friendly representation of the condition
196 "code": "A String", # Machine-friendly representation of the condition
197 },
198 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]199 "startTime": "A String", # [Output only] The time the operation started, in
200 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
201 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
202 "status": "A String", # Status of an operation stage.
203 # Unset for single-stage operations.
204 "metrics": [ # Progress metric bundle, for example:
205 # metrics: [{name: "nodes done", int_value: 15},
206 # {name: "nodes total", int_value: 32}]
207 # or
208 # metrics: [{name: "progress", double_value: 0.56},
209 # {name: "progress scale", double_value: 1.0}]
210 { # Progress metric is (string, int|float|string) pair.
211 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
212 "intValue": "A String", # For metrics with integer value.
213 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
214 "doubleValue": 3.14, # For metrics with floating point value.
215 },
216 ],
217 "stages": [ # Substages of an operation or a stage.
218 # Object with schema name: OperationProgress
219 ],
220 "name": "A String", # A non-parameterized string describing an operation stage.
221 # Unset for single-stage operations.
222 },
223 "endTime": "A String", # [Output only] The time the operation completed, in
224 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
225 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
226 "location": "A String", # [Output only] The name of the Google Compute Engine
227 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
228 # or
229 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
230 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 }</pre>
232</div>
233
234<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 <pre>Creates a cluster, consisting of the specified number and type of Google
237Compute Engine instances.
238
239By default, the cluster is created in the project's
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240[default
241network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242
243One firewall is added for the cluster. After cluster creation,
244the Kubelet creates routes for each node to allow the containers
245on that node to communicate with all other instances in the
246cluster.
247
248Finally, an entry is added to the project's global metadata indicating
249which CIDR range the cluster is using.
250
251Args:
252 parent: string, The parent (project and location) where the cluster will be created.
253Specified in the format 'projects/*/locations/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 The object takes the form of:
256
257{ # CreateClusterRequest creates a cluster.
258 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
259 # number](https://support.google.com/cloud/answer/6158840).
260 # This field has been deprecated and replaced by the parent field.
261 "parent": "A String", # The parent (project and location) where the cluster will be created.
262 # Specified in the format 'projects/*/locations/*'.
263 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
265 # cluster resides. This field has been deprecated and replaced by the parent
266 # field.
267 "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster
268 # resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting
270 # containers. This is provisioned from within the `container_ipv4_cidr`
271 # range. This field will only be set when cluster is in route-based network
272 # mode.
273 "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
274 "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]275 "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for
276 # maintenance to occur. The time windows may be overlapping. If no
277 # maintenance windows are set, maintenance can occur at any time.
278 "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
279 # this window reccurs. They go on for the span of time between the start and
280 # end time.
281 #
282 # For example, to have something repeat every weekday, you'd use:
283 # &lt;code&gt;FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR&lt;/code&gt;
284 # To repeat some window daily (equivalent to the DailyMaintenanceWindow):
285 # &lt;code&gt;FREQ=DAILY&lt;/code&gt;
286 # For the first weekend of every month:
287 # &lt;code&gt;FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU&lt;/code&gt;
288 # This specifies how frequently the window starts. Eg, if you wanted to have
289 # a 9-5 UTC-4 window every weekday, you'd use something like:
290 # &lt;code&gt;
291 # start time = 2019-01-01T09:00:00-0400
292 # end time = 2019-01-01T17:00:00-0400
293 # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
294 # &lt;/code&gt;
295 # Windows can span multiple days. Eg, to make the window encompass every
296 # weekend from midnight Saturday till the last minute of Sunday UTC:
297 # &lt;code&gt;
298 # start time = 2019-01-05T00:00:00Z
299 # end time = 2019-01-07T23:59:00Z
300 # recurrence = FREQ=WEEKLY;BYDAY=SA
301 # &lt;/code&gt;
302 # Note the start and end time's specific dates are largely arbitrary except
303 # to specify duration of the window and when it first starts.
304 # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
305 "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
306 "endTime": "A String", # The time that the window ends. The end time should take place after the
307 # start time.
308 "startTime": "A String", # The time that the window first starts.
309 },
310 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
312 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be
313 # smallest possible in the given scenario.
314 # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
315 # format "PTnHnMnS".
316 "startTime": "A String", # Time within the maintenance window to start the maintenance operations.
317 # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
318 # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
319 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320 "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not
321 # occur in these windows.
322 "a_key": { # Represents an arbitrary window of time.
323 "endTime": "A String", # The time that the window ends. The end time should take place after the
324 # start time.
325 "startTime": "A String", # The time that the window first starts.
326 },
327 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329 "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of
330 # the policy won't accidentally undo intermediate changes (and so that users
331 # of the API unaware of some fields won't accidentally remove other fields).
332 # Make a &lt;code&gt;get()&lt;/code&gt; request to the cluster to get the current
333 # resource version and include it with requests to set the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 },
335 "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.
336 # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
337 "enabled": True or False, # Whether network policy is enabled on the cluster.
338 "provider": "A String", # The selected network policy provider.
339 },
340 "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.
341 # master authorized networks will disallow all external traffic to access
342 # Kubernetes master through HTTPS except traffic from the given CIDR blocks,
343 # Google Compute Engine Public IPs and Google Prod IPs.
344 "enabled": True or False, # Whether or not master authorized networks is enabled.
345 "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access
346 # Kubernetes master through HTTPS.
347 { # CidrBlock contains an optional name and one CIDR block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 "cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349 "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 },
351 ],
352 },
353 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.
354 # cluster, enabling additional functionality.
355 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which
356 # makes it easy to set up HTTP load balancers for services in a cluster.
357 # which makes it easy to set up HTTP load balancers for services in a cluster.
358 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.
359 # When enabled, it runs a small pod in the cluster that manages the load
360 # balancers.
361 },
362 "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon
363 # is enabled or not on the Master, it does not track whether network policy
364 # is enabled for the nodes.
365 # is enabled or not on the Master, it does not track whether network policy
366 # is enabled for the nodes.
367 "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
368 },
369 "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.
370 # This addon is deprecated, and will be disabled in 1.15. It is recommended
371 # to use the Cloud Console to manage and monitor your Kubernetes clusters,
372 # workloads and applications. For more information, see:
373 # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
374 "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
375 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]376 "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a
377 # managed Knative service.
378 "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
379 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which
381 # increases or decreases the number of replica pods a replication controller
382 # has based on the resource usage of the existing pods.
383 # increases or decreases the number of replica pods a replication controller
384 # has based on the resource usage of the existing pods.
385 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 # When enabled, it ensures that metrics are collected into Stackdriver
387 # Monitoring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 },
389 },
390 "locations": [ # The list of Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]391 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
392 # cluster's nodes should be located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 "A String",
394 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]395 "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.
396 # mode.
397 "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,
398 # identities in the system, including service accounts, nodes, and
399 # controllers, will have statically granted permissions beyond those
400 # provided by the RBAC configuration or IAM.
401 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run
403 # simultaneously on a node in the node pool of this cluster. Only honored
404 # if cluster created with IP Alias support.
405 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
406 },
407 "network": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
409 # to which the cluster is connected. If left unspecified, the `default`
410 # network will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 "zone": "A String", # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
413 # cluster resides. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
415 "A String",
416 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "location": "A String", # [Output only] The name of the Google Compute Engine
418 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
419 # or
420 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
421 # in which the cluster resides.
422 "networkConfig": { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]424 # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the
425 # cluster is connected. Example:
426 # projects/my-project/regions/us-central1/subnetworks/my-subnet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]427 "network": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]428 # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
429 # to which the cluster is connected. Example:
430 # projects/my-project/global/networks/my-network
431 "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.
432 # This makes same node pod to pod traffic visible for VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 },
434 "name": "A String", # The name of this cluster. The name must be unique within this project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]435 # and location (e.g. zone or region), and can be up to 40 characters with
436 # the following restrictions:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 #
438 # * Lowercase letters, numbers, and hyphens only.
439 # * Must start with a letter.
440 # * Must end with a number or a letter.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
442 "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
443 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]447 "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then
448 # `cluster.cluster_ipv4_cidr` must be left blank.
449 #
450 # This field is only applicable when `use_ip_aliases` is true.
451 #
452 # Set to blank to have a range chosen with the default size.
453 #
454 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
455 # netmask.
456 #
457 # Set to a
458 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
459 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
460 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
461 # to use.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR
463 # block. The secondary range will be used for pod IP
464 # addresses. This must be an existing secondary range associated
465 # with the cluster subnetwork.
466 #
467 # This field is only applicable with use_ip_aliases is true and
468 # create_subnetwork is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range
470 # will be automatically chosen with the default size.
471 #
472 # This field is only applicable when `use_ip_aliases` is true.
473 #
474 # Set to blank to have a range chosen with the default size.
475 #
476 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
477 # netmask.
478 #
479 # Set to a
480 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
481 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
482 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
483 # to use.
484 "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.
485 #
486 # This field is only applicable when `use_ip_aliases` is true.
487 "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.
488 #
489 # This is applicable only if `create_subnetwork` is true.
490 #
491 # Set to blank to have a range chosen with the default size.
492 #
493 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
494 # netmask.
495 #
496 # Set to a
497 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
498 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
499 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
500 # to use.
501 "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a
502 # range will be automatically chosen with the default size.
503 #
504 # This field is only applicable when `use_ip_aliases` is true.
505 #
506 # If unspecified, the range will use the default size.
507 #
508 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
509 # netmask.
510 #
511 # Set to a
512 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
513 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
514 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
515 # to use.
516 "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
517 "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If
518 # this field is empty, then an automatic name will be chosen for the new
519 # subnetwork.
520 "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services
521 # CIDR block. The secondary range will be used for service
522 # ClusterIPs. This must be an existing secondary range associated
523 # with the cluster subnetwork.
524 #
525 # This field is only applicable with use_ip_aliases is true and
526 # create_subnetwork is false.
527 "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
528 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]529 "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM
530 # policies.
531 # policies.
532 "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
533 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is
535 # disabled when this config is unspecified.
536 "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
537 "datasetId": "A String", # The ID of a BigQuery Dataset.
538 },
539 "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a
540 # daemonset will be created in the cluster to meter network egress traffic.
541 "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
542 "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a
543 # second BigQuery table will be created to hold resource consumption
544 # records.
545 },
546 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]547 "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
548 "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.
549 "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.
550 "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are
551 # given only RFC 1918 private addresses and communicate with the master via
552 # private networking.
553 "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.
554 "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
555 # range will be used for assigning internal IP addresses to the master or
556 # set of masters, as well as the ILB VIP. This range must not overlap with
557 # any other ranges in use within the cluster's network.
558 "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
559 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 "conditions": [ # Which conditions caused the current cluster state.
561 { # StatusCondition describes why a cluster or a node pool has a certain status
562 # (e.g., ERROR or DEGRADED).
563 "message": "A String", # Human-friendly representation of the condition
564 "code": "A String", # Machine-friendly representation of the condition
565 },
566 ],
567 "statusMessage": "A String", # [Output only] Additional information about the current status of this
568 # cluster, if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]569 "resourceLabels": { # The resource labels for the cluster to use to annotate any related
570 # Google Compute Engine resources.
571 "a_key": "A String",
572 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "status": "A String", # [Output only] The current status of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]574 "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.
575 # required by Cluster Autoscaler to automatically adjust
576 # the size of the cluster and create/delete
577 # node pools based on the current needs.
578 "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool
579 # created by NAP.
580 # by NAP.
581 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
582 # service_account is specified, scopes should be empty.
583 "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.
584 # node pool.
585 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
586 # pool. If enabled, the nodes in this node pool will be monitored and, if
587 # they fail health checks too many times, an automatic repair action will be
588 # triggered.
589 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
590 # the Auto Upgrades will proceed.
591 "description": "A String", # [Output only] This field is set when upgrades are about to commence
592 # with the description of the upgrade.
593 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
594 # with the approximate start time for the upgrades, in
595 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
596 },
597 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
598 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
599 # up to date with the latest release version of Kubernetes.
600 },
601 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools
602 # disruption caused by an upgrade.
603 #
604 # maxUnavailable controls the number of nodes that can be simultaneously
605 # unavailable.
606 #
607 # maxSurge controls the number of additional nodes that can be added to the
608 # node pool temporarily for the time of the upgrade to increase the number of
609 # available nodes.
610 #
611 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
612 # nodes are being upgraded at the same time).
613 #
614 # Note: upgrades inevitably introduce some disruption since workloads need to
615 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
616 # this holds true. (Disruption stays within the limits of
617 # PodDisruptionBudget, if it is configured.)
618 #
619 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
620 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
621 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
622 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
623 # there are always at least 4 nodes available.
624 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
625 # of the node pool during the upgrade process.
626 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
627 # the upgrade process. A node is considered available if its status is
628 # Ready.
629 },
630 "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are
631 # specified, service_account should be empty.
632 "A String",
633 ],
634 },
635 "resourceLimits": [ # Contains global constraints regarding minimum and maximum
636 # amount of resources in the cluster.
637 { # Contains information about amount of some resource in the cluster.
638 # For memory, value should be in GB.
639 "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
640 "minimum": "A String", # Minimum amount of the resource in the cluster.
641 "maximum": "A String", # Maximum amount of the resource in the cluster.
642 },
643 ],
644 "autoprovisioningLocations": [ # The list of Google Compute Engine
645 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
646 # NodePool's nodes can be created by NAP.
647 "A String",
648 ],
649 "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
650 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]651 "description": "A String", # An optional description of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]652 "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
653 "state": "A String", # Denotes the state of etcd encryption.
654 "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.
655 # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
656 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]657 "currentNodeVersion": "A String", # [Output only] Deprecated, use
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]658 # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]659 # instead. The current version of the node software components. If they are
660 # currently at multiple versions because they're in the process of being
661 # upgraded, this reflects the minimum version of all nodes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]662 "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
663 "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container
664 # images will be validated by Binary Authorization.
665 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]666 "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
667 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
668 "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.
669 # If unspecified, the defaults are used:
670 # For clusters before v1.12, if master_auth is unspecified, `username` will
671 # be set to "admin", a random password will be generated, and a client
672 # certificate will be issued.
673 # Authentication can be done using HTTP basic auth or using client
674 # certificates.
675 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
676 # For clusters v1.6.0 and later, basic authentication can be disabled by
677 # leaving username unspecified (or setting it to the empty string).
678 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate
679 # to the cluster endpoint.
680 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to
681 # authenticate to the cluster endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]682 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of
683 # trust for the cluster.
684 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint.
685 # Because the master endpoint is open to the Internet, you should create a
686 # strong password. If a password is provided for cluster creation, username
687 # must be non-empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]688 "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For
689 # clusters before v1.12, if no configuration is specified, a client
690 # certificate is issued.
691 "issueClientCertificate": True or False, # Issue a client certificate.
692 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]693 },
694 "expireTime": "A String", # [Output only] The time the cluster will be automatically
695 # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
696 "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in
697 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
698 # notation (e.g. `1.2.3.4/29`).
699 "nodePools": [ # The node pools associated with this cluster.
700 # This field should not be set if "node_config" or "initial_node_count" are
701 # specified.
702 { # NodePool contains the name and configuration for a cluster's node pool.
703 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
704 # specification, under the control of the cluster master. They may have a set
705 # of Kubernetes labels applied to them, which may be used to reference them
706 # during pod scheduling. They may also be resized up or down, to accommodate
707 # the workload.
708 "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^]709 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]710 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
711 # node pool.
712 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
713 # pool. If enabled, the nodes in this node pool will be monitored and, if
714 # they fail health checks too many times, an automatic repair action will be
715 # triggered.
716 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
717 # the Auto Upgrades will proceed.
718 "description": "A String", # [Output only] This field is set when upgrades are about to commence
719 # with the description of the upgrade.
720 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
721 # with the approximate start time for the upgrades, in
722 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
723 },
724 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
725 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
726 # up to date with the latest release version of Kubernetes.
727 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]728 "name": "A String", # The name of the node pool.
729 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
730 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
731 # associated with this node pool.
732 "A String",
733 ],
734 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
735 # only if a valid configuration is present.
736 # adjust the size of the node pool to the current cluster usage.
737 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
738 # max_node_count.
739 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
740 "enabled": True or False, # Is autoscaling enabled for this node pool.
741 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
742 # has to enough quota to scale up the cluster.
743 },
744 "locations": [ # The list of Google Compute Engine
745 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
746 # NodePool's nodes should be located.
747 "A String",
748 ],
749 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
750 # simultaneously on a node in the node pool.
751 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
752 },
753 "version": "A String", # The version of the Kubernetes of this node.
754 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
755 # disruption caused by an upgrade.
756 #
757 # maxUnavailable controls the number of nodes that can be simultaneously
758 # unavailable.
759 #
760 # maxSurge controls the number of additional nodes that can be added to the
761 # node pool temporarily for the time of the upgrade to increase the number of
762 # available nodes.
763 #
764 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
765 # nodes are being upgraded at the same time).
766 #
767 # Note: upgrades inevitably introduce some disruption since workloads need to
768 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
769 # this holds true. (Disruption stays within the limits of
770 # PodDisruptionBudget, if it is configured.)
771 #
772 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
773 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
774 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
775 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
776 # there are always at least 4 nodes available.
777 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
778 # of the node pool during the upgrade process.
779 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
780 # the upgrade process. A node is considered available if its status is
781 # Ready.
782 },
783 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
784 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
785 # is sufficient for this number of instances. You must also have available
786 # firewall and routes quota.
787 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]788 "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^]789 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
790 # the specified [Zonal Compute
791 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
792 # to this node pool.
793 # is the configuration of desired reservation which instances could take
794 # capacity from.
795 "values": [ # Corresponds to the label value(s) of reservation resource(s).
796 "A String",
797 ],
798 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
799 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
800 # the key and specify the name of your reservation as its value.
801 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
802 },
803 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
804 "type": "A String", # Type of the sandbox to use for the node.
805 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]806 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]807 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]808 # `n1-standard-1`).
809 #
810 # If unspecified, the default machine type is
811 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]812 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
813 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
814 #
815 # Enables monitoring and attestation of the boot integrity of the instance.
816 # The attestation is performed against the integrity policy baseline. This
817 # baseline is initially derived from the implicitly trusted boot image when
818 # the instance is created.
819 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
820 #
821 # Secure Boot helps ensure that the system only runs authentic software by
822 # verifying the digital signature of all boot components, and halting the
823 # boot process if signature verification fails.
824 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
826 # valid sources or targets for network firewalls and are specified by
827 # the client during cluster or node pool creation. Each tag within the list
828 # must comply with RFC1035.
829 "A String",
830 ],
831 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
832 # https://cloud.google.com/compute/docs/instances/preemptible for more
833 # information about preemptible VM instances.
834 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
835 # These will added in addition to any default label(s) that
836 # Kubernetes may apply to the node.
837 # In case of conflict in label keys, the applied set may differ depending on
838 # the Kubernetes version -- it's best to assume the behavior is undefined
839 # and conflicts should be avoided.
840 # For more information, including usage and the valid values, see:
841 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
842 "a_key": "A String",
843 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]844 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
845 # Specify the email address of the Service Account; otherwise, if no Service
846 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]847 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
848 # node VMs under the "default" service account.
849 #
850 # The following scopes are recommended, but not required, and by default are
851 # not included:
852 #
853 # * `https://www.googleapis.com/auth/compute` is required for mounting
854 # persistent storage on your nodes.
855 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
856 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]857 # (the [Google Container
858 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]859 #
860 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
861 # Monitoring are enabled, in which case their required scopes will be added.
862 "A String",
863 ],
864 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
865 #
866 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]867 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
868 # workloads on the node pool.
869 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
870 # on the node pool.
871 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]872 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
873 # The smallest allowed disk size is 10GB.
874 #
875 # If unspecified, the default disk size is 100GB.
876 "accelerators": [ # A list of hardware accelerators to be attached to each node.
877 # See https://cloud.google.com/compute/docs/gpus for more information about
878 # support for GPUs.
879 { # AcceleratorConfig represents a Hardware Accelerator request.
880 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
881 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]882 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]883 },
884 ],
885 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
886 # scheduled on the specified or newer CPU platform. Applicable values are the
887 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]888 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
889 # &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]890 # information, read [how to specify min CPU
891 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
892 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
893 #
894 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
895 # in length. These are reflected as part of a URL in the metadata server.
896 # Additionally, to avoid ambiguity, keys must not conflict with any other
897 # metadata keys for the project or be one of the reserved keys:
898 # "cluster-location"
899 # "cluster-name"
900 # "cluster-uid"
901 # "configure-sh"
902 # "containerd-configure-sh"
903 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]904 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]905 # "gci-metrics-enabled"
906 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]907 # "instance-template"
908 # "kube-env"
909 # "startup-script"
910 # "user-data"
911 # "disable-address-manager"
912 # "windows-startup-script-ps1"
913 # "common-psm1"
914 # "k8s-node-setup-psm1"
915 # "install-ssh-psm1"
916 # "user-profile-psm1"
917 # "serial-port-logging-enable"
918 #
919 # Values are free-form strings, and only have meaning as interpreted by
920 # the image running in the instance. The only restriction placed on them is
921 # that each value's size must be less than or equal to 32 KB.
922 #
923 # The total size of all keys and values must be less than 512 KB.
924 "a_key": "A String",
925 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]926 "taints": [ # List of kubernetes taints to be applied to each node.
927 #
928 # For more information, including usage and the valid values, see:
929 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
930 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
931 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
932 #
933 # For more information, including usage and the valid values, see:
934 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
935 "value": "A String", # Value for taint.
936 "key": "A String", # Key for taint.
937 "effect": "A String", # Effect for taint.
938 },
939 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]940 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
941 # the latest version of it will be used.
942 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
943 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]945 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]946 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]947 # for more information.
948 },
949 "conditions": [ # Which conditions caused the current node pool state.
950 { # StatusCondition describes why a cluster or a node pool has a certain status
951 # (e.g., ERROR or DEGRADED).
952 "message": "A String", # Human-friendly representation of the condition
953 "code": "A String", # Machine-friendly representation of the condition
954 },
955 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]956 "statusMessage": "A String", # [Output only] Additional information about the current status of this
957 # node pool instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]958 },
959 ],
960 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics.
961 # Currently available options:
962 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]963 # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
964 # service with a Kubernetes-native resource model
965 # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
966 # longer available as of GKE 1.15).
967 # * `none` - No metrics will be exported from the cluster.
968 #
969 # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
970 # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]971 "createTime": "A String", # [Output only] The time the cluster was created, in
972 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]973 "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
974 "enabled": True or False, # Whether this cluster should return group membership lookups
975 # during authentication using a group of security groups.
976 "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant
977 # if enabled = true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]979 "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]980 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.
981 # The endpoint can be accessed from the internet at
982 # `https://username:password@endpoint/`.
983 #
984 # See the `masterAuth` property of this resource for username and
985 # password information.
986 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.
987 # Call Kubernetes API directly to retrieve node information.
988 "loggingService": "A String", # The logging service the cluster should use to write logs.
989 # Currently available options:
990 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]991 # * `logging.googleapis.com/kubernetes` - The Cloud Logging
992 # service with a Kubernetes-native resource model
993 # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
994 # available as of GKE 1.15).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]995 # * `none` - no logs will be exported from the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]996 #
997 # If left as an empty string,`logging.googleapis.com/kubernetes` will be
998 # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
999 "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.
1000 # required by Vertical Pod Autoscaler to automatically adjust
1001 # the resources of pods controlled by it.
1002 "enabled": True or False, # Enables vertical pod autoscaling.
1003 },
1004 "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha
1005 # API groups (e.g. v1alpha1) and features that may not be production ready in
1006 # the kubernetes version of the master and nodes.
1007 # The cluster has no SLA for uptime and master/node upgrades are disabled.
1008 # Alpha enabled clusters are automatically deleted thirty days after
1009 # creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1010 "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those
1011 # found in validMasterVersions returned by getServerConfig. The version can
1012 # be upgraded over time; such upgrades are reflected in
1013 # currentMasterVersion and currentNodeVersion.
1014 #
1015 # Users may specify either explicit versions offered by
1016 # Kubernetes Engine or version aliases, which have the following behavior:
1017 #
1018 # - "latest": picks the highest valid Kubernetes version
1019 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
1020 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
1021 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
1022 # - "","-": picks the default Kubernetes version
1023 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.
1024 # For requests, this field should only be used in lieu of a
1025 # "node_pool" object, since this configuration (along with the
1026 # "initial_node_count") will be used to create a "NodePool" object with an
1027 # auto-generated name. Do not use this and a node_pool at the same time.
1028 # For responses, this field will be populated with the node configuration of
1029 # the first node pool. (For configuration of each node pool, see
1030 # `node_pool.config`)
1031 #
1032 # If unspecified, the defaults are used.
1033 # This field is deprecated, use node_pool.config instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1034 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
1035 # the specified [Zonal Compute
1036 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
1037 # to this node pool.
1038 # is the configuration of desired reservation which instances could take
1039 # capacity from.
1040 "values": [ # Corresponds to the label value(s) of reservation resource(s).
1041 "A String",
1042 ],
1043 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
1044 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
1045 # the key and specify the name of your reservation as its value.
1046 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
1047 },
1048 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1049 "type": "A String", # Type of the sandbox to use for the node.
1050 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1051 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1052 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1053 # `n1-standard-1`).
1054 #
1055 # If unspecified, the default machine type is
1056 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1057 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
1058 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
1059 #
1060 # Enables monitoring and attestation of the boot integrity of the instance.
1061 # The attestation is performed against the integrity policy baseline. This
1062 # baseline is initially derived from the implicitly trusted boot image when
1063 # the instance is created.
1064 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
1065 #
1066 # Secure Boot helps ensure that the system only runs authentic software by
1067 # verifying the digital signature of all boot components, and halting the
1068 # boot process if signature verification fails.
1069 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1070 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
1071 # valid sources or targets for network firewalls and are specified by
1072 # the client during cluster or node pool creation. Each tag within the list
1073 # must comply with RFC1035.
1074 "A String",
1075 ],
1076 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
1077 # https://cloud.google.com/compute/docs/instances/preemptible for more
1078 # information about preemptible VM instances.
1079 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
1080 # These will added in addition to any default label(s) that
1081 # Kubernetes may apply to the node.
1082 # In case of conflict in label keys, the applied set may differ depending on
1083 # the Kubernetes version -- it's best to assume the behavior is undefined
1084 # and conflicts should be avoided.
1085 # For more information, including usage and the valid values, see:
1086 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1087 "a_key": "A String",
1088 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1089 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
1090 # Specify the email address of the Service Account; otherwise, if no Service
1091 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1092 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
1093 # node VMs under the "default" service account.
1094 #
1095 # The following scopes are recommended, but not required, and by default are
1096 # not included:
1097 #
1098 # * `https://www.googleapis.com/auth/compute` is required for mounting
1099 # persistent storage on your nodes.
1100 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
1101 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1102 # (the [Google Container
1103 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1104 #
1105 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
1106 # Monitoring are enabled, in which case their required scopes will be added.
1107 "A String",
1108 ],
1109 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
1110 #
1111 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1112 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
1113 # workloads on the node pool.
1114 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
1115 # on the node pool.
1116 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1117 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
1118 # The smallest allowed disk size is 10GB.
1119 #
1120 # If unspecified, the default disk size is 100GB.
1121 "accelerators": [ # A list of hardware accelerators to be attached to each node.
1122 # See https://cloud.google.com/compute/docs/gpus for more information about
1123 # support for GPUs.
1124 { # AcceleratorConfig represents a Hardware Accelerator request.
1125 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
1126 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1127 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1128 },
1129 ],
1130 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
1131 # scheduled on the specified or newer CPU platform. Applicable values are the
1132 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1133 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
1134 # &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]1135 # information, read [how to specify min CPU
1136 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1137 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
1138 #
1139 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
1140 # in length. These are reflected as part of a URL in the metadata server.
1141 # Additionally, to avoid ambiguity, keys must not conflict with any other
1142 # metadata keys for the project or be one of the reserved keys:
1143 # "cluster-location"
1144 # "cluster-name"
1145 # "cluster-uid"
1146 # "configure-sh"
1147 # "containerd-configure-sh"
1148 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1149 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1150 # "gci-metrics-enabled"
1151 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1152 # "instance-template"
1153 # "kube-env"
1154 # "startup-script"
1155 # "user-data"
1156 # "disable-address-manager"
1157 # "windows-startup-script-ps1"
1158 # "common-psm1"
1159 # "k8s-node-setup-psm1"
1160 # "install-ssh-psm1"
1161 # "user-profile-psm1"
1162 # "serial-port-logging-enable"
1163 #
1164 # Values are free-form strings, and only have meaning as interpreted by
1165 # the image running in the instance. The only restriction placed on them is
1166 # that each value's size must be less than or equal to 32 KB.
1167 #
1168 # The total size of all keys and values must be less than 512 KB.
1169 "a_key": "A String",
1170 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1171 "taints": [ # List of kubernetes taints to be applied to each node.
1172 #
1173 # For more information, including usage and the valid values, see:
1174 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1175 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
1176 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
1177 #
1178 # For more information, including usage and the valid values, see:
1179 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1180 "value": "A String", # Value for taint.
1181 "key": "A String", # Key for taint.
1182 "effect": "A String", # Effect for taint.
1183 },
1184 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1185 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
1186 # the latest version of it will be used.
1187 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
1188 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1189 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1190 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1191 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1192 # for more information.
1193 },
1194 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in
1195 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1196 # notation (e.g. `10.96.0.0/14`). Leave blank to have
1197 # one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
1198 "subnetwork": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1199 # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which
1200 # the cluster is connected.
1201 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in
1202 # this cluster, in
1203 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1204 # notation (e.g. `1.2.3.4/29`). Service addresses are
1205 # typically put in the last `/16` from the container CIDR.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1206 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
1207 "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1208 # 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]1209 # is sufficient for this number of instances. You must also have available
1210 # firewall and routes quota.
1211 # For requests, this field should only be used in lieu of a
1212 # "node_pool" object, since this configuration (along with the
1213 # "node_config") will be used to create a "NodePool" object with an
1214 # auto-generated name. Do not use this and a node_pool at the same time.
1215 #
1216 # This field is deprecated, use node_pool.initial_node_count instead.
1217 },
1218 }
1219
1220 x__xgafv: string, V1 error format.
1221 Allowed values
1222 1 - v1 error format
1223 2 - v2 error format
1224
1225Returns:
1226 An object of the form:
1227
1228 { # This operation resource represents operations that may have happened or are
1229 # happening on the cluster. All fields are output only.
1230 "status": "A String", # The current status of the operation.
1231 "selfLink": "A String", # Server-defined URL for the resource.
1232 "name": "A String", # The server-assigned ID for the operation.
1233 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1234 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1235 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1236 "detail": "A String", # Detailed operation progress, if available.
1237 "operationType": "A String", # The operation type.
1238 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1239 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1240 { # StatusCondition describes why a cluster or a node pool has a certain status
1241 # (e.g., ERROR or DEGRADED).
1242 "message": "A String", # Human-friendly representation of the condition
1243 "code": "A String", # Machine-friendly representation of the condition
1244 },
1245 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1246 "clusterConditions": [ # Which conditions caused the current cluster state.
1247 { # StatusCondition describes why a cluster or a node pool has a certain status
1248 # (e.g., ERROR or DEGRADED).
1249 "message": "A String", # Human-friendly representation of the condition
1250 "code": "A String", # Machine-friendly representation of the condition
1251 },
1252 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1253 "startTime": "A String", # [Output only] The time the operation started, in
1254 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1255 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1256 "status": "A String", # Status of an operation stage.
1257 # Unset for single-stage operations.
1258 "metrics": [ # Progress metric bundle, for example:
1259 # metrics: [{name: "nodes done", int_value: 15},
1260 # {name: "nodes total", int_value: 32}]
1261 # or
1262 # metrics: [{name: "progress", double_value: 0.56},
1263 # {name: "progress scale", double_value: 1.0}]
1264 { # Progress metric is (string, int|float|string) pair.
1265 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1266 "intValue": "A String", # For metrics with integer value.
1267 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1268 "doubleValue": 3.14, # For metrics with floating point value.
1269 },
1270 ],
1271 "stages": [ # Substages of an operation or a stage.
1272 # Object with schema name: OperationProgress
1273 ],
1274 "name": "A String", # A non-parameterized string describing an operation stage.
1275 # Unset for single-stage operations.
1276 },
1277 "endTime": "A String", # [Output only] The time the operation completed, in
1278 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1279 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1280 "location": "A String", # [Output only] The name of the Google Compute Engine
1281 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1282 # or
1283 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1284 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1285 }</pre>
1286</div>
1287
1288<div class="method">
1289 <code class="details" id="delete">delete(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</code>
1290 <pre>Deletes the cluster, including the Kubernetes endpoint and all worker
1291nodes.
1292
1293Firewalls and routes that were configured during cluster creation
1294are also deleted.
1295
1296Other Google Compute Engine resources that might be in use by the cluster,
1297such as load balancer resources, are not deleted if they weren't present
1298when the cluster was initially created.
1299
1300Args:
1301 name: string, The name (project, location, cluster) of the cluster to delete.
1302Specified in the format 'projects/*/locations/*/clusters/*'. (required)
1303 projectId: string, Deprecated. The Google Developers Console [project ID or project
1304number](https://support.google.com/cloud/answer/6158840).
1305This field has been deprecated and replaced by the name field.
1306 clusterId: string, Deprecated. The name of the cluster to delete.
1307This field has been deprecated and replaced by the name field.
1308 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1309[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1310cluster resides. This field has been deprecated and replaced by the name
1311field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1312 x__xgafv: string, V1 error format.
1313 Allowed values
1314 1 - v1 error format
1315 2 - v2 error format
1316
1317Returns:
1318 An object of the form:
1319
1320 { # This operation resource represents operations that may have happened or are
1321 # happening on the cluster. All fields are output only.
1322 "status": "A String", # The current status of the operation.
1323 "selfLink": "A String", # Server-defined URL for the resource.
1324 "name": "A String", # The server-assigned ID for the operation.
1325 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1326 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1327 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1328 "detail": "A String", # Detailed operation progress, if available.
1329 "operationType": "A String", # The operation type.
1330 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1331 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1332 { # StatusCondition describes why a cluster or a node pool has a certain status
1333 # (e.g., ERROR or DEGRADED).
1334 "message": "A String", # Human-friendly representation of the condition
1335 "code": "A String", # Machine-friendly representation of the condition
1336 },
1337 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1338 "clusterConditions": [ # Which conditions caused the current cluster state.
1339 { # StatusCondition describes why a cluster or a node pool has a certain status
1340 # (e.g., ERROR or DEGRADED).
1341 "message": "A String", # Human-friendly representation of the condition
1342 "code": "A String", # Machine-friendly representation of the condition
1343 },
1344 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1345 "startTime": "A String", # [Output only] The time the operation started, in
1346 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1347 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
1348 "status": "A String", # Status of an operation stage.
1349 # Unset for single-stage operations.
1350 "metrics": [ # Progress metric bundle, for example:
1351 # metrics: [{name: "nodes done", int_value: 15},
1352 # {name: "nodes total", int_value: 32}]
1353 # or
1354 # metrics: [{name: "progress", double_value: 0.56},
1355 # {name: "progress scale", double_value: 1.0}]
1356 { # Progress metric is (string, int|float|string) pair.
1357 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1358 "intValue": "A String", # For metrics with integer value.
1359 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
1360 "doubleValue": 3.14, # For metrics with floating point value.
1361 },
1362 ],
1363 "stages": [ # Substages of an operation or a stage.
1364 # Object with schema name: OperationProgress
1365 ],
1366 "name": "A String", # A non-parameterized string describing an operation stage.
1367 # Unset for single-stage operations.
1368 },
1369 "endTime": "A String", # [Output only] The time the operation completed, in
1370 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1371 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
1372 "location": "A String", # [Output only] The name of the Google Compute Engine
1373 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1374 # or
1375 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1376 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1377 }</pre>
1378</div>
1379
1380<div class="method">
1381 <code class="details" id="get">get(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</code>
1382 <pre>Gets the details of a specific cluster.
1383
1384Args:
1385 name: string, The name (project, location, cluster) of the cluster to retrieve.
1386Specified in the format 'projects/*/locations/*/clusters/*'. (required)
1387 projectId: string, Deprecated. The Google Developers Console [project ID or project
1388number](https://support.google.com/cloud/answer/6158840).
1389This field has been deprecated and replaced by the name field.
1390 clusterId: string, Deprecated. The name of the cluster to retrieve.
1391This field has been deprecated and replaced by the name field.
1392 zone: string, Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1393[zone](https://cloud.google.com/compute/docs/zones#available) in which the
1394cluster resides. This field has been deprecated and replaced by the name
1395field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1396 x__xgafv: string, V1 error format.
1397 Allowed values
1398 1 - v1 error format
1399 2 - v2 error format
1400
1401Returns:
1402 An object of the form:
1403
1404 { # A Google Kubernetes Engine cluster.
1405 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting
1406 # containers. This is provisioned from within the `container_ipv4_cidr`
1407 # range. This field will only be set when cluster is in route-based network
1408 # mode.
1409 "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
1410 "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1411 "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for
1412 # maintenance to occur. The time windows may be overlapping. If no
1413 # maintenance windows are set, maintenance can occur at any time.
1414 "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
1415 # this window reccurs. They go on for the span of time between the start and
1416 # end time.
1417 #
1418 # For example, to have something repeat every weekday, you'd use:
1419 # &lt;code&gt;FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR&lt;/code&gt;
1420 # To repeat some window daily (equivalent to the DailyMaintenanceWindow):
1421 # &lt;code&gt;FREQ=DAILY&lt;/code&gt;
1422 # For the first weekend of every month:
1423 # &lt;code&gt;FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU&lt;/code&gt;
1424 # This specifies how frequently the window starts. Eg, if you wanted to have
1425 # a 9-5 UTC-4 window every weekday, you'd use something like:
1426 # &lt;code&gt;
1427 # start time = 2019-01-01T09:00:00-0400
1428 # end time = 2019-01-01T17:00:00-0400
1429 # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
1430 # &lt;/code&gt;
1431 # Windows can span multiple days. Eg, to make the window encompass every
1432 # weekend from midnight Saturday till the last minute of Sunday UTC:
1433 # &lt;code&gt;
1434 # start time = 2019-01-05T00:00:00Z
1435 # end time = 2019-01-07T23:59:00Z
1436 # recurrence = FREQ=WEEKLY;BYDAY=SA
1437 # &lt;/code&gt;
1438 # Note the start and end time's specific dates are largely arbitrary except
1439 # to specify duration of the window and when it first starts.
1440 # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
1441 "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
1442 "endTime": "A String", # The time that the window ends. The end time should take place after the
1443 # start time.
1444 "startTime": "A String", # The time that the window first starts.
1445 },
1446 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1447 "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
1448 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be
1449 # smallest possible in the given scenario.
1450 # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
1451 # format "PTnHnMnS".
1452 "startTime": "A String", # Time within the maintenance window to start the maintenance operations.
1453 # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
1454 # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
1455 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1456 "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not
1457 # occur in these windows.
1458 "a_key": { # Represents an arbitrary window of time.
1459 "endTime": "A String", # The time that the window ends. The end time should take place after the
1460 # start time.
1461 "startTime": "A String", # The time that the window first starts.
1462 },
1463 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1464 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1465 "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of
1466 # the policy won't accidentally undo intermediate changes (and so that users
1467 # of the API unaware of some fields won't accidentally remove other fields).
1468 # Make a &lt;code&gt;get()&lt;/code&gt; request to the cluster to get the current
1469 # resource version and include it with requests to set the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1470 },
1471 "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.
1472 # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
1473 "enabled": True or False, # Whether network policy is enabled on the cluster.
1474 "provider": "A String", # The selected network policy provider.
1475 },
1476 "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.
1477 # master authorized networks will disallow all external traffic to access
1478 # Kubernetes master through HTTPS except traffic from the given CIDR blocks,
1479 # Google Compute Engine Public IPs and Google Prod IPs.
1480 "enabled": True or False, # Whether or not master authorized networks is enabled.
1481 "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access
1482 # Kubernetes master through HTTPS.
1483 { # CidrBlock contains an optional name and one CIDR block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1484 "cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1485 "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1486 },
1487 ],
1488 },
1489 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.
1490 # cluster, enabling additional functionality.
1491 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which
1492 # makes it easy to set up HTTP load balancers for services in a cluster.
1493 # which makes it easy to set up HTTP load balancers for services in a cluster.
1494 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.
1495 # When enabled, it runs a small pod in the cluster that manages the load
1496 # balancers.
1497 },
1498 "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon
1499 # is enabled or not on the Master, it does not track whether network policy
1500 # is enabled for the nodes.
1501 # is enabled or not on the Master, it does not track whether network policy
1502 # is enabled for the nodes.
1503 "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
1504 },
1505 "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.
1506 # This addon is deprecated, and will be disabled in 1.15. It is recommended
1507 # to use the Cloud Console to manage and monitor your Kubernetes clusters,
1508 # workloads and applications. For more information, see:
1509 # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
1510 "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
1511 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1512 "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a
1513 # managed Knative service.
1514 "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
1515 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1516 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which
1517 # increases or decreases the number of replica pods a replication controller
1518 # has based on the resource usage of the existing pods.
1519 # increases or decreases the number of replica pods a replication controller
1520 # has based on the resource usage of the existing pods.
1521 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1522 # When enabled, it ensures that metrics are collected into Stackdriver
1523 # Monitoring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1524 },
1525 },
1526 "locations": [ # The list of Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1527 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1528 # cluster's nodes should be located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1529 "A String",
1530 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1531 "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.
1532 # mode.
1533 "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,
1534 # identities in the system, including service accounts, nodes, and
1535 # controllers, will have statically granted permissions beyond those
1536 # provided by the RBAC configuration or IAM.
1537 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1538 "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run
1539 # simultaneously on a node in the node pool of this cluster. Only honored
1540 # if cluster created with IP Alias support.
1541 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
1542 },
1543 "network": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1544 # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
1545 # to which the cluster is connected. If left unspecified, the `default`
1546 # network will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1547 "zone": "A String", # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1548 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
1549 # cluster resides. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1550 "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
1551 "A String",
1552 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1553 "location": "A String", # [Output only] The name of the Google Compute Engine
1554 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1555 # or
1556 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
1557 # in which the cluster resides.
1558 "networkConfig": { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1559 "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1560 # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the
1561 # cluster is connected. Example:
1562 # projects/my-project/regions/us-central1/subnetworks/my-subnet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1563 "network": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1564 # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
1565 # to which the cluster is connected. Example:
1566 # projects/my-project/global/networks/my-network
1567 "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.
1568 # This makes same node pod to pod traffic visible for VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1569 },
1570 "name": "A String", # The name of this cluster. The name must be unique within this project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1571 # and location (e.g. zone or region), and can be up to 40 characters with
1572 # the following restrictions:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1573 #
1574 # * Lowercase letters, numbers, and hyphens only.
1575 # * Must start with a letter.
1576 # * Must end with a number or a letter.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1577 "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
1578 "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
1579 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1580 "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1581 "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1582 "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1583 "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then
1584 # `cluster.cluster_ipv4_cidr` must be left blank.
1585 #
1586 # This field is only applicable when `use_ip_aliases` is true.
1587 #
1588 # Set to blank to have a range chosen with the default size.
1589 #
1590 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
1591 # netmask.
1592 #
1593 # Set to a
1594 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1595 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
1596 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
1597 # to use.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1598 "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR
1599 # block. The secondary range will be used for pod IP
1600 # addresses. This must be an existing secondary range associated
1601 # with the cluster subnetwork.
1602 #
1603 # This field is only applicable with use_ip_aliases is true and
1604 # create_subnetwork is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1605 "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range
1606 # will be automatically chosen with the default size.
1607 #
1608 # This field is only applicable when `use_ip_aliases` is true.
1609 #
1610 # Set to blank to have a range chosen with the default size.
1611 #
1612 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
1613 # netmask.
1614 #
1615 # Set to a
1616 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1617 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
1618 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
1619 # to use.
1620 "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.
1621 #
1622 # This field is only applicable when `use_ip_aliases` is true.
1623 "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.
1624 #
1625 # This is applicable only if `create_subnetwork` is true.
1626 #
1627 # Set to blank to have a range chosen with the default size.
1628 #
1629 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
1630 # netmask.
1631 #
1632 # Set to a
1633 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1634 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
1635 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
1636 # to use.
1637 "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a
1638 # range will be automatically chosen with the default size.
1639 #
1640 # This field is only applicable when `use_ip_aliases` is true.
1641 #
1642 # If unspecified, the range will use the default size.
1643 #
1644 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
1645 # netmask.
1646 #
1647 # Set to a
1648 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1649 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
1650 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
1651 # to use.
1652 "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
1653 "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If
1654 # this field is empty, then an automatic name will be chosen for the new
1655 # subnetwork.
1656 "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services
1657 # CIDR block. The secondary range will be used for service
1658 # ClusterIPs. This must be an existing secondary range associated
1659 # with the cluster subnetwork.
1660 #
1661 # This field is only applicable with use_ip_aliases is true and
1662 # create_subnetwork is false.
1663 "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
1664 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1665 "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM
1666 # policies.
1667 # policies.
1668 "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
1669 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1670 "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is
1671 # disabled when this config is unspecified.
1672 "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
1673 "datasetId": "A String", # The ID of a BigQuery Dataset.
1674 },
1675 "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a
1676 # daemonset will be created in the cluster to meter network egress traffic.
1677 "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
1678 "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a
1679 # second BigQuery table will be created to hold resource consumption
1680 # records.
1681 },
1682 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1683 "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
1684 "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.
1685 "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.
1686 "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are
1687 # given only RFC 1918 private addresses and communicate with the master via
1688 # private networking.
1689 "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.
1690 "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
1691 # range will be used for assigning internal IP addresses to the master or
1692 # set of masters, as well as the ILB VIP. This range must not overlap with
1693 # any other ranges in use within the cluster's network.
1694 "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
1695 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1696 "conditions": [ # Which conditions caused the current cluster state.
1697 { # StatusCondition describes why a cluster or a node pool has a certain status
1698 # (e.g., ERROR or DEGRADED).
1699 "message": "A String", # Human-friendly representation of the condition
1700 "code": "A String", # Machine-friendly representation of the condition
1701 },
1702 ],
1703 "statusMessage": "A String", # [Output only] Additional information about the current status of this
1704 # cluster, if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1705 "resourceLabels": { # The resource labels for the cluster to use to annotate any related
1706 # Google Compute Engine resources.
1707 "a_key": "A String",
1708 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1709 "status": "A String", # [Output only] The current status of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1710 "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.
1711 # required by Cluster Autoscaler to automatically adjust
1712 # the size of the cluster and create/delete
1713 # node pools based on the current needs.
1714 "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool
1715 # created by NAP.
1716 # by NAP.
1717 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
1718 # service_account is specified, scopes should be empty.
1719 "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.
1720 # node pool.
1721 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
1722 # pool. If enabled, the nodes in this node pool will be monitored and, if
1723 # they fail health checks too many times, an automatic repair action will be
1724 # triggered.
1725 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1726 # the Auto Upgrades will proceed.
1727 "description": "A String", # [Output only] This field is set when upgrades are about to commence
1728 # with the description of the upgrade.
1729 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
1730 # with the approximate start time for the upgrades, in
1731 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1732 },
1733 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
1734 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
1735 # up to date with the latest release version of Kubernetes.
1736 },
1737 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools
1738 # disruption caused by an upgrade.
1739 #
1740 # maxUnavailable controls the number of nodes that can be simultaneously
1741 # unavailable.
1742 #
1743 # maxSurge controls the number of additional nodes that can be added to the
1744 # node pool temporarily for the time of the upgrade to increase the number of
1745 # available nodes.
1746 #
1747 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
1748 # nodes are being upgraded at the same time).
1749 #
1750 # Note: upgrades inevitably introduce some disruption since workloads need to
1751 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
1752 # this holds true. (Disruption stays within the limits of
1753 # PodDisruptionBudget, if it is configured.)
1754 #
1755 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
1756 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
1757 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
1758 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
1759 # there are always at least 4 nodes available.
1760 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
1761 # of the node pool during the upgrade process.
1762 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
1763 # the upgrade process. A node is considered available if its status is
1764 # Ready.
1765 },
1766 "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are
1767 # specified, service_account should be empty.
1768 "A String",
1769 ],
1770 },
1771 "resourceLimits": [ # Contains global constraints regarding minimum and maximum
1772 # amount of resources in the cluster.
1773 { # Contains information about amount of some resource in the cluster.
1774 # For memory, value should be in GB.
1775 "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
1776 "minimum": "A String", # Minimum amount of the resource in the cluster.
1777 "maximum": "A String", # Maximum amount of the resource in the cluster.
1778 },
1779 ],
1780 "autoprovisioningLocations": [ # The list of Google Compute Engine
1781 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1782 # NodePool's nodes can be created by NAP.
1783 "A String",
1784 ],
1785 "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
1786 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1787 "description": "A String", # An optional description of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1788 "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
1789 "state": "A String", # Denotes the state of etcd encryption.
1790 "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.
1791 # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
1792 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1793 "currentNodeVersion": "A String", # [Output only] Deprecated, use
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1794 # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1795 # instead. The current version of the node software components. If they are
1796 # currently at multiple versions because they're in the process of being
1797 # upgraded, this reflects the minimum version of all nodes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1798 "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
1799 "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container
1800 # images will be validated by Binary Authorization.
1801 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1802 "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
1803 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
1804 "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.
1805 # If unspecified, the defaults are used:
1806 # For clusters before v1.12, if master_auth is unspecified, `username` will
1807 # be set to "admin", a random password will be generated, and a client
1808 # certificate will be issued.
1809 # Authentication can be done using HTTP basic auth or using client
1810 # certificates.
1811 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
1812 # For clusters v1.6.0 and later, basic authentication can be disabled by
1813 # leaving username unspecified (or setting it to the empty string).
1814 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate
1815 # to the cluster endpoint.
1816 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to
1817 # authenticate to the cluster endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1818 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of
1819 # trust for the cluster.
1820 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint.
1821 # Because the master endpoint is open to the Internet, you should create a
1822 # strong password. If a password is provided for cluster creation, username
1823 # must be non-empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1824 "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For
1825 # clusters before v1.12, if no configuration is specified, a client
1826 # certificate is issued.
1827 "issueClientCertificate": True or False, # Issue a client certificate.
1828 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1829 },
1830 "expireTime": "A String", # [Output only] The time the cluster will be automatically
1831 # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1832 "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in
1833 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
1834 # notation (e.g. `1.2.3.4/29`).
1835 "nodePools": [ # The node pools associated with this cluster.
1836 # This field should not be set if "node_config" or "initial_node_count" are
1837 # specified.
1838 { # NodePool contains the name and configuration for a cluster's node pool.
1839 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
1840 # specification, under the control of the cluster master. They may have a set
1841 # of Kubernetes labels applied to them, which may be used to reference them
1842 # during pod scheduling. They may also be resized up or down, to accommodate
1843 # the workload.
1844 "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^]1845 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1846 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
1847 # node pool.
1848 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
1849 # pool. If enabled, the nodes in this node pool will be monitored and, if
1850 # they fail health checks too many times, an automatic repair action will be
1851 # triggered.
1852 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1853 # the Auto Upgrades will proceed.
1854 "description": "A String", # [Output only] This field is set when upgrades are about to commence
1855 # with the description of the upgrade.
1856 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
1857 # with the approximate start time for the upgrades, in
1858 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1859 },
1860 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
1861 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
1862 # up to date with the latest release version of Kubernetes.
1863 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1864 "name": "A String", # The name of the node pool.
1865 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
1866 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
1867 # associated with this node pool.
1868 "A String",
1869 ],
1870 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
1871 # only if a valid configuration is present.
1872 # adjust the size of the node pool to the current cluster usage.
1873 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
1874 # max_node_count.
1875 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
1876 "enabled": True or False, # Is autoscaling enabled for this node pool.
1877 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
1878 # has to enough quota to scale up the cluster.
1879 },
1880 "locations": [ # The list of Google Compute Engine
1881 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
1882 # NodePool's nodes should be located.
1883 "A String",
1884 ],
1885 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
1886 # simultaneously on a node in the node pool.
1887 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
1888 },
1889 "version": "A String", # The version of the Kubernetes of this node.
1890 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
1891 # disruption caused by an upgrade.
1892 #
1893 # maxUnavailable controls the number of nodes that can be simultaneously
1894 # unavailable.
1895 #
1896 # maxSurge controls the number of additional nodes that can be added to the
1897 # node pool temporarily for the time of the upgrade to increase the number of
1898 # available nodes.
1899 #
1900 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
1901 # nodes are being upgraded at the same time).
1902 #
1903 # Note: upgrades inevitably introduce some disruption since workloads need to
1904 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
1905 # this holds true. (Disruption stays within the limits of
1906 # PodDisruptionBudget, if it is configured.)
1907 #
1908 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
1909 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
1910 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
1911 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
1912 # there are always at least 4 nodes available.
1913 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
1914 # of the node pool during the upgrade process.
1915 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
1916 # the upgrade process. A node is considered available if its status is
1917 # Ready.
1918 },
1919 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
1920 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
1921 # is sufficient for this number of instances. You must also have available
1922 # firewall and routes quota.
1923 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1924 "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^]1925 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
1926 # the specified [Zonal Compute
1927 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
1928 # to this node pool.
1929 # is the configuration of desired reservation which instances could take
1930 # capacity from.
1931 "values": [ # Corresponds to the label value(s) of reservation resource(s).
1932 "A String",
1933 ],
1934 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
1935 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
1936 # the key and specify the name of your reservation as its value.
1937 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
1938 },
1939 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1940 "type": "A String", # Type of the sandbox to use for the node.
1941 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1942 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1943 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1944 # `n1-standard-1`).
1945 #
1946 # If unspecified, the default machine type is
1947 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1948 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
1949 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
1950 #
1951 # Enables monitoring and attestation of the boot integrity of the instance.
1952 # The attestation is performed against the integrity policy baseline. This
1953 # baseline is initially derived from the implicitly trusted boot image when
1954 # the instance is created.
1955 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
1956 #
1957 # Secure Boot helps ensure that the system only runs authentic software by
1958 # verifying the digital signature of all boot components, and halting the
1959 # boot process if signature verification fails.
1960 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1961 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
1962 # valid sources or targets for network firewalls and are specified by
1963 # the client during cluster or node pool creation. Each tag within the list
1964 # must comply with RFC1035.
1965 "A String",
1966 ],
1967 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
1968 # https://cloud.google.com/compute/docs/instances/preemptible for more
1969 # information about preemptible VM instances.
1970 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
1971 # These will added in addition to any default label(s) that
1972 # Kubernetes may apply to the node.
1973 # In case of conflict in label keys, the applied set may differ depending on
1974 # the Kubernetes version -- it's best to assume the behavior is undefined
1975 # and conflicts should be avoided.
1976 # For more information, including usage and the valid values, see:
1977 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1978 "a_key": "A String",
1979 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1980 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
1981 # Specify the email address of the Service Account; otherwise, if no Service
1982 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1983 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
1984 # node VMs under the "default" service account.
1985 #
1986 # The following scopes are recommended, but not required, and by default are
1987 # not included:
1988 #
1989 # * `https://www.googleapis.com/auth/compute` is required for mounting
1990 # persistent storage on your nodes.
1991 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
1992 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1993 # (the [Google Container
1994 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1995 #
1996 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
1997 # Monitoring are enabled, in which case their required scopes will be added.
1998 "A String",
1999 ],
2000 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
2001 #
2002 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2003 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
2004 # workloads on the node pool.
2005 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
2006 # on the node pool.
2007 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2008 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
2009 # The smallest allowed disk size is 10GB.
2010 #
2011 # If unspecified, the default disk size is 100GB.
2012 "accelerators": [ # A list of hardware accelerators to be attached to each node.
2013 # See https://cloud.google.com/compute/docs/gpus for more information about
2014 # support for GPUs.
2015 { # AcceleratorConfig represents a Hardware Accelerator request.
2016 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
2017 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2018 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2019 },
2020 ],
2021 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
2022 # scheduled on the specified or newer CPU platform. Applicable values are the
2023 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2024 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
2025 # &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]2026 # information, read [how to specify min CPU
2027 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
2028 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
2029 #
2030 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
2031 # in length. These are reflected as part of a URL in the metadata server.
2032 # Additionally, to avoid ambiguity, keys must not conflict with any other
2033 # metadata keys for the project or be one of the reserved keys:
2034 # "cluster-location"
2035 # "cluster-name"
2036 # "cluster-uid"
2037 # "configure-sh"
2038 # "containerd-configure-sh"
2039 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2040 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2041 # "gci-metrics-enabled"
2042 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2043 # "instance-template"
2044 # "kube-env"
2045 # "startup-script"
2046 # "user-data"
2047 # "disable-address-manager"
2048 # "windows-startup-script-ps1"
2049 # "common-psm1"
2050 # "k8s-node-setup-psm1"
2051 # "install-ssh-psm1"
2052 # "user-profile-psm1"
2053 # "serial-port-logging-enable"
2054 #
2055 # Values are free-form strings, and only have meaning as interpreted by
2056 # the image running in the instance. The only restriction placed on them is
2057 # that each value's size must be less than or equal to 32 KB.
2058 #
2059 # The total size of all keys and values must be less than 512 KB.
2060 "a_key": "A String",
2061 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2062 "taints": [ # List of kubernetes taints to be applied to each node.
2063 #
2064 # For more information, including usage and the valid values, see:
2065 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
2066 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
2067 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
2068 #
2069 # For more information, including usage and the valid values, see:
2070 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
2071 "value": "A String", # Value for taint.
2072 "key": "A String", # Key for taint.
2073 "effect": "A String", # Effect for taint.
2074 },
2075 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2076 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
2077 # the latest version of it will be used.
2078 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
2079 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2080 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2081 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2082 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2083 # for more information.
2084 },
2085 "conditions": [ # Which conditions caused the current node pool state.
2086 { # StatusCondition describes why a cluster or a node pool has a certain status
2087 # (e.g., ERROR or DEGRADED).
2088 "message": "A String", # Human-friendly representation of the condition
2089 "code": "A String", # Machine-friendly representation of the condition
2090 },
2091 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2092 "statusMessage": "A String", # [Output only] Additional information about the current status of this
2093 # node pool instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2094 },
2095 ],
2096 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics.
2097 # Currently available options:
2098 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2099 # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
2100 # service with a Kubernetes-native resource model
2101 # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
2102 # longer available as of GKE 1.15).
2103 # * `none` - No metrics will be exported from the cluster.
2104 #
2105 # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
2106 # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2107 "createTime": "A String", # [Output only] The time the cluster was created, in
2108 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2109 "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
2110 "enabled": True or False, # Whether this cluster should return group membership lookups
2111 # during authentication using a group of security groups.
2112 "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant
2113 # if enabled = true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2114 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2115 "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2116 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.
2117 # The endpoint can be accessed from the internet at
2118 # `https://username:password@endpoint/`.
2119 #
2120 # See the `masterAuth` property of this resource for username and
2121 # password information.
2122 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.
2123 # Call Kubernetes API directly to retrieve node information.
2124 "loggingService": "A String", # The logging service the cluster should use to write logs.
2125 # Currently available options:
2126 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2127 # * `logging.googleapis.com/kubernetes` - The Cloud Logging
2128 # service with a Kubernetes-native resource model
2129 # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
2130 # available as of GKE 1.15).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2131 # * `none` - no logs will be exported from the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2132 #
2133 # If left as an empty string,`logging.googleapis.com/kubernetes` will be
2134 # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
2135 "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.
2136 # required by Vertical Pod Autoscaler to automatically adjust
2137 # the resources of pods controlled by it.
2138 "enabled": True or False, # Enables vertical pod autoscaling.
2139 },
2140 "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha
2141 # API groups (e.g. v1alpha1) and features that may not be production ready in
2142 # the kubernetes version of the master and nodes.
2143 # The cluster has no SLA for uptime and master/node upgrades are disabled.
2144 # Alpha enabled clusters are automatically deleted thirty days after
2145 # creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2146 "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those
2147 # found in validMasterVersions returned by getServerConfig. The version can
2148 # be upgraded over time; such upgrades are reflected in
2149 # currentMasterVersion and currentNodeVersion.
2150 #
2151 # Users may specify either explicit versions offered by
2152 # Kubernetes Engine or version aliases, which have the following behavior:
2153 #
2154 # - "latest": picks the highest valid Kubernetes version
2155 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
2156 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
2157 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
2158 # - "","-": picks the default Kubernetes version
2159 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.
2160 # For requests, this field should only be used in lieu of a
2161 # "node_pool" object, since this configuration (along with the
2162 # "initial_node_count") will be used to create a "NodePool" object with an
2163 # auto-generated name. Do not use this and a node_pool at the same time.
2164 # For responses, this field will be populated with the node configuration of
2165 # the first node pool. (For configuration of each node pool, see
2166 # `node_pool.config`)
2167 #
2168 # If unspecified, the defaults are used.
2169 # This field is deprecated, use node_pool.config instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2170 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
2171 # the specified [Zonal Compute
2172 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
2173 # to this node pool.
2174 # is the configuration of desired reservation which instances could take
2175 # capacity from.
2176 "values": [ # Corresponds to the label value(s) of reservation resource(s).
2177 "A String",
2178 ],
2179 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
2180 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
2181 # the key and specify the name of your reservation as its value.
2182 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
2183 },
2184 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
2185 "type": "A String", # Type of the sandbox to use for the node.
2186 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2187 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2188 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2189 # `n1-standard-1`).
2190 #
2191 # If unspecified, the default machine type is
2192 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2193 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
2194 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
2195 #
2196 # Enables monitoring and attestation of the boot integrity of the instance.
2197 # The attestation is performed against the integrity policy baseline. This
2198 # baseline is initially derived from the implicitly trusted boot image when
2199 # the instance is created.
2200 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
2201 #
2202 # Secure Boot helps ensure that the system only runs authentic software by
2203 # verifying the digital signature of all boot components, and halting the
2204 # boot process if signature verification fails.
2205 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2206 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
2207 # valid sources or targets for network firewalls and are specified by
2208 # the client during cluster or node pool creation. Each tag within the list
2209 # must comply with RFC1035.
2210 "A String",
2211 ],
2212 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
2213 # https://cloud.google.com/compute/docs/instances/preemptible for more
2214 # information about preemptible VM instances.
2215 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
2216 # These will added in addition to any default label(s) that
2217 # Kubernetes may apply to the node.
2218 # In case of conflict in label keys, the applied set may differ depending on
2219 # the Kubernetes version -- it's best to assume the behavior is undefined
2220 # and conflicts should be avoided.
2221 # For more information, including usage and the valid values, see:
2222 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
2223 "a_key": "A String",
2224 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2225 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
2226 # Specify the email address of the Service Account; otherwise, if no Service
2227 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2228 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
2229 # node VMs under the "default" service account.
2230 #
2231 # The following scopes are recommended, but not required, and by default are
2232 # not included:
2233 #
2234 # * `https://www.googleapis.com/auth/compute` is required for mounting
2235 # persistent storage on your nodes.
2236 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
2237 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2238 # (the [Google Container
2239 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2240 #
2241 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
2242 # Monitoring are enabled, in which case their required scopes will be added.
2243 "A String",
2244 ],
2245 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
2246 #
2247 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2248 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
2249 # workloads on the node pool.
2250 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
2251 # on the node pool.
2252 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2253 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
2254 # The smallest allowed disk size is 10GB.
2255 #
2256 # If unspecified, the default disk size is 100GB.
2257 "accelerators": [ # A list of hardware accelerators to be attached to each node.
2258 # See https://cloud.google.com/compute/docs/gpus for more information about
2259 # support for GPUs.
2260 { # AcceleratorConfig represents a Hardware Accelerator request.
2261 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
2262 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2263 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2264 },
2265 ],
2266 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
2267 # scheduled on the specified or newer CPU platform. Applicable values are the
2268 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2269 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
2270 # &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]2271 # information, read [how to specify min CPU
2272 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
2273 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
2274 #
2275 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
2276 # in length. These are reflected as part of a URL in the metadata server.
2277 # Additionally, to avoid ambiguity, keys must not conflict with any other
2278 # metadata keys for the project or be one of the reserved keys:
2279 # "cluster-location"
2280 # "cluster-name"
2281 # "cluster-uid"
2282 # "configure-sh"
2283 # "containerd-configure-sh"
2284 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2285 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2286 # "gci-metrics-enabled"
2287 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2288 # "instance-template"
2289 # "kube-env"
2290 # "startup-script"
2291 # "user-data"
2292 # "disable-address-manager"
2293 # "windows-startup-script-ps1"
2294 # "common-psm1"
2295 # "k8s-node-setup-psm1"
2296 # "install-ssh-psm1"
2297 # "user-profile-psm1"
2298 # "serial-port-logging-enable"
2299 #
2300 # Values are free-form strings, and only have meaning as interpreted by
2301 # the image running in the instance. The only restriction placed on them is
2302 # that each value's size must be less than or equal to 32 KB.
2303 #
2304 # The total size of all keys and values must be less than 512 KB.
2305 "a_key": "A String",
2306 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2307 "taints": [ # List of kubernetes taints to be applied to each node.
2308 #
2309 # For more information, including usage and the valid values, see:
2310 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
2311 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
2312 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
2313 #
2314 # For more information, including usage and the valid values, see:
2315 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
2316 "value": "A String", # Value for taint.
2317 "key": "A String", # Key for taint.
2318 "effect": "A String", # Effect for taint.
2319 },
2320 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2321 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
2322 # the latest version of it will be used.
2323 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
2324 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2325 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2326 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2327 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2328 # for more information.
2329 },
2330 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in
2331 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2332 # notation (e.g. `10.96.0.0/14`). Leave blank to have
2333 # one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
2334 "subnetwork": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2335 # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which
2336 # the cluster is connected.
2337 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in
2338 # this cluster, in
2339 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2340 # notation (e.g. `1.2.3.4/29`). Service addresses are
2341 # typically put in the last `/16` from the container CIDR.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2342 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
2343 "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2344 # 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]2345 # is sufficient for this number of instances. You must also have available
2346 # firewall and routes quota.
2347 # For requests, this field should only be used in lieu of a
2348 # "node_pool" object, since this configuration (along with the
2349 # "node_config") will be used to create a "NodePool" object with an
2350 # auto-generated name. Do not use this and a node_pool at the same time.
2351 #
2352 # This field is deprecated, use node_pool.initial_node_count instead.
2353 }</pre>
2354</div>
2355
2356<div class="method">
2357 <code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code>
2358 <pre>Gets the public component of the cluster signing keys in
2359JSON Web Key format.
2360This API is not yet intended for general use, and is not available for all
2361clusters.
2362
2363Args:
2364 parent: string, The cluster (project, location, cluster id) to get keys for. Specified in
2365the format 'projects/*/locations/*/clusters/*'. (required)
2366 x__xgafv: string, V1 error format.
2367 Allowed values
2368 1 - v1 error format
2369 2 - v2 error format
2370
2371Returns:
2372 An object of the form:
2373
2374 { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
2375 "keys": [ # The public component of the keys used by the cluster to sign token
2376 # requests.
2377 { # Jwk is a JSON Web Key as specified in RFC 7517
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2378 "use": "A String", # Permitted uses for the public keys.
2379 "e": "A String", # Used for RSA keys.
2380 "kty": "A String", # Key Type.
2381 "alg": "A String", # Algorithm.
2382 "n": "A String", # Used for RSA keys.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2383 "x": "A String", # Used for ECDSA keys.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2384 "y": "A String", # Used for ECDSA keys.
2385 "crv": "A String", # Used for ECDSA keys.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2386 "kid": "A String", # Key ID.
2387 },
2388 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2389 "cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP
2390 # Cache-Control header.
2391 "age": "A String", # 14.6 response cache age, in seconds since the response is generated
2392 "expires": "A String", # 14.21 response cache expires, in RFC 1123 date format
2393 "directive": "A String", # 14.9 request and response directives
2394 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2395 }</pre>
2396</div>
2397
2398<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2399 <code class="details" id="list">list(parent, zone=None, projectId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2400 <pre>Lists all clusters owned by a project in either the specified zone or all
2401zones.
2402
2403Args:
2404 parent: string, The parent (project and location) where the clusters will be listed.
2405Specified in the format 'projects/*/locations/*'.
2406Location "-" matches all zones and all regions. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2407 zone: string, Deprecated. The name of the Google Compute Engine
2408[zone](https://cloud.google.com/compute/docs/zones#available) in which the
2409cluster resides, or "-" for all zones. This field has been deprecated and
2410replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2411 projectId: string, Deprecated. The Google Developers Console [project ID or project
2412number](https://support.google.com/cloud/answer/6158840).
2413This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2414 x__xgafv: string, V1 error format.
2415 Allowed values
2416 1 - v1 error format
2417 2 - v2 error format
2418
2419Returns:
2420 An object of the form:
2421
2422 { # ListClustersResponse is the result of ListClustersRequest.
2423 "clusters": [ # A list of clusters in the project in the specified zone, or
2424 # across all ones.
2425 { # A Google Kubernetes Engine cluster.
2426 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting
2427 # containers. This is provisioned from within the `container_ipv4_cidr`
2428 # range. This field will only be set when cluster is in route-based network
2429 # mode.
2430 "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
2431 "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2432 "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for
2433 # maintenance to occur. The time windows may be overlapping. If no
2434 # maintenance windows are set, maintenance can occur at any time.
2435 "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
2436 # this window reccurs. They go on for the span of time between the start and
2437 # end time.
2438 #
2439 # For example, to have something repeat every weekday, you'd use:
2440 # &lt;code&gt;FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR&lt;/code&gt;
2441 # To repeat some window daily (equivalent to the DailyMaintenanceWindow):
2442 # &lt;code&gt;FREQ=DAILY&lt;/code&gt;
2443 # For the first weekend of every month:
2444 # &lt;code&gt;FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU&lt;/code&gt;
2445 # This specifies how frequently the window starts. Eg, if you wanted to have
2446 # a 9-5 UTC-4 window every weekday, you'd use something like:
2447 # &lt;code&gt;
2448 # start time = 2019-01-01T09:00:00-0400
2449 # end time = 2019-01-01T17:00:00-0400
2450 # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
2451 # &lt;/code&gt;
2452 # Windows can span multiple days. Eg, to make the window encompass every
2453 # weekend from midnight Saturday till the last minute of Sunday UTC:
2454 # &lt;code&gt;
2455 # start time = 2019-01-05T00:00:00Z
2456 # end time = 2019-01-07T23:59:00Z
2457 # recurrence = FREQ=WEEKLY;BYDAY=SA
2458 # &lt;/code&gt;
2459 # Note the start and end time's specific dates are largely arbitrary except
2460 # to specify duration of the window and when it first starts.
2461 # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
2462 "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
2463 "endTime": "A String", # The time that the window ends. The end time should take place after the
2464 # start time.
2465 "startTime": "A String", # The time that the window first starts.
2466 },
2467 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2468 "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
2469 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be
2470 # smallest possible in the given scenario.
2471 # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
2472 # format "PTnHnMnS".
2473 "startTime": "A String", # Time within the maintenance window to start the maintenance operations.
2474 # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
2475 # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
2476 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2477 "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not
2478 # occur in these windows.
2479 "a_key": { # Represents an arbitrary window of time.
2480 "endTime": "A String", # The time that the window ends. The end time should take place after the
2481 # start time.
2482 "startTime": "A String", # The time that the window first starts.
2483 },
2484 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2485 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2486 "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of
2487 # the policy won't accidentally undo intermediate changes (and so that users
2488 # of the API unaware of some fields won't accidentally remove other fields).
2489 # Make a &lt;code&gt;get()&lt;/code&gt; request to the cluster to get the current
2490 # resource version and include it with requests to set the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2491 },
2492 "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature.
2493 # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
2494 "enabled": True or False, # Whether network policy is enabled on the cluster.
2495 "provider": "A String", # The selected network policy provider.
2496 },
2497 "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature.
2498 # master authorized networks will disallow all external traffic to access
2499 # Kubernetes master through HTTPS except traffic from the given CIDR blocks,
2500 # Google Compute Engine Public IPs and Google Prod IPs.
2501 "enabled": True or False, # Whether or not master authorized networks is enabled.
2502 "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access
2503 # Kubernetes master through HTTPS.
2504 { # CidrBlock contains an optional name and one CIDR block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2505 "cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2506 "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2507 },
2508 ],
2509 },
2510 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.
2511 # cluster, enabling additional functionality.
2512 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which
2513 # makes it easy to set up HTTP load balancers for services in a cluster.
2514 # which makes it easy to set up HTTP load balancers for services in a cluster.
2515 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.
2516 # When enabled, it runs a small pod in the cluster that manages the load
2517 # balancers.
2518 },
2519 "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon
2520 # is enabled or not on the Master, it does not track whether network policy
2521 # is enabled for the nodes.
2522 # is enabled or not on the Master, it does not track whether network policy
2523 # is enabled for the nodes.
2524 "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
2525 },
2526 "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.
2527 # This addon is deprecated, and will be disabled in 1.15. It is recommended
2528 # to use the Cloud Console to manage and monitor your Kubernetes clusters,
2529 # workloads and applications. For more information, see:
2530 # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
2531 "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
2532 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2533 "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a
2534 # managed Knative service.
2535 "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
2536 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2537 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which
2538 # increases or decreases the number of replica pods a replication controller
2539 # has based on the resource usage of the existing pods.
2540 # increases or decreases the number of replica pods a replication controller
2541 # has based on the resource usage of the existing pods.
2542 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2543 # When enabled, it ensures that metrics are collected into Stackdriver
2544 # Monitoring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2545 },
2546 },
2547 "locations": [ # The list of Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2548 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
2549 # cluster's nodes should be located.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2550 "A String",
2551 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2552 "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode.
2553 # mode.
2554 "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled,
2555 # identities in the system, including service accounts, nodes, and
2556 # controllers, will have statically granted permissions beyond those
2557 # provided by the RBAC configuration or IAM.
2558 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2559 "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run
2560 # simultaneously on a node in the node pool of this cluster. Only honored
2561 # if cluster created with IP Alias support.
2562 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
2563 },
2564 "network": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2565 # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
2566 # to which the cluster is connected. If left unspecified, the `default`
2567 # network will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2568 "zone": "A String", # [Output only] The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2569 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
2570 # cluster resides. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2571 "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
2572 "A String",
2573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2574 "location": "A String", # [Output only] The name of the Google Compute Engine
2575 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
2576 # or
2577 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
2578 # in which the cluster resides.
2579 "networkConfig": { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2580 "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2581 # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the
2582 # cluster is connected. Example:
2583 # projects/my-project/regions/us-central1/subnetworks/my-subnet
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2584 "network": "A String", # Output only. The relative name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2585 # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
2586 # to which the cluster is connected. Example:
2587 # projects/my-project/global/networks/my-network
2588 "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster.
2589 # This makes same node pod to pod traffic visible for VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2590 },
2591 "name": "A String", # The name of this cluster. The name must be unique within this project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2592 # and location (e.g. zone or region), and can be up to 40 characters with
2593 # the following restrictions:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2594 #
2595 # * Lowercase letters, numbers, and hyphens only.
2596 # * Must start with a letter.
2597 # * Must end with a number or a letter.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2598 "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
2599 "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
2600 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2601 "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2602 "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2603 "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2604 "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then
2605 # `cluster.cluster_ipv4_cidr` must be left blank.
2606 #
2607 # This field is only applicable when `use_ip_aliases` is true.
2608 #
2609 # Set to blank to have a range chosen with the default size.
2610 #
2611 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
2612 # netmask.
2613 #
2614 # Set to a
2615 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2616 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
2617 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
2618 # to use.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2619 "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR
2620 # block. The secondary range will be used for pod IP
2621 # addresses. This must be an existing secondary range associated
2622 # with the cluster subnetwork.
2623 #
2624 # This field is only applicable with use_ip_aliases is true and
2625 # create_subnetwork is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2626 "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range
2627 # will be automatically chosen with the default size.
2628 #
2629 # This field is only applicable when `use_ip_aliases` is true.
2630 #
2631 # Set to blank to have a range chosen with the default size.
2632 #
2633 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
2634 # netmask.
2635 #
2636 # Set to a
2637 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2638 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
2639 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
2640 # to use.
2641 "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster.
2642 #
2643 # This field is only applicable when `use_ip_aliases` is true.
2644 "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster.
2645 #
2646 # This is applicable only if `create_subnetwork` is true.
2647 #
2648 # Set to blank to have a range chosen with the default size.
2649 #
2650 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
2651 # netmask.
2652 #
2653 # Set to a
2654 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2655 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
2656 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
2657 # to use.
2658 "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a
2659 # range will be automatically chosen with the default size.
2660 #
2661 # This field is only applicable when `use_ip_aliases` is true.
2662 #
2663 # If unspecified, the range will use the default size.
2664 #
2665 # Set to /netmask (e.g. `/14`) to have a range chosen with a specific
2666 # netmask.
2667 #
2668 # Set to a
2669 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2670 # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
2671 # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
2672 # to use.
2673 "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
2674 "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If
2675 # this field is empty, then an automatic name will be chosen for the new
2676 # subnetwork.
2677 "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services
2678 # CIDR block. The secondary range will be used for service
2679 # ClusterIPs. This must be an existing secondary range associated
2680 # with the cluster subnetwork.
2681 #
2682 # This field is only applicable with use_ip_aliases is true and
2683 # create_subnetwork is false.
2684 "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
2685 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2686 "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM
2687 # policies.
2688 # policies.
2689 "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
2690 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2691 "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is
2692 # disabled when this config is unspecified.
2693 "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
2694 "datasetId": "A String", # The ID of a BigQuery Dataset.
2695 },
2696 "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a
2697 # daemonset will be created in the cluster to meter network egress traffic.
2698 "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
2699 "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a
2700 # second BigQuery table will be created to hold resource consumption
2701 # records.
2702 },
2703 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2704 "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
2705 "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint.
2706 "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint.
2707 "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are
2708 # given only RFC 1918 private addresses and communicate with the master via
2709 # private networking.
2710 "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint.
2711 "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
2712 # range will be used for assigning internal IP addresses to the master or
2713 # set of masters, as well as the ILB VIP. This range must not overlap with
2714 # any other ranges in use within the cluster's network.
2715 "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
2716 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2717 "conditions": [ # Which conditions caused the current cluster state.
2718 { # StatusCondition describes why a cluster or a node pool has a certain status
2719 # (e.g., ERROR or DEGRADED).
2720 "message": "A String", # Human-friendly representation of the condition
2721 "code": "A String", # Machine-friendly representation of the condition
2722 },
2723 ],
2724 "statusMessage": "A String", # [Output only] Additional information about the current status of this
2725 # cluster, if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2726 "resourceLabels": { # The resource labels for the cluster to use to annotate any related
2727 # Google Compute Engine resources.
2728 "a_key": "A String",
2729 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2730 "status": "A String", # [Output only] The current status of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2731 "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.
2732 # required by Cluster Autoscaler to automatically adjust
2733 # the size of the cluster and create/delete
2734 # node pools based on the current needs.
2735 "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool
2736 # created by NAP.
2737 # by NAP.
2738 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
2739 # service_account is specified, scopes should be empty.
2740 "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.
2741 # node pool.
2742 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
2743 # pool. If enabled, the nodes in this node pool will be monitored and, if
2744 # they fail health checks too many times, an automatic repair action will be
2745 # triggered.
2746 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
2747 # the Auto Upgrades will proceed.
2748 "description": "A String", # [Output only] This field is set when upgrades are about to commence
2749 # with the description of the upgrade.
2750 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
2751 # with the approximate start time for the upgrades, in
2752 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2753 },
2754 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
2755 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
2756 # up to date with the latest release version of Kubernetes.
2757 },
2758 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools
2759 # disruption caused by an upgrade.
2760 #
2761 # maxUnavailable controls the number of nodes that can be simultaneously
2762 # unavailable.
2763 #
2764 # maxSurge controls the number of additional nodes that can be added to the
2765 # node pool temporarily for the time of the upgrade to increase the number of
2766 # available nodes.
2767 #
2768 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
2769 # nodes are being upgraded at the same time).
2770 #
2771 # Note: upgrades inevitably introduce some disruption since workloads need to
2772 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
2773 # this holds true. (Disruption stays within the limits of
2774 # PodDisruptionBudget, if it is configured.)
2775 #
2776 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
2777 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
2778 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
2779 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
2780 # there are always at least 4 nodes available.
2781 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
2782 # of the node pool during the upgrade process.
2783 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
2784 # the upgrade process. A node is considered available if its status is
2785 # Ready.
2786 },
2787 "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are
2788 # specified, service_account should be empty.
2789 "A String",
2790 ],
2791 },
2792 "resourceLimits": [ # Contains global constraints regarding minimum and maximum
2793 # amount of resources in the cluster.
2794 { # Contains information about amount of some resource in the cluster.
2795 # For memory, value should be in GB.
2796 "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
2797 "minimum": "A String", # Minimum amount of the resource in the cluster.
2798 "maximum": "A String", # Maximum amount of the resource in the cluster.
2799 },
2800 ],
2801 "autoprovisioningLocations": [ # The list of Google Compute Engine
2802 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
2803 # NodePool's nodes can be created by NAP.
2804 "A String",
2805 ],
2806 "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
2807 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2808 "description": "A String", # An optional description of this cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2809 "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
2810 "state": "A String", # Denotes the state of etcd encryption.
2811 "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.
2812 # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
2813 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2814 "currentNodeVersion": "A String", # [Output only] Deprecated, use
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2815 # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2816 # instead. The current version of the node software components. If they are
2817 # currently at multiple versions because they're in the process of being
2818 # upgraded, this reflects the minimum version of all nodes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2819 "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
2820 "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container
2821 # images will be validated by Binary Authorization.
2822 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2823 "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
2824 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
2825 "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint.
2826 # If unspecified, the defaults are used:
2827 # For clusters before v1.12, if master_auth is unspecified, `username` will
2828 # be set to "admin", a random password will be generated, and a client
2829 # certificate will be issued.
2830 # Authentication can be done using HTTP basic auth or using client
2831 # certificates.
2832 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
2833 # For clusters v1.6.0 and later, basic authentication can be disabled by
2834 # leaving username unspecified (or setting it to the empty string).
2835 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate
2836 # to the cluster endpoint.
2837 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to
2838 # authenticate to the cluster endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2839 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of
2840 # trust for the cluster.
2841 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint.
2842 # Because the master endpoint is open to the Internet, you should create a
2843 # strong password. If a password is provided for cluster creation, username
2844 # must be non-empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2845 "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For
2846 # clusters before v1.12, if no configuration is specified, a client
2847 # certificate is issued.
2848 "issueClientCertificate": True or False, # Issue a client certificate.
2849 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2850 },
2851 "expireTime": "A String", # [Output only] The time the cluster will be automatically
2852 # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2853 "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in
2854 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
2855 # notation (e.g. `1.2.3.4/29`).
2856 "nodePools": [ # The node pools associated with this cluster.
2857 # This field should not be set if "node_config" or "initial_node_count" are
2858 # specified.
2859 { # NodePool contains the name and configuration for a cluster's node pool.
2860 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
2861 # specification, under the control of the cluster master. They may have a set
2862 # of Kubernetes labels applied to them, which may be used to reference them
2863 # during pod scheduling. They may also be resized up or down, to accommodate
2864 # the workload.
2865 "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^]2866 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2867 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
2868 # node pool.
2869 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
2870 # pool. If enabled, the nodes in this node pool will be monitored and, if
2871 # they fail health checks too many times, an automatic repair action will be
2872 # triggered.
2873 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
2874 # the Auto Upgrades will proceed.
2875 "description": "A String", # [Output only] This field is set when upgrades are about to commence
2876 # with the description of the upgrade.
2877 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
2878 # with the approximate start time for the upgrades, in
2879 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2880 },
2881 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
2882 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
2883 # up to date with the latest release version of Kubernetes.
2884 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2885 "name": "A String", # The name of the node pool.
2886 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
2887 # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
2888 # associated with this node pool.
2889 "A String",
2890 ],
2891 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
2892 # only if a valid configuration is present.
2893 # adjust the size of the node pool to the current cluster usage.
2894 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;=
2895 # max_node_count.
2896 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
2897 "enabled": True or False, # Is autoscaling enabled for this node pool.
2898 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There
2899 # has to enough quota to scale up the cluster.
2900 },
2901 "locations": [ # The list of Google Compute Engine
2902 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
2903 # NodePool's nodes should be located.
2904 "A String",
2905 ],
2906 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
2907 # simultaneously on a node in the node pool.
2908 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
2909 },
2910 "version": "A String", # The version of the Kubernetes of this node.
2911 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade.
2912 # disruption caused by an upgrade.
2913 #
2914 # maxUnavailable controls the number of nodes that can be simultaneously
2915 # unavailable.
2916 #
2917 # maxSurge controls the number of additional nodes that can be added to the
2918 # node pool temporarily for the time of the upgrade to increase the number of
2919 # available nodes.
2920 #
2921 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
2922 # nodes are being upgraded at the same time).
2923 #
2924 # Note: upgrades inevitably introduce some disruption since workloads need to
2925 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
2926 # this holds true. (Disruption stays within the limits of
2927 # PodDisruptionBudget, if it is configured.)
2928 #
2929 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
2930 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
2931 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
2932 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
2933 # there are always at least 4 nodes available.
2934 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
2935 # of the node pool during the upgrade process.
2936 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
2937 # the upgrade process. A node is considered available if its status is
2938 # Ready.
2939 },
2940 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
2941 # Compute Engine &lt;a href="/compute/docs/resource-quotas"&gt;resource quota&lt;/a&gt;
2942 # is sufficient for this number of instances. You must also have available
2943 # firewall and routes quota.
2944 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2945 "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^]2946 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
2947 # the specified [Zonal Compute
2948 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
2949 # to this node pool.
2950 # is the configuration of desired reservation which instances could take
2951 # capacity from.
2952 "values": [ # Corresponds to the label value(s) of reservation resource(s).
2953 "A String",
2954 ],
2955 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
2956 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
2957 # the key and specify the name of your reservation as its value.
2958 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
2959 },
2960 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
2961 "type": "A String", # Type of the sandbox to use for the node.
2962 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2963 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2964 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2965 # `n1-standard-1`).
2966 #
2967 # If unspecified, the default machine type is
2968 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2969 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
2970 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
2971 #
2972 # Enables monitoring and attestation of the boot integrity of the instance.
2973 # The attestation is performed against the integrity policy baseline. This
2974 # baseline is initially derived from the implicitly trusted boot image when
2975 # the instance is created.
2976 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
2977 #
2978 # Secure Boot helps ensure that the system only runs authentic software by
2979 # verifying the digital signature of all boot components, and halting the
2980 # boot process if signature verification fails.
2981 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2982 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
2983 # valid sources or targets for network firewalls and are specified by
2984 # the client during cluster or node pool creation. Each tag within the list
2985 # must comply with RFC1035.
2986 "A String",
2987 ],
2988 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
2989 # https://cloud.google.com/compute/docs/instances/preemptible for more
2990 # information about preemptible VM instances.
2991 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
2992 # These will added in addition to any default label(s) that
2993 # Kubernetes may apply to the node.
2994 # In case of conflict in label keys, the applied set may differ depending on
2995 # the Kubernetes version -- it's best to assume the behavior is undefined
2996 # and conflicts should be avoided.
2997 # For more information, including usage and the valid values, see:
2998 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
2999 "a_key": "A String",
3000 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3001 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
3002 # Specify the email address of the Service Account; otherwise, if no Service
3003 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3004 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
3005 # node VMs under the "default" service account.
3006 #
3007 # The following scopes are recommended, but not required, and by default are
3008 # not included:
3009 #
3010 # * `https://www.googleapis.com/auth/compute` is required for mounting
3011 # persistent storage on your nodes.
3012 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
3013 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3014 # (the [Google Container
3015 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3016 #
3017 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
3018 # Monitoring are enabled, in which case their required scopes will be added.
3019 "A String",
3020 ],
3021 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
3022 #
3023 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3024 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
3025 # workloads on the node pool.
3026 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
3027 # on the node pool.
3028 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3029 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
3030 # The smallest allowed disk size is 10GB.
3031 #
3032 # If unspecified, the default disk size is 100GB.
3033 "accelerators": [ # A list of hardware accelerators to be attached to each node.
3034 # See https://cloud.google.com/compute/docs/gpus for more information about
3035 # support for GPUs.
3036 { # AcceleratorConfig represents a Hardware Accelerator request.
3037 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
3038 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3039 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3040 },
3041 ],
3042 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
3043 # scheduled on the specified or newer CPU platform. Applicable values are the
3044 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3045 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
3046 # &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]3047 # information, read [how to specify min CPU
3048 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
3049 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
3050 #
3051 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
3052 # in length. These are reflected as part of a URL in the metadata server.
3053 # Additionally, to avoid ambiguity, keys must not conflict with any other
3054 # metadata keys for the project or be one of the reserved keys:
3055 # "cluster-location"
3056 # "cluster-name"
3057 # "cluster-uid"
3058 # "configure-sh"
3059 # "containerd-configure-sh"
3060 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3061 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3062 # "gci-metrics-enabled"
3063 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3064 # "instance-template"
3065 # "kube-env"
3066 # "startup-script"
3067 # "user-data"
3068 # "disable-address-manager"
3069 # "windows-startup-script-ps1"
3070 # "common-psm1"
3071 # "k8s-node-setup-psm1"
3072 # "install-ssh-psm1"
3073 # "user-profile-psm1"
3074 # "serial-port-logging-enable"
3075 #
3076 # Values are free-form strings, and only have meaning as interpreted by
3077 # the image running in the instance. The only restriction placed on them is
3078 # that each value's size must be less than or equal to 32 KB.
3079 #
3080 # The total size of all keys and values must be less than 512 KB.
3081 "a_key": "A String",
3082 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3083 "taints": [ # List of kubernetes taints to be applied to each node.
3084 #
3085 # For more information, including usage and the valid values, see:
3086 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
3087 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
3088 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
3089 #
3090 # For more information, including usage and the valid values, see:
3091 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
3092 "value": "A String", # Value for taint.
3093 "key": "A String", # Key for taint.
3094 "effect": "A String", # Effect for taint.
3095 },
3096 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3097 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
3098 # the latest version of it will be used.
3099 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
3100 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3101 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3102 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3103 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3104 # for more information.
3105 },
3106 "conditions": [ # Which conditions caused the current node pool state.
3107 { # StatusCondition describes why a cluster or a node pool has a certain status
3108 # (e.g., ERROR or DEGRADED).
3109 "message": "A String", # Human-friendly representation of the condition
3110 "code": "A String", # Machine-friendly representation of the condition
3111 },
3112 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3113 "statusMessage": "A String", # [Output only] Additional information about the current status of this
3114 # node pool instance, if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3115 },
3116 ],
3117 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics.
3118 # Currently available options:
3119 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3120 # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
3121 # service with a Kubernetes-native resource model
3122 # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
3123 # longer available as of GKE 1.15).
3124 # * `none` - No metrics will be exported from the cluster.
3125 #
3126 # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
3127 # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3128 "createTime": "A String", # [Output only] The time the cluster was created, in
3129 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3130 "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
3131 "enabled": True or False, # Whether this cluster should return group membership lookups
3132 # during authentication using a group of security groups.
3133 "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant
3134 # if enabled = true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3135 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3136 "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3137 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint.
3138 # The endpoint can be accessed from the internet at
3139 # `https://username:password@endpoint/`.
3140 #
3141 # See the `masterAuth` property of this resource for username and
3142 # password information.
3143 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated.
3144 # Call Kubernetes API directly to retrieve node information.
3145 "loggingService": "A String", # The logging service the cluster should use to write logs.
3146 # Currently available options:
3147 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3148 # * `logging.googleapis.com/kubernetes` - The Cloud Logging
3149 # service with a Kubernetes-native resource model
3150 # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
3151 # available as of GKE 1.15).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3152 # * `none` - no logs will be exported from the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3153 #
3154 # If left as an empty string,`logging.googleapis.com/kubernetes` will be
3155 # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
3156 "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.
3157 # required by Vertical Pod Autoscaler to automatically adjust
3158 # the resources of pods controlled by it.
3159 "enabled": True or False, # Enables vertical pod autoscaling.
3160 },
3161 "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha
3162 # API groups (e.g. v1alpha1) and features that may not be production ready in
3163 # the kubernetes version of the master and nodes.
3164 # The cluster has no SLA for uptime and master/node upgrades are disabled.
3165 # Alpha enabled clusters are automatically deleted thirty days after
3166 # creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3167 "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those
3168 # found in validMasterVersions returned by getServerConfig. The version can
3169 # be upgraded over time; such upgrades are reflected in
3170 # currentMasterVersion and currentNodeVersion.
3171 #
3172 # Users may specify either explicit versions offered by
3173 # Kubernetes Engine or version aliases, which have the following behavior:
3174 #
3175 # - "latest": picks the highest valid Kubernetes version
3176 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
3177 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
3178 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
3179 # - "","-": picks the default Kubernetes version
3180 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes.
3181 # For requests, this field should only be used in lieu of a
3182 # "node_pool" object, since this configuration (along with the
3183 # "initial_node_count") will be used to create a "NodePool" object with an
3184 # auto-generated name. Do not use this and a node_pool at the same time.
3185 # For responses, this field will be populated with the node configuration of
3186 # the first node pool. (For configuration of each node pool, see
3187 # `node_pool.config`)
3188 #
3189 # If unspecified, the defaults are used.
3190 # This field is deprecated, use node_pool.config instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3191 "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply
3192 # the specified [Zonal Compute
3193 # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
3194 # to this node pool.
3195 # is the configuration of desired reservation which instances could take
3196 # capacity from.
3197 "values": [ # Corresponds to the label value(s) of reservation resource(s).
3198 "A String",
3199 ],
3200 "key": "A String", # Corresponds to the label key of a reservation resource. To target a
3201 # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
3202 # the key and specify the name of your reservation as its value.
3203 "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
3204 },
3205 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
3206 "type": "A String", # Type of the sandbox to use for the node.
3207 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3208 "machineType": "A String", # The name of a Google Compute Engine [machine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3209 # type](https://cloud.google.com/compute/docs/machine-types) (e.g.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3210 # `n1-standard-1`).
3211 #
3212 # If unspecified, the default machine type is
3213 # `n1-standard-1`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3214 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
3215 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
3216 #
3217 # Enables monitoring and attestation of the boot integrity of the instance.
3218 # The attestation is performed against the integrity policy baseline. This
3219 # baseline is initially derived from the implicitly trusted boot image when
3220 # the instance is created.
3221 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
3222 #
3223 # Secure Boot helps ensure that the system only runs authentic software by
3224 # verifying the digital signature of all boot components, and halting the
3225 # boot process if signature verification fails.
3226 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3227 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
3228 # valid sources or targets for network firewalls and are specified by
3229 # the client during cluster or node pool creation. Each tag within the list
3230 # must comply with RFC1035.
3231 "A String",
3232 ],
3233 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
3234 # https://cloud.google.com/compute/docs/instances/preemptible for more
3235 # information about preemptible VM instances.
3236 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
3237 # These will added in addition to any default label(s) that
3238 # Kubernetes may apply to the node.
3239 # In case of conflict in label keys, the applied set may differ depending on
3240 # the Kubernetes version -- it's best to assume the behavior is undefined
3241 # and conflicts should be avoided.
3242 # For more information, including usage and the valid values, see:
3243 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
3244 "a_key": "A String",
3245 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3246 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs.
3247 # Specify the email address of the Service Account; otherwise, if no Service
3248 # Account is specified, the "default" service account is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3249 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
3250 # node VMs under the "default" service account.
3251 #
3252 # The following scopes are recommended, but not required, and by default are
3253 # not included:
3254 #
3255 # * `https://www.googleapis.com/auth/compute` is required for mounting
3256 # persistent storage on your nodes.
3257 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
3258 # communicating with **gcr.io**
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3259 # (the [Google Container
3260 # Registry](https://cloud.google.com/container-registry/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3261 #
3262 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
3263 # Monitoring are enabled, in which case their required scopes will be added.
3264 "A String",
3265 ],
3266 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
3267 #
3268 # If unspecified, the default disk type is 'pd-standard'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3269 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
3270 # workloads on the node pool.
3271 "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running
3272 # on the node pool.
3273 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3274 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
3275 # The smallest allowed disk size is 10GB.
3276 #
3277 # If unspecified, the default disk size is 100GB.
3278 "accelerators": [ # A list of hardware accelerators to be attached to each node.
3279 # See https://cloud.google.com/compute/docs/gpus for more information about
3280 # support for GPUs.
3281 { # AcceleratorConfig represents a Hardware Accelerator request.
3282 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
3283 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3284 # [here](https://cloud.google.com/compute/docs/gpus)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3285 },
3286 ],
3287 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
3288 # scheduled on the specified or newer CPU platform. Applicable values are the
3289 # friendly names of CPU platforms, such as
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3290 # &lt;code&gt;minCpuPlatform: &amp;quot;Intel Haswell&amp;quot;&lt;/code&gt; or
3291 # &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]3292 # information, read [how to specify min CPU
3293 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
3294 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
3295 #
3296 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
3297 # in length. These are reflected as part of a URL in the metadata server.
3298 # Additionally, to avoid ambiguity, keys must not conflict with any other
3299 # metadata keys for the project or be one of the reserved keys:
3300 # "cluster-location"
3301 # "cluster-name"
3302 # "cluster-uid"
3303 # "configure-sh"
3304 # "containerd-configure-sh"
3305 # "enable-os-login"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3306 # "gci-ensure-gke-docker"
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3307 # "gci-metrics-enabled"
3308 # "gci-update-strategy"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3309 # "instance-template"
3310 # "kube-env"
3311 # "startup-script"
3312 # "user-data"
3313 # "disable-address-manager"
3314 # "windows-startup-script-ps1"
3315 # "common-psm1"
3316 # "k8s-node-setup-psm1"
3317 # "install-ssh-psm1"
3318 # "user-profile-psm1"
3319 # "serial-port-logging-enable"
3320 #
3321 # Values are free-form strings, and only have meaning as interpreted by
3322 # the image running in the instance. The only restriction placed on them is
3323 # that each value's size must be less than or equal to 32 KB.
3324 #
3325 # The total size of all keys and values must be less than 512 KB.
3326 "a_key": "A String",
3327 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3328 "taints": [ # List of kubernetes taints to be applied to each node.
3329 #
3330 # For more information, including usage and the valid values, see:
3331 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
3332 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
3333 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
3334 #
3335 # For more information, including usage and the valid values, see:
3336 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
3337 "value": "A String", # Value for taint.
3338 "key": "A String", # Key for taint.
3339 "effect": "A String", # Effect for taint.
3340 },
3341 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3342 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
3343 # the latest version of it will be used.
3344 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
3345 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3346 # The limit for this value is dependent upon the maximum number of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3347 # disks available on a machine per zone. See:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3348 # https://cloud.google.com/compute/docs/disks/local-ssd
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3349 # for more information.
3350 },
3351 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in
3352 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
3353 # notation (e.g. `10.96.0.0/14`). Leave blank to have
3354 # one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
3355 "subnetwork": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3356 # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which
3357 # the cluster is connected.
3358 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in
3359 # this cluster, in
3360 # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
3361 # notation (e.g. `1.2.3.4/29`). Service addresses are
3362 # typically put in the last `/16` from the container CIDR.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3363 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
3364 "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3365 # 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]3366 # is sufficient for this number of instances. You must also have available
3367 # firewall and routes quota.
3368 # For requests, this field should only be used in lieu of a
3369 # "node_pool" object, since this configuration (along with the
3370 # "node_config") will be used to create a "NodePool" object with an
3371 # auto-generated name. Do not use this and a node_pool at the same time.
3372 #
3373 # This field is deprecated, use node_pool.initial_node_count instead.
3374 },
3375 ],
3376 "missingZones": [ # If any zones are listed here, the list of clusters returned
3377 # may be missing those zones.
3378 "A String",
3379 ],
3380 }</pre>
3381</div>
3382
3383<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3384 <code class="details" id="setAddons">setAddons(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3385 <pre>Sets the addons for a specific cluster.
3386
3387Args:
3388 name: string, The name (project, location, cluster) of the cluster to set addons.
3389Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3390 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3391 The object takes the form of:
3392
3393{ # SetAddonsConfigRequest sets the addons associated with the cluster.
3394 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
3395 # number](https://support.google.com/cloud/answer/6158840).
3396 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3397 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Required. The desired configurations for the various addons available to run in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3398 # cluster.
3399 # cluster, enabling additional functionality.
3400 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which
3401 # makes it easy to set up HTTP load balancers for services in a cluster.
3402 # which makes it easy to set up HTTP load balancers for services in a cluster.
3403 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.
3404 # When enabled, it runs a small pod in the cluster that manages the load
3405 # balancers.
3406 },
3407 "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon
3408 # is enabled or not on the Master, it does not track whether network policy
3409 # is enabled for the nodes.
3410 # is enabled or not on the Master, it does not track whether network policy
3411 # is enabled for the nodes.
3412 "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
3413 },
3414 "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.
3415 # This addon is deprecated, and will be disabled in 1.15. It is recommended
3416 # to use the Cloud Console to manage and monitor your Kubernetes clusters,
3417 # workloads and applications. For more information, see:
3418 # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
3419 "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
3420 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3421 "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a
3422 # managed Knative service.
3423 "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
3424 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3425 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which
3426 # increases or decreases the number of replica pods a replication controller
3427 # has based on the resource usage of the existing pods.
3428 # increases or decreases the number of replica pods a replication controller
3429 # has based on the resource usage of the existing pods.
3430 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3431 # When enabled, it ensures that metrics are collected into Stackdriver
3432 # Monitoring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3433 },
3434 },
3435 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
3436 # This field has been deprecated and replaced by the name field.
3437 "name": "A String", # The name (project, location, cluster) of the cluster to set addons.
3438 # Specified in the format 'projects/*/locations/*/clusters/*'.
3439 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3440 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3441 # cluster resides. This field has been deprecated and replaced by the name
3442 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3443 }
3444
3445 x__xgafv: string, V1 error format.
3446 Allowed values
3447 1 - v1 error format
3448 2 - v2 error format
3449
3450Returns:
3451 An object of the form:
3452
3453 { # This operation resource represents operations that may have happened or are
3454 # happening on the cluster. All fields are output only.
3455 "status": "A String", # The current status of the operation.
3456 "selfLink": "A String", # Server-defined URL for the resource.
3457 "name": "A String", # The server-assigned ID for the operation.
3458 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3459 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3460 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3461 "detail": "A String", # Detailed operation progress, if available.
3462 "operationType": "A String", # The operation type.
3463 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3464 "nodepoolConditions": [ # Which conditions caused the current node pool state.
3465 { # StatusCondition describes why a cluster or a node pool has a certain status
3466 # (e.g., ERROR or DEGRADED).
3467 "message": "A String", # Human-friendly representation of the condition
3468 "code": "A String", # Machine-friendly representation of the condition
3469 },
3470 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3471 "clusterConditions": [ # Which conditions caused the current cluster state.
3472 { # StatusCondition describes why a cluster or a node pool has a certain status
3473 # (e.g., ERROR or DEGRADED).
3474 "message": "A String", # Human-friendly representation of the condition
3475 "code": "A String", # Machine-friendly representation of the condition
3476 },
3477 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3478 "startTime": "A String", # [Output only] The time the operation started, in
3479 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3480 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
3481 "status": "A String", # Status of an operation stage.
3482 # Unset for single-stage operations.
3483 "metrics": [ # Progress metric bundle, for example:
3484 # metrics: [{name: "nodes done", int_value: 15},
3485 # {name: "nodes total", int_value: 32}]
3486 # or
3487 # metrics: [{name: "progress", double_value: 0.56},
3488 # {name: "progress scale", double_value: 1.0}]
3489 { # Progress metric is (string, int|float|string) pair.
3490 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
3491 "intValue": "A String", # For metrics with integer value.
3492 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
3493 "doubleValue": 3.14, # For metrics with floating point value.
3494 },
3495 ],
3496 "stages": [ # Substages of an operation or a stage.
3497 # Object with schema name: OperationProgress
3498 ],
3499 "name": "A String", # A non-parameterized string describing an operation stage.
3500 # Unset for single-stage operations.
3501 },
3502 "endTime": "A String", # [Output only] The time the operation completed, in
3503 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3504 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
3505 "location": "A String", # [Output only] The name of the Google Compute Engine
3506 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3507 # or
3508 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3509 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3510 }</pre>
3511</div>
3512
3513<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3514 <code class="details" id="setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3515 <pre>Enables or disables the ABAC authorization mechanism on a cluster.
3516
3517Args:
3518 name: string, The name (project, location, cluster id) of the cluster to set legacy abac.
3519Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3520 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3521 The object takes the form of:
3522
3523{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for
3524 # a cluster.
3525 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
3526 # number](https://support.google.com/cloud/answer/6158840).
3527 # This field has been deprecated and replaced by the name field.
3528 "clusterId": "A String", # Deprecated. The name of the cluster to update.
3529 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3530 "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3531 "name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac.
3532 # Specified in the format 'projects/*/locations/*/clusters/*'.
3533 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3534 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3535 # cluster resides. This field has been deprecated and replaced by the name
3536 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3537 }
3538
3539 x__xgafv: string, V1 error format.
3540 Allowed values
3541 1 - v1 error format
3542 2 - v2 error format
3543
3544Returns:
3545 An object of the form:
3546
3547 { # This operation resource represents operations that may have happened or are
3548 # happening on the cluster. All fields are output only.
3549 "status": "A String", # The current status of the operation.
3550 "selfLink": "A String", # Server-defined URL for the resource.
3551 "name": "A String", # The server-assigned ID for the operation.
3552 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3553 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3554 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3555 "detail": "A String", # Detailed operation progress, if available.
3556 "operationType": "A String", # The operation type.
3557 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3558 "nodepoolConditions": [ # Which conditions caused the current node pool state.
3559 { # StatusCondition describes why a cluster or a node pool has a certain status
3560 # (e.g., ERROR or DEGRADED).
3561 "message": "A String", # Human-friendly representation of the condition
3562 "code": "A String", # Machine-friendly representation of the condition
3563 },
3564 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3565 "clusterConditions": [ # Which conditions caused the current cluster state.
3566 { # StatusCondition describes why a cluster or a node pool has a certain status
3567 # (e.g., ERROR or DEGRADED).
3568 "message": "A String", # Human-friendly representation of the condition
3569 "code": "A String", # Machine-friendly representation of the condition
3570 },
3571 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3572 "startTime": "A String", # [Output only] The time the operation started, in
3573 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3574 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
3575 "status": "A String", # Status of an operation stage.
3576 # Unset for single-stage operations.
3577 "metrics": [ # Progress metric bundle, for example:
3578 # metrics: [{name: "nodes done", int_value: 15},
3579 # {name: "nodes total", int_value: 32}]
3580 # or
3581 # metrics: [{name: "progress", double_value: 0.56},
3582 # {name: "progress scale", double_value: 1.0}]
3583 { # Progress metric is (string, int|float|string) pair.
3584 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
3585 "intValue": "A String", # For metrics with integer value.
3586 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
3587 "doubleValue": 3.14, # For metrics with floating point value.
3588 },
3589 ],
3590 "stages": [ # Substages of an operation or a stage.
3591 # Object with schema name: OperationProgress
3592 ],
3593 "name": "A String", # A non-parameterized string describing an operation stage.
3594 # Unset for single-stage operations.
3595 },
3596 "endTime": "A String", # [Output only] The time the operation completed, in
3597 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3598 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
3599 "location": "A String", # [Output only] The name of the Google Compute Engine
3600 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3601 # or
3602 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3603 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3604 }</pre>
3605</div>
3606
3607<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3608 <code class="details" id="setLocations">setLocations(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3609 <pre>Sets the locations for a specific cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3610Deprecated. Use
3611[projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update)
3612instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3613
3614Args:
3615 name: string, The name (project, location, cluster) of the cluster to set locations.
3616Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3617 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3618 The object takes the form of:
3619
3620{ # SetLocationsRequest sets the locations of the cluster.
3621 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
3622 # number](https://support.google.com/cloud/answer/6158840).
3623 # This field has been deprecated and replaced by the name field.
3624 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
3625 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3626 "name": "A String", # The name (project, location, cluster) of the cluster to set locations.
3627 # Specified in the format 'projects/*/locations/*/clusters/*'.
3628 "zone": "A String", # Deprecated. The name of the Google Compute Engine
3629 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3630 # cluster resides. This field has been deprecated and replaced by the name
3631 # field.
3632 "locations": [ # Required. The desired list of Google Compute Engine
3633 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
3634 # cluster's nodes should be located. Changing the locations a cluster is in
3635 # will result in nodes being either created or removed from the cluster,
3636 # depending on whether locations are being added or removed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3637 #
3638 # This list must always include the cluster's primary zone.
3639 "A String",
3640 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3641 }
3642
3643 x__xgafv: string, V1 error format.
3644 Allowed values
3645 1 - v1 error format
3646 2 - v2 error format
3647
3648Returns:
3649 An object of the form:
3650
3651 { # This operation resource represents operations that may have happened or are
3652 # happening on the cluster. All fields are output only.
3653 "status": "A String", # The current status of the operation.
3654 "selfLink": "A String", # Server-defined URL for the resource.
3655 "name": "A String", # The server-assigned ID for the operation.
3656 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3657 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3658 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3659 "detail": "A String", # Detailed operation progress, if available.
3660 "operationType": "A String", # The operation type.
3661 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3662 "nodepoolConditions": [ # Which conditions caused the current node pool state.
3663 { # StatusCondition describes why a cluster or a node pool has a certain status
3664 # (e.g., ERROR or DEGRADED).
3665 "message": "A String", # Human-friendly representation of the condition
3666 "code": "A String", # Machine-friendly representation of the condition
3667 },
3668 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3669 "clusterConditions": [ # Which conditions caused the current cluster state.
3670 { # StatusCondition describes why a cluster or a node pool has a certain status
3671 # (e.g., ERROR or DEGRADED).
3672 "message": "A String", # Human-friendly representation of the condition
3673 "code": "A String", # Machine-friendly representation of the condition
3674 },
3675 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3676 "startTime": "A String", # [Output only] The time the operation started, in
3677 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3678 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
3679 "status": "A String", # Status of an operation stage.
3680 # Unset for single-stage operations.
3681 "metrics": [ # Progress metric bundle, for example:
3682 # metrics: [{name: "nodes done", int_value: 15},
3683 # {name: "nodes total", int_value: 32}]
3684 # or
3685 # metrics: [{name: "progress", double_value: 0.56},
3686 # {name: "progress scale", double_value: 1.0}]
3687 { # Progress metric is (string, int|float|string) pair.
3688 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
3689 "intValue": "A String", # For metrics with integer value.
3690 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
3691 "doubleValue": 3.14, # For metrics with floating point value.
3692 },
3693 ],
3694 "stages": [ # Substages of an operation or a stage.
3695 # Object with schema name: OperationProgress
3696 ],
3697 "name": "A String", # A non-parameterized string describing an operation stage.
3698 # Unset for single-stage operations.
3699 },
3700 "endTime": "A String", # [Output only] The time the operation completed, in
3701 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3702 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
3703 "location": "A String", # [Output only] The name of the Google Compute Engine
3704 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3705 # or
3706 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3707 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3708 }</pre>
3709</div>
3710
3711<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3712 <code class="details" id="setLogging">setLogging(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3713 <pre>Sets the logging service for a specific cluster.
3714
3715Args:
3716 name: string, The name (project, location, cluster) of the cluster to set logging.
3717Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3718 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3719 The object takes the form of:
3720
3721{ # SetLoggingServiceRequest sets the logging service of a cluster.
3722 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
3723 # number](https://support.google.com/cloud/answer/6158840).
3724 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3725 "loggingService": "A String", # Required. The logging service the cluster should use to write logs.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3726 # Currently available options:
3727 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3728 # * `logging.googleapis.com/kubernetes` - The Cloud Logging
3729 # service with a Kubernetes-native resource model
3730 # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
3731 # available as of GKE 1.15).
3732 # * `none` - no logs will be exported from the cluster.
3733 #
3734 # If left as an empty string,`logging.googleapis.com/kubernetes` will be
3735 # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
3736 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3737 # This field has been deprecated and replaced by the name field.
3738 "name": "A String", # The name (project, location, cluster) of the cluster to set logging.
3739 # Specified in the format 'projects/*/locations/*/clusters/*'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3740 "zone": "A String", # Deprecated. The name of the Google Compute Engine
3741 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3742 # cluster resides. This field has been deprecated and replaced by the name
3743 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3744 }
3745
3746 x__xgafv: string, V1 error format.
3747 Allowed values
3748 1 - v1 error format
3749 2 - v2 error format
3750
3751Returns:
3752 An object of the form:
3753
3754 { # This operation resource represents operations that may have happened or are
3755 # happening on the cluster. All fields are output only.
3756 "status": "A String", # The current status of the operation.
3757 "selfLink": "A String", # Server-defined URL for the resource.
3758 "name": "A String", # The server-assigned ID for the operation.
3759 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3760 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3761 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3762 "detail": "A String", # Detailed operation progress, if available.
3763 "operationType": "A String", # The operation type.
3764 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3765 "nodepoolConditions": [ # Which conditions caused the current node pool state.
3766 { # StatusCondition describes why a cluster or a node pool has a certain status
3767 # (e.g., ERROR or DEGRADED).
3768 "message": "A String", # Human-friendly representation of the condition
3769 "code": "A String", # Machine-friendly representation of the condition
3770 },
3771 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3772 "clusterConditions": [ # Which conditions caused the current cluster state.
3773 { # StatusCondition describes why a cluster or a node pool has a certain status
3774 # (e.g., ERROR or DEGRADED).
3775 "message": "A String", # Human-friendly representation of the condition
3776 "code": "A String", # Machine-friendly representation of the condition
3777 },
3778 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3779 "startTime": "A String", # [Output only] The time the operation started, in
3780 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3781 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
3782 "status": "A String", # Status of an operation stage.
3783 # Unset for single-stage operations.
3784 "metrics": [ # Progress metric bundle, for example:
3785 # metrics: [{name: "nodes done", int_value: 15},
3786 # {name: "nodes total", int_value: 32}]
3787 # or
3788 # metrics: [{name: "progress", double_value: 0.56},
3789 # {name: "progress scale", double_value: 1.0}]
3790 { # Progress metric is (string, int|float|string) pair.
3791 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
3792 "intValue": "A String", # For metrics with integer value.
3793 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
3794 "doubleValue": 3.14, # For metrics with floating point value.
3795 },
3796 ],
3797 "stages": [ # Substages of an operation or a stage.
3798 # Object with schema name: OperationProgress
3799 ],
3800 "name": "A String", # A non-parameterized string describing an operation stage.
3801 # Unset for single-stage operations.
3802 },
3803 "endTime": "A String", # [Output only] The time the operation completed, in
3804 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3805 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
3806 "location": "A String", # [Output only] The name of the Google Compute Engine
3807 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3808 # or
3809 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3810 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3811 }</pre>
3812</div>
3813
3814<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3815 <code class="details" id="setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3816 <pre>Sets the maintenance policy for a cluster.
3817
3818Args:
3819 name: string, The name (project, location, cluster id) of the cluster to set maintenance
3820policy.
3821Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3822 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3823 The object takes the form of:
3824
3825{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3826 "projectId": "A String", # Required. The Google Developers Console [project ID or project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3827 # number](https://support.google.com/cloud/answer/6158840).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3828 "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3829 # clears the existing maintenance policy.
3830 "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3831 "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for
3832 # maintenance to occur. The time windows may be overlapping. If no
3833 # maintenance windows are set, maintenance can occur at any time.
3834 "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
3835 # this window reccurs. They go on for the span of time between the start and
3836 # end time.
3837 #
3838 # For example, to have something repeat every weekday, you'd use:
3839 # &lt;code&gt;FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR&lt;/code&gt;
3840 # To repeat some window daily (equivalent to the DailyMaintenanceWindow):
3841 # &lt;code&gt;FREQ=DAILY&lt;/code&gt;
3842 # For the first weekend of every month:
3843 # &lt;code&gt;FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU&lt;/code&gt;
3844 # This specifies how frequently the window starts. Eg, if you wanted to have
3845 # a 9-5 UTC-4 window every weekday, you'd use something like:
3846 # &lt;code&gt;
3847 # start time = 2019-01-01T09:00:00-0400
3848 # end time = 2019-01-01T17:00:00-0400
3849 # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
3850 # &lt;/code&gt;
3851 # Windows can span multiple days. Eg, to make the window encompass every
3852 # weekend from midnight Saturday till the last minute of Sunday UTC:
3853 # &lt;code&gt;
3854 # start time = 2019-01-05T00:00:00Z
3855 # end time = 2019-01-07T23:59:00Z
3856 # recurrence = FREQ=WEEKLY;BYDAY=SA
3857 # &lt;/code&gt;
3858 # Note the start and end time's specific dates are largely arbitrary except
3859 # to specify duration of the window and when it first starts.
3860 # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
3861 "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
3862 "endTime": "A String", # The time that the window ends. The end time should take place after the
3863 # start time.
3864 "startTime": "A String", # The time that the window first starts.
3865 },
3866 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3867 "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
3868 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be
3869 # smallest possible in the given scenario.
3870 # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
3871 # format "PTnHnMnS".
3872 "startTime": "A String", # Time within the maintenance window to start the maintenance operations.
3873 # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
3874 # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
3875 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3876 "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not
3877 # occur in these windows.
3878 "a_key": { # Represents an arbitrary window of time.
3879 "endTime": "A String", # The time that the window ends. The end time should take place after the
3880 # start time.
3881 "startTime": "A String", # The time that the window first starts.
3882 },
3883 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3884 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3885 "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of
3886 # the policy won't accidentally undo intermediate changes (and so that users
3887 # of the API unaware of some fields won't accidentally remove other fields).
3888 # Make a &lt;code&gt;get()&lt;/code&gt; request to the cluster to get the current
3889 # resource version and include it with requests to set the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3890 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3891 "clusterId": "A String", # Required. The name of the cluster to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3892 "name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance
3893 # policy.
3894 # Specified in the format 'projects/*/locations/*/clusters/*'.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3895 "zone": "A String", # Required. The name of the Google Compute Engine
3896 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3897 # cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3898 }
3899
3900 x__xgafv: string, V1 error format.
3901 Allowed values
3902 1 - v1 error format
3903 2 - v2 error format
3904
3905Returns:
3906 An object of the form:
3907
3908 { # This operation resource represents operations that may have happened or are
3909 # happening on the cluster. All fields are output only.
3910 "status": "A String", # The current status of the operation.
3911 "selfLink": "A String", # Server-defined URL for the resource.
3912 "name": "A String", # The server-assigned ID for the operation.
3913 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3914 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3915 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3916 "detail": "A String", # Detailed operation progress, if available.
3917 "operationType": "A String", # The operation type.
3918 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3919 "nodepoolConditions": [ # Which conditions caused the current node pool state.
3920 { # StatusCondition describes why a cluster or a node pool has a certain status
3921 # (e.g., ERROR or DEGRADED).
3922 "message": "A String", # Human-friendly representation of the condition
3923 "code": "A String", # Machine-friendly representation of the condition
3924 },
3925 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3926 "clusterConditions": [ # Which conditions caused the current cluster state.
3927 { # StatusCondition describes why a cluster or a node pool has a certain status
3928 # (e.g., ERROR or DEGRADED).
3929 "message": "A String", # Human-friendly representation of the condition
3930 "code": "A String", # Machine-friendly representation of the condition
3931 },
3932 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3933 "startTime": "A String", # [Output only] The time the operation started, in
3934 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3935 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
3936 "status": "A String", # Status of an operation stage.
3937 # Unset for single-stage operations.
3938 "metrics": [ # Progress metric bundle, for example:
3939 # metrics: [{name: "nodes done", int_value: 15},
3940 # {name: "nodes total", int_value: 32}]
3941 # or
3942 # metrics: [{name: "progress", double_value: 0.56},
3943 # {name: "progress scale", double_value: 1.0}]
3944 { # Progress metric is (string, int|float|string) pair.
3945 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
3946 "intValue": "A String", # For metrics with integer value.
3947 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
3948 "doubleValue": 3.14, # For metrics with floating point value.
3949 },
3950 ],
3951 "stages": [ # Substages of an operation or a stage.
3952 # Object with schema name: OperationProgress
3953 ],
3954 "name": "A String", # A non-parameterized string describing an operation stage.
3955 # Unset for single-stage operations.
3956 },
3957 "endTime": "A String", # [Output only] The time the operation completed, in
3958 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
3959 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
3960 "location": "A String", # [Output only] The name of the Google Compute Engine
3961 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3962 # or
3963 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
3964 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3965 }</pre>
3966</div>
3967
3968<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3969 <code class="details" id="setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3970 <pre>Sets master auth materials. Currently supports changing the admin password
3971or a specific cluster, either via password generation or explicitly setting
3972the password.
3973
3974Args:
3975 name: string, The name (project, location, cluster) of the cluster to set auth.
3976Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3977 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3978 The object takes the form of:
3979
3980{ # SetMasterAuthRequest updates the admin password of a cluster.
3981 "name": "A String", # The name (project, location, cluster) of the cluster to set auth.
3982 # Specified in the format 'projects/*/locations/*/clusters/*'.
3983 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3984 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
3985 # cluster resides. This field has been deprecated and replaced by the name
3986 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3987 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
3988 # number](https://support.google.com/cloud/answer/6158840).
3989 # This field has been deprecated and replaced by the name field.
3990 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
3991 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3992 "update": { # The authentication information for accessing the master endpoint. # Required. A description of the update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3993 # Authentication can be done using HTTP basic auth or using client
3994 # certificates.
3995 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
3996 # For clusters v1.6.0 and later, basic authentication can be disabled by
3997 # leaving username unspecified (or setting it to the empty string).
3998 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate
3999 # to the cluster endpoint.
4000 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to
4001 # authenticate to the cluster endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4002 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of
4003 # trust for the cluster.
4004 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint.
4005 # Because the master endpoint is open to the Internet, you should create a
4006 # strong password. If a password is provided for cluster creation, username
4007 # must be non-empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4008 "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For
4009 # clusters before v1.12, if no configuration is specified, a client
4010 # certificate is issued.
4011 "issueClientCertificate": True or False, # Issue a client certificate.
4012 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4013 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4014 "action": "A String", # Required. The exact form of action to be taken on the master auth.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4015 }
4016
4017 x__xgafv: string, V1 error format.
4018 Allowed values
4019 1 - v1 error format
4020 2 - v2 error format
4021
4022Returns:
4023 An object of the form:
4024
4025 { # This operation resource represents operations that may have happened or are
4026 # happening on the cluster. All fields are output only.
4027 "status": "A String", # The current status of the operation.
4028 "selfLink": "A String", # Server-defined URL for the resource.
4029 "name": "A String", # The server-assigned ID for the operation.
4030 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4031 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4032 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4033 "detail": "A String", # Detailed operation progress, if available.
4034 "operationType": "A String", # The operation type.
4035 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4036 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4037 { # StatusCondition describes why a cluster or a node pool has a certain status
4038 # (e.g., ERROR or DEGRADED).
4039 "message": "A String", # Human-friendly representation of the condition
4040 "code": "A String", # Machine-friendly representation of the condition
4041 },
4042 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4043 "clusterConditions": [ # Which conditions caused the current cluster state.
4044 { # StatusCondition describes why a cluster or a node pool has a certain status
4045 # (e.g., ERROR or DEGRADED).
4046 "message": "A String", # Human-friendly representation of the condition
4047 "code": "A String", # Machine-friendly representation of the condition
4048 },
4049 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4050 "startTime": "A String", # [Output only] The time the operation started, in
4051 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4052 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4053 "status": "A String", # Status of an operation stage.
4054 # Unset for single-stage operations.
4055 "metrics": [ # Progress metric bundle, for example:
4056 # metrics: [{name: "nodes done", int_value: 15},
4057 # {name: "nodes total", int_value: 32}]
4058 # or
4059 # metrics: [{name: "progress", double_value: 0.56},
4060 # {name: "progress scale", double_value: 1.0}]
4061 { # Progress metric is (string, int|float|string) pair.
4062 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4063 "intValue": "A String", # For metrics with integer value.
4064 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4065 "doubleValue": 3.14, # For metrics with floating point value.
4066 },
4067 ],
4068 "stages": [ # Substages of an operation or a stage.
4069 # Object with schema name: OperationProgress
4070 ],
4071 "name": "A String", # A non-parameterized string describing an operation stage.
4072 # Unset for single-stage operations.
4073 },
4074 "endTime": "A String", # [Output only] The time the operation completed, in
4075 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4076 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4077 "location": "A String", # [Output only] The name of the Google Compute Engine
4078 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4079 # or
4080 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4081 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4082 }</pre>
4083</div>
4084
4085<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4086 <code class="details" id="setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4087 <pre>Sets the monitoring service for a specific cluster.
4088
4089Args:
4090 name: string, The name (project, location, cluster) of the cluster to set monitoring.
4091Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4092 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4093 The object takes the form of:
4094
4095{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.
4096 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4097 # number](https://support.google.com/cloud/answer/6158840).
4098 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4099 "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4100 # Currently available options:
4101 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4102 # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
4103 # service with a Kubernetes-native resource model
4104 # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
4105 # longer available as of GKE 1.15).
4106 # * `none` - No metrics will be exported from the cluster.
4107 #
4108 # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
4109 # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4110 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
4111 # This field has been deprecated and replaced by the name field.
4112 "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring.
4113 # Specified in the format 'projects/*/locations/*/clusters/*'.
4114 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4115 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4116 # cluster resides. This field has been deprecated and replaced by the name
4117 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4118 }
4119
4120 x__xgafv: string, V1 error format.
4121 Allowed values
4122 1 - v1 error format
4123 2 - v2 error format
4124
4125Returns:
4126 An object of the form:
4127
4128 { # This operation resource represents operations that may have happened or are
4129 # happening on the cluster. All fields are output only.
4130 "status": "A String", # The current status of the operation.
4131 "selfLink": "A String", # Server-defined URL for the resource.
4132 "name": "A String", # The server-assigned ID for the operation.
4133 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4134 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4135 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4136 "detail": "A String", # Detailed operation progress, if available.
4137 "operationType": "A String", # The operation type.
4138 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4139 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4140 { # StatusCondition describes why a cluster or a node pool has a certain status
4141 # (e.g., ERROR or DEGRADED).
4142 "message": "A String", # Human-friendly representation of the condition
4143 "code": "A String", # Machine-friendly representation of the condition
4144 },
4145 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4146 "clusterConditions": [ # Which conditions caused the current cluster state.
4147 { # StatusCondition describes why a cluster or a node pool has a certain status
4148 # (e.g., ERROR or DEGRADED).
4149 "message": "A String", # Human-friendly representation of the condition
4150 "code": "A String", # Machine-friendly representation of the condition
4151 },
4152 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4153 "startTime": "A String", # [Output only] The time the operation started, in
4154 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4155 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4156 "status": "A String", # Status of an operation stage.
4157 # Unset for single-stage operations.
4158 "metrics": [ # Progress metric bundle, for example:
4159 # metrics: [{name: "nodes done", int_value: 15},
4160 # {name: "nodes total", int_value: 32}]
4161 # or
4162 # metrics: [{name: "progress", double_value: 0.56},
4163 # {name: "progress scale", double_value: 1.0}]
4164 { # Progress metric is (string, int|float|string) pair.
4165 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4166 "intValue": "A String", # For metrics with integer value.
4167 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4168 "doubleValue": 3.14, # For metrics with floating point value.
4169 },
4170 ],
4171 "stages": [ # Substages of an operation or a stage.
4172 # Object with schema name: OperationProgress
4173 ],
4174 "name": "A String", # A non-parameterized string describing an operation stage.
4175 # Unset for single-stage operations.
4176 },
4177 "endTime": "A String", # [Output only] The time the operation completed, in
4178 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4179 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4180 "location": "A String", # [Output only] The name of the Google Compute Engine
4181 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4182 # or
4183 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4184 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4185 }</pre>
4186</div>
4187
4188<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4189 <code class="details" id="setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4190 <pre>Enables or disables Network Policy for a cluster.
4191
4192Args:
4193 name: string, The name (project, location, cluster id) of the cluster to set networking
4194policy. Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4195 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4196 The object takes the form of:
4197
4198{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.
4199 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4200 # number](https://developers.google.com/console/help/new/#projectnumber).
4201 # This field has been deprecated and replaced by the name field.
4202 "clusterId": "A String", # Deprecated. The name of the cluster.
4203 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4204 "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4205 # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
4206 "enabled": True or False, # Whether network policy is enabled on the cluster.
4207 "provider": "A String", # The selected network policy provider.
4208 },
4209 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4210 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4211 # cluster resides. This field has been deprecated and replaced by the name
4212 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4213 "name": "A String", # The name (project, location, cluster id) of the cluster to set networking
4214 # policy. Specified in the format 'projects/*/locations/*/clusters/*'.
4215 }
4216
4217 x__xgafv: string, V1 error format.
4218 Allowed values
4219 1 - v1 error format
4220 2 - v2 error format
4221
4222Returns:
4223 An object of the form:
4224
4225 { # This operation resource represents operations that may have happened or are
4226 # happening on the cluster. All fields are output only.
4227 "status": "A String", # The current status of the operation.
4228 "selfLink": "A String", # Server-defined URL for the resource.
4229 "name": "A String", # The server-assigned ID for the operation.
4230 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4231 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4232 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4233 "detail": "A String", # Detailed operation progress, if available.
4234 "operationType": "A String", # The operation type.
4235 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4236 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4237 { # StatusCondition describes why a cluster or a node pool has a certain status
4238 # (e.g., ERROR or DEGRADED).
4239 "message": "A String", # Human-friendly representation of the condition
4240 "code": "A String", # Machine-friendly representation of the condition
4241 },
4242 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4243 "clusterConditions": [ # Which conditions caused the current cluster state.
4244 { # StatusCondition describes why a cluster or a node pool has a certain status
4245 # (e.g., ERROR or DEGRADED).
4246 "message": "A String", # Human-friendly representation of the condition
4247 "code": "A String", # Machine-friendly representation of the condition
4248 },
4249 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4250 "startTime": "A String", # [Output only] The time the operation started, in
4251 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4252 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4253 "status": "A String", # Status of an operation stage.
4254 # Unset for single-stage operations.
4255 "metrics": [ # Progress metric bundle, for example:
4256 # metrics: [{name: "nodes done", int_value: 15},
4257 # {name: "nodes total", int_value: 32}]
4258 # or
4259 # metrics: [{name: "progress", double_value: 0.56},
4260 # {name: "progress scale", double_value: 1.0}]
4261 { # Progress metric is (string, int|float|string) pair.
4262 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4263 "intValue": "A String", # For metrics with integer value.
4264 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4265 "doubleValue": 3.14, # For metrics with floating point value.
4266 },
4267 ],
4268 "stages": [ # Substages of an operation or a stage.
4269 # Object with schema name: OperationProgress
4270 ],
4271 "name": "A String", # A non-parameterized string describing an operation stage.
4272 # Unset for single-stage operations.
4273 },
4274 "endTime": "A String", # [Output only] The time the operation completed, in
4275 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4276 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4277 "location": "A String", # [Output only] The name of the Google Compute Engine
4278 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4279 # or
4280 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4281 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4282 }</pre>
4283</div>
4284
4285<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4286 <code class="details" id="setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4287 <pre>Sets labels on a cluster.
4288
4289Args:
4290 name: string, The name (project, location, cluster id) of the cluster to set labels.
4291Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4292 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4293 The object takes the form of:
4294
4295{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container
4296 # Engine cluster, which will in turn set them for Google Compute Engine
4297 # resources used by that cluster
4298 "name": "A String", # The name (project, location, cluster id) of the cluster to set labels.
4299 # Specified in the format 'projects/*/locations/*/clusters/*'.
4300 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4301 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4302 # cluster resides. This field has been deprecated and replaced by the name
4303 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4304 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4305 # number](https://developers.google.com/console/help/new/#projectnumber).
4306 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4307 "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4308 # used to detect conflicts. The fingerprint is initially generated by
4309 # Kubernetes Engine and changes after every request to modify or update
4310 # labels. You must always provide an up-to-date fingerprint hash when
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4311 # updating or changing labels. Make a &lt;code&gt;get()&lt;/code&gt; request to the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4312 # resource to get the latest fingerprint.
4313 "clusterId": "A String", # Deprecated. The name of the cluster.
4314 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4315 "resourceLabels": { # Required. The labels to set for that cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4316 "a_key": "A String",
4317 },
4318 }
4319
4320 x__xgafv: string, V1 error format.
4321 Allowed values
4322 1 - v1 error format
4323 2 - v2 error format
4324
4325Returns:
4326 An object of the form:
4327
4328 { # This operation resource represents operations that may have happened or are
4329 # happening on the cluster. All fields are output only.
4330 "status": "A String", # The current status of the operation.
4331 "selfLink": "A String", # Server-defined URL for the resource.
4332 "name": "A String", # The server-assigned ID for the operation.
4333 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4334 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4335 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4336 "detail": "A String", # Detailed operation progress, if available.
4337 "operationType": "A String", # The operation type.
4338 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4339 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4340 { # StatusCondition describes why a cluster or a node pool has a certain status
4341 # (e.g., ERROR or DEGRADED).
4342 "message": "A String", # Human-friendly representation of the condition
4343 "code": "A String", # Machine-friendly representation of the condition
4344 },
4345 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4346 "clusterConditions": [ # Which conditions caused the current cluster state.
4347 { # StatusCondition describes why a cluster or a node pool has a certain status
4348 # (e.g., ERROR or DEGRADED).
4349 "message": "A String", # Human-friendly representation of the condition
4350 "code": "A String", # Machine-friendly representation of the condition
4351 },
4352 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4353 "startTime": "A String", # [Output only] The time the operation started, in
4354 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4355 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4356 "status": "A String", # Status of an operation stage.
4357 # Unset for single-stage operations.
4358 "metrics": [ # Progress metric bundle, for example:
4359 # metrics: [{name: "nodes done", int_value: 15},
4360 # {name: "nodes total", int_value: 32}]
4361 # or
4362 # metrics: [{name: "progress", double_value: 0.56},
4363 # {name: "progress scale", double_value: 1.0}]
4364 { # Progress metric is (string, int|float|string) pair.
4365 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4366 "intValue": "A String", # For metrics with integer value.
4367 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4368 "doubleValue": 3.14, # For metrics with floating point value.
4369 },
4370 ],
4371 "stages": [ # Substages of an operation or a stage.
4372 # Object with schema name: OperationProgress
4373 ],
4374 "name": "A String", # A non-parameterized string describing an operation stage.
4375 # Unset for single-stage operations.
4376 },
4377 "endTime": "A String", # [Output only] The time the operation completed, in
4378 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4379 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4380 "location": "A String", # [Output only] The name of the Google Compute Engine
4381 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4382 # or
4383 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4384 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4385 }</pre>
4386</div>
4387
4388<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4389 <code class="details" id="startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4390 <pre>Starts master IP rotation.
4391
4392Args:
4393 name: string, The name (project, location, cluster id) of the cluster to start IP
4394rotation. Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4395 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4396 The object takes the form of:
4397
4398{ # StartIPRotationRequest creates a new IP for the cluster and then performs
4399 # a node upgrade on each node pool to point to the new IP.
4400 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4401 # number](https://developers.google.com/console/help/new/#projectnumber).
4402 # This field has been deprecated and replaced by the name field.
4403 "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.
4404 "clusterId": "A String", # Deprecated. The name of the cluster.
4405 # This field has been deprecated and replaced by the name field.
4406 "name": "A String", # The name (project, location, cluster id) of the cluster to start IP
4407 # rotation. Specified in the format 'projects/*/locations/*/clusters/*'.
4408 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4409 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4410 # cluster resides. This field has been deprecated and replaced by the name
4411 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4412 }
4413
4414 x__xgafv: string, V1 error format.
4415 Allowed values
4416 1 - v1 error format
4417 2 - v2 error format
4418
4419Returns:
4420 An object of the form:
4421
4422 { # This operation resource represents operations that may have happened or are
4423 # happening on the cluster. All fields are output only.
4424 "status": "A String", # The current status of the operation.
4425 "selfLink": "A String", # Server-defined URL for the resource.
4426 "name": "A String", # The server-assigned ID for the operation.
4427 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4428 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4429 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4430 "detail": "A String", # Detailed operation progress, if available.
4431 "operationType": "A String", # The operation type.
4432 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4433 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4434 { # StatusCondition describes why a cluster or a node pool has a certain status
4435 # (e.g., ERROR or DEGRADED).
4436 "message": "A String", # Human-friendly representation of the condition
4437 "code": "A String", # Machine-friendly representation of the condition
4438 },
4439 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4440 "clusterConditions": [ # Which conditions caused the current cluster state.
4441 { # StatusCondition describes why a cluster or a node pool has a certain status
4442 # (e.g., ERROR or DEGRADED).
4443 "message": "A String", # Human-friendly representation of the condition
4444 "code": "A String", # Machine-friendly representation of the condition
4445 },
4446 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4447 "startTime": "A String", # [Output only] The time the operation started, in
4448 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4449 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4450 "status": "A String", # Status of an operation stage.
4451 # Unset for single-stage operations.
4452 "metrics": [ # Progress metric bundle, for example:
4453 # metrics: [{name: "nodes done", int_value: 15},
4454 # {name: "nodes total", int_value: 32}]
4455 # or
4456 # metrics: [{name: "progress", double_value: 0.56},
4457 # {name: "progress scale", double_value: 1.0}]
4458 { # Progress metric is (string, int|float|string) pair.
4459 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4460 "intValue": "A String", # For metrics with integer value.
4461 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4462 "doubleValue": 3.14, # For metrics with floating point value.
4463 },
4464 ],
4465 "stages": [ # Substages of an operation or a stage.
4466 # Object with schema name: OperationProgress
4467 ],
4468 "name": "A String", # A non-parameterized string describing an operation stage.
4469 # Unset for single-stage operations.
4470 },
4471 "endTime": "A String", # [Output only] The time the operation completed, in
4472 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4473 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4474 "location": "A String", # [Output only] The name of the Google Compute Engine
4475 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4476 # or
4477 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4478 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4479 }</pre>
4480</div>
4481
4482<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4483 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4484 <pre>Updates the settings of a specific cluster.
4485
4486Args:
4487 name: string, The name (project, location, cluster) of the cluster to update.
4488Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4489 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4490 The object takes the form of:
4491
4492{ # UpdateClusterRequest updates the settings of a cluster.
4493 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4494 # number](https://support.google.com/cloud/answer/6158840).
4495 # This field has been deprecated and replaced by the name field.
4496 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
4497 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4498 "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4499 # be applied to a cluster with each request, so at most one field can be
4500 # provided.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4501 "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility.
4502 # visibility on this cluster.
4503 "enabled": True or False, # Enables intra node visibility for this cluster.
4504 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4505 "desiredLoggingService": "A String", # The logging service the cluster should use to write logs.
4506 # Currently available options:
4507 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4508 # * `logging.googleapis.com/kubernetes` - The Cloud Logging
4509 # service with a Kubernetes-native resource model
4510 # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
4511 # available as of GKE 1.15).
4512 # * `none` - no logs will be exported from the cluster.
4513 #
4514 # If left as an empty string,`logging.googleapis.com/kubernetes` will be
4515 # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4516 "desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature.
4517 # master authorized networks will disallow all external traffic to access
4518 # Kubernetes master through HTTPS except traffic from the given CIDR blocks,
4519 # Google Compute Engine Public IPs and Google Prod IPs.
4520 "enabled": True or False, # Whether or not master authorized networks is enabled.
4521 "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access
4522 # Kubernetes master through HTTPS.
4523 { # CidrBlock contains an optional name and one CIDR block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4524 "cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4525 "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4526 },
4527 ],
4528 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4529 "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration.
4530 # required by Vertical Pod Autoscaler to automatically adjust
4531 # the resources of pods controlled by it.
4532 "enabled": True or False, # Enables vertical pod autoscaling.
4533 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4534 "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster.
4535 # cluster, enabling additional functionality.
4536 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which
4537 # makes it easy to set up HTTP load balancers for services in a cluster.
4538 # which makes it easy to set up HTTP load balancers for services in a cluster.
4539 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster.
4540 # When enabled, it runs a small pod in the cluster that manages the load
4541 # balancers.
4542 },
4543 "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon
4544 # is enabled or not on the Master, it does not track whether network policy
4545 # is enabled for the nodes.
4546 # is enabled or not on the Master, it does not track whether network policy
4547 # is enabled for the nodes.
4548 "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
4549 },
4550 "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard.
4551 # This addon is deprecated, and will be disabled in 1.15. It is recommended
4552 # to use the Cloud Console to manage and monitor your Kubernetes clusters,
4553 # workloads and applications. For more information, see:
4554 # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
4555 "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
4556 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4557 "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a
4558 # managed Knative service.
4559 "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
4560 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4561 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which
4562 # increases or decreases the number of replica pods a replication controller
4563 # has based on the resource usage of the existing pods.
4564 # increases or decreases the number of replica pods a replication controller
4565 # has based on the resource usage of the existing pods.
4566 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4567 # When enabled, it ensures that metrics are collected into Stackdriver
4568 # Monitoring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4569 },
4570 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4571 "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration.
4572 # required by Cluster Autoscaler to automatically adjust
4573 # the size of the cluster and create/delete
4574 # node pools based on the current needs.
4575 "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool
4576 # created by NAP.
4577 # by NAP.
4578 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
4579 # service_account is specified, scopes should be empty.
4580 "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools.
4581 # node pool.
4582 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node
4583 # pool. If enabled, the nodes in this node pool will be monitored and, if
4584 # they fail health checks too many times, an automatic repair action will be
4585 # triggered.
4586 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
4587 # the Auto Upgrades will proceed.
4588 "description": "A String", # [Output only] This field is set when upgrades are about to commence
4589 # with the description of the upgrade.
4590 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
4591 # with the approximate start time for the upgrades, in
4592 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4593 },
4594 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node
4595 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool
4596 # up to date with the latest release version of Kubernetes.
4597 },
4598 "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools
4599 # disruption caused by an upgrade.
4600 #
4601 # maxUnavailable controls the number of nodes that can be simultaneously
4602 # unavailable.
4603 #
4604 # maxSurge controls the number of additional nodes that can be added to the
4605 # node pool temporarily for the time of the upgrade to increase the number of
4606 # available nodes.
4607 #
4608 # (maxUnavailable + maxSurge) determines the level of parallelism (how many
4609 # nodes are being upgraded at the same time).
4610 #
4611 # Note: upgrades inevitably introduce some disruption since workloads need to
4612 # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
4613 # this holds true. (Disruption stays within the limits of
4614 # PodDisruptionBudget, if it is configured.)
4615 #
4616 # Consider a hypothetical node pool with 5 nodes having maxSurge=2,
4617 # maxUnavailable=1. This means the upgrade process upgrades 3 nodes
4618 # simultaneously. It creates 2 additional (upgraded) nodes, then it brings
4619 # down 3 old (not yet upgraded) nodes at the same time. This ensures that
4620 # there are always at least 4 nodes available.
4621 "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size
4622 # of the node pool during the upgrade process.
4623 "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during
4624 # the upgrade process. A node is considered available if its status is
4625 # Ready.
4626 },
4627 "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are
4628 # specified, service_account should be empty.
4629 "A String",
4630 ],
4631 },
4632 "resourceLimits": [ # Contains global constraints regarding minimum and maximum
4633 # amount of resources in the cluster.
4634 { # Contains information about amount of some resource in the cluster.
4635 # For memory, value should be in GB.
4636 "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
4637 "minimum": "A String", # Minimum amount of the resource in the cluster.
4638 "maximum": "A String", # Maximum amount of the resource in the cluster.
4639 },
4640 ],
4641 "autoprovisioningLocations": [ # The list of Google Compute Engine
4642 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
4643 # NodePool's nodes can be created by NAP.
4644 "A String",
4645 ],
4646 "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
4647 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4648 "desiredMasterVersion": "A String", # The Kubernetes version to change the master to.
4649 #
4650 # Users may specify either explicit versions offered by
4651 # Kubernetes Engine or version aliases, which have the following behavior:
4652 #
4653 # - "latest": picks the highest valid Kubernetes version
4654 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
4655 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
4656 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
4657 # - "-": picks the default Kubernetes version
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4658 "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if
4659 # "desired_node_version", "desired_image_family" or
4660 # "desired_node_pool_autoscaling" is specified and there is more than one
4661 # node pool on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4662 "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an
4663 # upgrade).
4664 #
4665 # Users may specify either explicit versions offered by
4666 # Kubernetes Engine or version aliases, which have the following behavior:
4667 #
4668 # - "latest": picks the highest valid Kubernetes version
4669 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
4670 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
4671 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
4672 # - "-": picks the Kubernetes master version
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4673 "desiredImageType": "A String", # The desired image type for the node pool.
4674 # NOTE: Set the "desired_node_pool" field as well.
4675 "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.
4676 "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container
4677 # images will be validated by Binary Authorization.
4678 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4679 "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics.
4680 # Currently available options:
4681 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4682 # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
4683 # service with a Kubernetes-native resource model
4684 # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
4685 # longer available as of GKE 1.15).
4686 # * `none` - No metrics will be exported from the cluster.
4687 #
4688 # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
4689 # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
4690 "desiredLocations": [ # The desired list of Google Compute Engine
4691 # [zones](https://cloud.google.com/compute/docs/zones#available) in which the
4692 # cluster's nodes should be located. Changing the locations a cluster is in
4693 # will result in nodes being either created or removed from the cluster,
4694 # depending on whether locations are being added or removed.
4695 #
4696 # This list must always include the cluster's primary zone.
4697 "A String",
4698 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4699 "desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.
4700 "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
4701 "datasetId": "A String", # The ID of a BigQuery Dataset.
4702 },
4703 "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a
4704 # daemonset will be created in the cluster to meter network egress traffic.
4705 "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
4706 "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a
4707 # second BigQuery table will be created to hold resource consumption
4708 # records.
4709 },
4710 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4711 "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity.
4712 # policies.
4713 "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
4714 },
4715 "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.
4716 "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
4717 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4718 "desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in
4719 # desired_node_pool_id. If there is only one pool in the
4720 # cluster and desired_node_pool_id is not provided then
4721 # the change applies to that single node pool.
4722 # adjust the size of the node pool to the current cluster usage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4723 "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]4724 # max_node_count.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4725 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4726 "enabled": True or False, # Is autoscaling enabled for this node pool.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4727 "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]4728 # has to enough quota to scale up the cluster.
4729 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4730 "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
4731 "state": "A String", # Denotes the state of etcd encryption.
4732 "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd.
4733 # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
4734 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4735 },
4736 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4737 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4738 # cluster resides. This field has been deprecated and replaced by the name
4739 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4740 "name": "A String", # The name (project, location, cluster) of the cluster to update.
4741 # Specified in the format 'projects/*/locations/*/clusters/*'.
4742 }
4743
4744 x__xgafv: string, V1 error format.
4745 Allowed values
4746 1 - v1 error format
4747 2 - v2 error format
4748
4749Returns:
4750 An object of the form:
4751
4752 { # This operation resource represents operations that may have happened or are
4753 # happening on the cluster. All fields are output only.
4754 "status": "A String", # The current status of the operation.
4755 "selfLink": "A String", # Server-defined URL for the resource.
4756 "name": "A String", # The server-assigned ID for the operation.
4757 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4758 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4759 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4760 "detail": "A String", # Detailed operation progress, if available.
4761 "operationType": "A String", # The operation type.
4762 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4763 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4764 { # StatusCondition describes why a cluster or a node pool has a certain status
4765 # (e.g., ERROR or DEGRADED).
4766 "message": "A String", # Human-friendly representation of the condition
4767 "code": "A String", # Machine-friendly representation of the condition
4768 },
4769 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4770 "clusterConditions": [ # Which conditions caused the current cluster state.
4771 { # StatusCondition describes why a cluster or a node pool has a certain status
4772 # (e.g., ERROR or DEGRADED).
4773 "message": "A String", # Human-friendly representation of the condition
4774 "code": "A String", # Machine-friendly representation of the condition
4775 },
4776 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4777 "startTime": "A String", # [Output only] The time the operation started, in
4778 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4779 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4780 "status": "A String", # Status of an operation stage.
4781 # Unset for single-stage operations.
4782 "metrics": [ # Progress metric bundle, for example:
4783 # metrics: [{name: "nodes done", int_value: 15},
4784 # {name: "nodes total", int_value: 32}]
4785 # or
4786 # metrics: [{name: "progress", double_value: 0.56},
4787 # {name: "progress scale", double_value: 1.0}]
4788 { # Progress metric is (string, int|float|string) pair.
4789 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4790 "intValue": "A String", # For metrics with integer value.
4791 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4792 "doubleValue": 3.14, # For metrics with floating point value.
4793 },
4794 ],
4795 "stages": [ # Substages of an operation or a stage.
4796 # Object with schema name: OperationProgress
4797 ],
4798 "name": "A String", # A non-parameterized string describing an operation stage.
4799 # Unset for single-stage operations.
4800 },
4801 "endTime": "A String", # [Output only] The time the operation completed, in
4802 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4803 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4804 "location": "A String", # [Output only] The name of the Google Compute Engine
4805 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4806 # or
4807 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4808 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4809 }</pre>
4810</div>
4811
4812<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4813 <code class="details" id="updateMaster">updateMaster(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4814 <pre>Updates the master for a specific cluster.
4815
4816Args:
4817 name: string, The name (project, location, cluster) of the cluster to update.
4818Specified in the format 'projects/*/locations/*/clusters/*'. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4819 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4820 The object takes the form of:
4821
4822{ # UpdateMasterRequest updates the master of the cluster.
4823 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
4824 # number](https://support.google.com/cloud/answer/6158840).
4825 # This field has been deprecated and replaced by the name field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4826 "masterVersion": "A String", # Required. The Kubernetes version to change the master to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4827 #
4828 # Users may specify either explicit versions offered by Kubernetes Engine or
4829 # version aliases, which have the following behavior:
4830 #
4831 # - "latest": picks the highest valid Kubernetes version
4832 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
4833 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
4834 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
4835 # - "-": picks the default Kubernetes version
4836 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
4837 # This field has been deprecated and replaced by the name field.
4838 "name": "A String", # The name (project, location, cluster) of the cluster to update.
4839 # Specified in the format 'projects/*/locations/*/clusters/*'.
4840 "zone": "A String", # Deprecated. The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4841 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4842 # cluster resides. This field has been deprecated and replaced by the name
4843 # field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4844 }
4845
4846 x__xgafv: string, V1 error format.
4847 Allowed values
4848 1 - v1 error format
4849 2 - v2 error format
4850
4851Returns:
4852 An object of the form:
4853
4854 { # This operation resource represents operations that may have happened or are
4855 # happening on the cluster. All fields are output only.
4856 "status": "A String", # The current status of the operation.
4857 "selfLink": "A String", # Server-defined URL for the resource.
4858 "name": "A String", # The server-assigned ID for the operation.
4859 "zone": "A String", # The name of the Google Compute Engine
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4860 # [zone](https://cloud.google.com/compute/docs/zones#available) in which the
4861 # operation is taking place. This field is deprecated, use location instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4862 "detail": "A String", # Detailed operation progress, if available.
4863 "operationType": "A String", # The operation type.
4864 "targetLink": "A String", # Server-defined URL for the target of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4865 "nodepoolConditions": [ # Which conditions caused the current node pool state.
4866 { # StatusCondition describes why a cluster or a node pool has a certain status
4867 # (e.g., ERROR or DEGRADED).
4868 "message": "A String", # Human-friendly representation of the condition
4869 "code": "A String", # Machine-friendly representation of the condition
4870 },
4871 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4872 "clusterConditions": [ # Which conditions caused the current cluster state.
4873 { # StatusCondition describes why a cluster or a node pool has a certain status
4874 # (e.g., ERROR or DEGRADED).
4875 "message": "A String", # Human-friendly representation of the condition
4876 "code": "A String", # Machine-friendly representation of the condition
4877 },
4878 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4879 "startTime": "A String", # [Output only] The time the operation started, in
4880 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4881 "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
4882 "status": "A String", # Status of an operation stage.
4883 # Unset for single-stage operations.
4884 "metrics": [ # Progress metric bundle, for example:
4885 # metrics: [{name: "nodes done", int_value: 15},
4886 # {name: "nodes total", int_value: 32}]
4887 # or
4888 # metrics: [{name: "progress", double_value: 0.56},
4889 # {name: "progress scale", double_value: 1.0}]
4890 { # Progress metric is (string, int|float|string) pair.
4891 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
4892 "intValue": "A String", # For metrics with integer value.
4893 "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
4894 "doubleValue": 3.14, # For metrics with floating point value.
4895 },
4896 ],
4897 "stages": [ # Substages of an operation or a stage.
4898 # Object with schema name: OperationProgress
4899 ],
4900 "name": "A String", # A non-parameterized string describing an operation stage.
4901 # Unset for single-stage operations.
4902 },
4903 "endTime": "A String", # [Output only] The time the operation completed, in
4904 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
4905 "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error.
4906 "location": "A String", # [Output only] The name of the Google Compute Engine
4907 # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4908 # or
4909 # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
4910 # in which the cluster resides.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4911 }</pre>
4912</div>
4913
4914</body></html>