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