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