Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / container_v1.projects.locations.clusters.html
blob: 93af173f9d436120f617bf3bc9564fbf6fffb7b2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.locations.html">locations</a> . <a href="container_v1.projects.locations.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="container_v1.projects.locations.clusters.nodePools.html">nodePools()</a></code>
79</p>
80<p class="firstline">Returns the nodePools Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="container_v1.projects.locations.clusters.well_known.html">well_known()</a></code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85<p class="firstline">Returns the well_known Resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code><a href="#completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="firstline">Completes master IP rotation.</p>
93<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]95<p class="firstline">Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]97 <code><a href="#delete">delete(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]98<p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]100 <code><a href="#get">get(name, zone=None, projectId=None, clusterId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<p class="firstline">Gets the details of a specific cluster.</p>
102<p class="toc_element">
103 <code><a href="#getJwks">getJwks(parent, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104<p class="firstline">Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]106 <code><a href="#list">list(parent, projectId=None, zone=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107<p class="firstline">Lists all clusters owned by a project in either the specified zone or all zones.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 <code><a href="#setAddons">setAddons(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110<p class="firstline">Sets the addons for a specific cluster.</p>
111<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 <code><a href="#setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113<p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p>
114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 <code><a href="#setLocations">setLocations(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116<p class="firstline">Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 <code><a href="#setLogging">setLogging(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<p class="firstline">Sets the logging service for a specific cluster.</p>
120<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 <code><a href="#setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122<p class="firstline">Sets the maintenance policy for a cluster.</p>
123<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 <code><a href="#setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125<p class="firstline">Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 <code><a href="#setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128<p class="firstline">Sets the monitoring service for a specific cluster.</p>
129<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 <code><a href="#setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131<p class="firstline">Enables or disables Network Policy for a cluster.</p>
132<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133 <code><a href="#setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134<p class="firstline">Sets labels on a cluster.</p>
135<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]136 <code><a href="#startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137<p class="firstline">Starts master IP rotation.</p>
138<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140<p class="firstline">Updates the settings of a specific cluster.</p>
141<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]142 <code><a href="#updateMaster">updateMaster(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143<p class="firstline">Updates the master for a specific cluster.</p>
144<h3>Method Details</h3>
145<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 <code class="details" id="close">close()</code>
147 <pre>Close httplib2 connections.</pre>
148</div>
149
150<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]151 <code class="details" id="completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 <pre>Completes master IP rotation.
153
154Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 name: string, The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]156 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 The object takes the form of:
158
159{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]160 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
161 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]162 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
163 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 }
165
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]174 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]175 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
176 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
177 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
178 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
179 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
180 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
181 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
182 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
183 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
184 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
185 },
186 ],
187 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
188 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
189 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]190 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]191 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
192 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
193 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
194 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
195 },
196 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]197 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]198 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
199 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]200 &quot;stages&quot;: [ # Substages of an operation or a stage.
201 # Object with schema name: OperationProgress
202 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]203 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
204 { # Progress metric is (string, int|float|string) pair.
205 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
206 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
207 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
208 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
209 },
210 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]211 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]212 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 }</pre>
214</div>
215
216<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]218 <pre>Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project&#x27;s [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project&#x27;s global metadata indicating which CIDR range the cluster is using.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219
220Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 parent: string, The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 The object takes the form of:
224
225{ # CreateClusterRequest creates a cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]226 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
227 &quot;parent&quot;: &quot;A String&quot;, # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]228 &quot;cluster&quot;: { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]229 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]230 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]231 &quot;initialClusterVersion&quot;: &quot;A String&quot;, # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;&quot;,&quot;-&quot;: picks the default Kubernetes version
232 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
233 &quot;currentNodeCount&quot;: 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]234 &quot;status&quot;: &quot;A String&quot;, # [Output only] The current status of this cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]235 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
236 &quot;nodePools&quot;: [ # The node pools associated with this cluster. This field should not be set if &quot;node_config&quot; or &quot;initial_node_count&quot; are specified.
237 { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
238 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
239 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]240 &quot;A String&quot;,
241 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]242 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
243 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
244 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
245 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
246 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]247 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]248 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
249 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
250 &quot;A String&quot;,
251 ],
252 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
253 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
254 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
255 { # AcceleratorConfig represents a Hardware Accelerator request.
256 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
257 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
258 },
259 ],
260 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
261 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
262 },
263 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
264 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
265 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
266 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
267 &quot;A String&quot;,
268 ],
269 },
270 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
274 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
275 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
276 },
277 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
278 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
279 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
280 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
281 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
282 &quot;a_key&quot;: &quot;A String&quot;,
283 },
284 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
285 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
286 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
287 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
288 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
289 },
290 ],
291 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
292 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
293 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
294 },
295 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
296 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
297 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
298 &quot;A String&quot;,
299 ],
300 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
301 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
302 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
303 &quot;A String&quot;,
304 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]305 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]306 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
307 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
308 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
309 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
310 },
311 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
312 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
313 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
314 },
315 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
316 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
317 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
318 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
319 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
320 },
321 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
322 },
323 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
324 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
325 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
326 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
327 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
328 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
329 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
330 },
331 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]332 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]333 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]334 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this cluster, if available.
335 &quot;expireTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
336 &quot;shieldedNodes&quot;: { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
337 &quot;enabled&quot;: True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]338 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]339 &quot;initialNodeCount&quot;: 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;node_config&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
340 &quot;description&quot;: &quot;A String&quot;, # An optional description of this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]341 &quot;legacyAbac&quot;: { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
342 &quot;enabled&quot;: True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
343 },
344 &quot;masterAuth&quot;: { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to &quot;admin&quot;, a random password will be generated, and a client certificate will be issued.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]345 &quot;username&quot;: &quot;A String&quot;, # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
346 &quot;clientKey&quot;: &quot;A String&quot;, # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]347 &quot;password&quot;: &quot;A String&quot;, # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]348 &quot;clientCertificateConfig&quot;: { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
349 &quot;issueClientCertificate&quot;: True or False, # Issue a client certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]350 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]351 &quot;clusterCaCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]352 &quot;clientCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]353 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]354 &quot;enableTpu&quot;: True or False, # Enable the ability to use Cloud TPUs in this cluster.
355 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
356 &quot;networkConfig&quot;: { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
357 &quot;network&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
358 &quot;enableIntraNodeVisibility&quot;: True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
359 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
360 &quot;defaultSnatStatus&quot;: { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.
361 &quot;disabled&quot;: True or False, # Disables cluster default sNAT rules.
362 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]363 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]364 &quot;databaseEncryption&quot;: { # Configuration of etcd encryption. # Configuration of etcd encryption.
365 &quot;keyName&quot;: &quot;A String&quot;, # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
366 &quot;state&quot;: &quot;A String&quot;, # Denotes the state of etcd encryption.
367 },
368 &quot;currentNodeVersion&quot;: &quot;A String&quot;, # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they&#x27;re in the process of being upgraded, this reflects the minimum version of all nodes.
369 &quot;releaseChannel&quot;: { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.
370 &quot;channel&quot;: &quot;A String&quot;, # channel specifies which release channel the cluster is subscribed to.
371 },
372 &quot;resourceLabels&quot;: { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
373 &quot;a_key&quot;: &quot;A String&quot;,
374 },
375 &quot;enableKubernetesAlpha&quot;: True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
376 &quot;networkPolicy&quot;: { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
377 &quot;enabled&quot;: True or False, # Whether network policy is enabled on the cluster.
378 &quot;provider&quot;: &quot;A String&quot;, # The selected network policy provider.
379 },
380 &quot;subnetwork&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
381 &quot;authenticatorGroupsConfig&quot;: { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
382 &quot;securityGroup&quot;: &quot;A String&quot;, # The name of the security group-of-groups to be used. Only relevant if enabled = true.
383 &quot;enabled&quot;: True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
384 },
385 &quot;binaryAuthorization&quot;: { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
386 &quot;enabled&quot;: True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.
387 },
388 &quot;zone&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
389 &quot;defaultMaxPodsConstraint&quot;: { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
390 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
391 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]392 &quot;endpoint&quot;: &quot;A String&quot;, # [Output only] The IP address of this cluster&#x27;s master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]393 &quot;verticalPodAutoscaling&quot;: { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
394 &quot;enabled&quot;: True or False, # Enables vertical pod autoscaling.
395 },
396 &quot;autoscaling&quot;: { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
397 &quot;autoprovisioningLocations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes can be created by NAP.
398 &quot;A String&quot;,
399 ],
400 &quot;autoprovisioningNodePoolDefaults&quot;: { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
401 &quot;oauthScopes&quot;: [ # Scopes that are used by NAP when creating node pools.
402 &quot;A String&quot;,
403 ],
404 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
405 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
406 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
407 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
408 },
409 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
410 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
411 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
412 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
413 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
414 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
415 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
416 },
417 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
418 },
419 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
420 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools
421 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
422 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
423 },
424 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass &quot;automatic&quot; as field value.
425 },
426 &quot;resourceLimits&quot;: [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
427 { # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
428 &quot;maximum&quot;: &quot;A String&quot;, # Maximum amount of the resource in the cluster.
429 &quot;minimum&quot;: &quot;A String&quot;, # Minimum amount of the resource in the cluster.
430 &quot;resourceType&quot;: &quot;A String&quot;, # Resource name &quot;cpu&quot;, &quot;memory&quot; or gpu-specific string.
431 },
432 ],
433 &quot;enableNodeAutoprovisioning&quot;: True or False, # Enables automatic node pool creation and deletion.
434 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]435 &quot;masterAuthorizedNetworksConfig&quot;: { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.
436 &quot;enabled&quot;: True or False, # Whether or not master authorized networks is enabled.
437 &quot;cidrBlocks&quot;: [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
438 { # CidrBlock contains an optional name and one CIDR block.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]439 &quot;cidrBlock&quot;: &quot;A String&quot;, # cidr_block must be specified in CIDR notation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]440 &quot;displayName&quot;: &quot;A String&quot;, # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]441 },
442 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]443 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]444 &quot;conditions&quot;: [ # Which conditions caused the current cluster state.
445 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
446 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
447 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
448 },
449 ],
450 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the set of labels for this cluster.
451 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster&#x27;s nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
452 &quot;A String&quot;,
453 ],
454 &quot;privateClusterConfig&quot;: { # Configuration options for private clusters. # Configuration for private cluster.
455 &quot;publicEndpoint&quot;: &quot;A String&quot;, # Output only. The external IP address of this cluster&#x27;s master endpoint.
456 &quot;privateEndpoint&quot;: &quot;A String&quot;, # Output only. The internal IP address of this cluster&#x27;s master endpoint.
457 &quot;enablePrivateEndpoint&quot;: True or False, # Whether the master&#x27;s internal IP address is used as the cluster endpoint.
458 &quot;masterGlobalAccessConfig&quot;: { # Configuration for controlling master global access settings. # Controls master global access settings.
459 &quot;enabled&quot;: True or False, # Whenever master is accessible globally or not.
460 },
461 &quot;masterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster&#x27;s network.
462 &quot;enablePrivateNodes&quot;: True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
463 &quot;peeringName&quot;: &quot;A String&quot;, # Output only. The peering name in the customer VPC used by this cluster.
464 },
465 &quot;workloadIdentityConfig&quot;: { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
466 &quot;workloadPool&quot;: &quot;A String&quot;, # The workload pool to attach all Kubernetes service accounts to.
467 },
468 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
469 &quot;instanceGroupUrls&quot;: [ # Deprecated. Use node_pools.instance_group_urls.
470 &quot;A String&quot;,
471 ],
472 &quot;name&quot;: &quot;A String&quot;, # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
473 &quot;currentMasterVersion&quot;: &quot;A String&quot;, # [Output only] The current software version of the master endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]474 &quot;addonsConfig&quot;: { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]475 &quot;horizontalPodAutoscaling&quot;: { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
476 &quot;disabled&quot;: True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
477 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]478 &quot;dnsCacheConfig&quot;: { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
479 &quot;enabled&quot;: True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
480 },
481 &quot;kubernetesDashboard&quot;: { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
482 &quot;disabled&quot;: True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
483 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]484 &quot;configConnectorConfig&quot;: { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
485 &quot;enabled&quot;: True or False, # Whether Cloud Connector is enabled for this cluster.
486 },
487 &quot;cloudRunConfig&quot;: { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
488 &quot;disabled&quot;: True or False, # Whether Cloud Run addon is enabled for this cluster.
489 &quot;loadBalancerType&quot;: &quot;A String&quot;, # Which load balancer type is installed for Cloud Run.
490 },
491 &quot;networkPolicyConfig&quot;: { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
492 &quot;disabled&quot;: True or False, # Whether NetworkPolicy is enabled for this cluster.
493 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]494 &quot;httpLoadBalancing&quot;: { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
495 &quot;disabled&quot;: True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]496 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]497 },
498 &quot;resourceUsageExportConfig&quot;: { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]499 &quot;consumptionMeteringConfig&quot;: { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
500 &quot;enabled&quot;: True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
501 },
502 &quot;bigqueryDestination&quot;: { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
503 &quot;datasetId&quot;: &quot;A String&quot;, # The ID of a BigQuery Dataset.
504 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]505 &quot;enableNetworkEgressMetering&quot;: True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]506 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]507 &quot;maintenancePolicy&quot;: { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
508 &quot;window&quot;: { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
509 &quot;maintenanceExclusions&quot;: { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
510 &quot;a_key&quot;: { # Represents an arbitrary window of time.
511 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
512 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
513 },
514 },
515 &quot;dailyMaintenanceWindow&quot;: { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
516 &quot;startTime&quot;: &quot;A String&quot;, # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;HH:MM&quot;, where HH : [00-23] and MM : [00-59] GMT.
517 &quot;duration&quot;: &quot;A String&quot;, # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;PTnHnMnS&quot;.
518 },
519 &quot;recurringWindow&quot;: { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.
520 &quot;recurrence&quot;: &quot;A String&quot;, # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you&#x27;d use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you&#x27;d use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time&#x27;s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
521 &quot;window&quot;: { # Represents an arbitrary window of time. # The window of the first recurrence.
522 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
523 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
524 },
525 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]526 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]527 &quot;resourceVersion&quot;: &quot;A String&quot;, # A hash identifying the version of this policy, so that updates to fields of the policy won&#x27;t accidentally undo intermediate changes (and so that users of the API unaware of some fields won&#x27;t accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]528 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]529 &quot;nodeIpv4CidrSize&quot;: 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]530 &quot;monitoringService&quot;: &quot;A String&quot;, # The monitoring service the cluster should use to write metrics. Currently available options: * &quot;monitoring.googleapis.com/kubernetes&quot; - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]531 &quot;nodeConfig&quot;: { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster&#x27;s nodes. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;initial_node_count&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
532 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
533 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
534 { # AcceleratorConfig represents a Hardware Accelerator request.
535 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
536 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]537 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]538 ],
539 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
540 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
541 },
542 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
543 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
544 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
545 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]546 &quot;A String&quot;,
547 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]548 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]549 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
550 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]551 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]552 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
553 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
554 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
555 },
556 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
557 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
558 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
559 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
560 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
561 &quot;a_key&quot;: &quot;A String&quot;,
562 },
563 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
564 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
565 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
566 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
567 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
568 },
569 ],
570 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
571 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
572 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
573 },
574 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
575 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
576 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
577 &quot;A String&quot;,
578 ],
579 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
580 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
581 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
582 &quot;A String&quot;,
583 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]584 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]585 &quot;loggingService&quot;: &quot;A String&quot;, # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]586 &quot;createTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
587 &quot;ipAllocationPolicy&quot;: { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
588 &quot;clusterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
589 &quot;createSubnetwork&quot;: True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
590 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use services_ipv4_cidr_block.
591 &quot;clusterSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
592 &quot;subnetworkName&quot;: &quot;A String&quot;, # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
593 &quot;servicesSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
594 &quot;useRoutes&quot;: True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
595 &quot;nodeIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use node_ipv4_cidr_block.
596 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
597 &quot;servicesIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
598 &quot;nodeIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
599 &quot;useIpAliases&quot;: True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
600 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use cluster_ipv4_cidr_block.
601 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]602 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]603 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]604 }
605
606 x__xgafv: string, V1 error format.
607 Allowed values
608 1 - v1 error format
609 2 - v2 error format
610
611Returns:
612 An object of the form:
613
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]614 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]615 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
616 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
617 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
618 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
619 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
620 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
621 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
622 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
623 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
624 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
625 },
626 ],
627 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
628 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
629 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]630 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]631 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
632 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
633 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
634 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
635 },
636 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]637 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]638 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
639 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]640 &quot;stages&quot;: [ # Substages of an operation or a stage.
641 # Object with schema name: OperationProgress
642 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]643 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
644 { # Progress metric is (string, int|float|string) pair.
645 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
646 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
647 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
648 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
649 },
650 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]651 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]652 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]653 }</pre>
654</div>
655
656<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]657 <code class="details" id="delete">delete(name, projectId=None, clusterId=None, zone=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]658 <pre>Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren&#x27;t present when the cluster was initially created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]659
660Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]661 name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]662 projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]663 clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]664 zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]665 x__xgafv: string, V1 error format.
666 Allowed values
667 1 - v1 error format
668 2 - v2 error format
669
670Returns:
671 An object of the form:
672
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]673 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]674 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
675 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
676 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
677 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
678 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
679 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
680 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
681 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
682 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
683 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
684 },
685 ],
686 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
687 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
688 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]689 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]690 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
691 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
692 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
693 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
694 },
695 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]696 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]697 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
698 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]699 &quot;stages&quot;: [ # Substages of an operation or a stage.
700 # Object with schema name: OperationProgress
701 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]702 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
703 { # Progress metric is (string, int|float|string) pair.
704 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
705 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
706 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
707 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
708 },
709 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]710 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]711 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]712 }</pre>
713</div>
714
715<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]716 <code class="details" id="get">get(name, zone=None, projectId=None, clusterId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]717 <pre>Gets the details of a specific cluster.
718
719Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]720 name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]721 zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]722 projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]723 clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]724 x__xgafv: string, V1 error format.
725 Allowed values
726 1 - v1 error format
727 2 - v2 error format
728
729Returns:
730 An object of the form:
731
732 { # A Google Kubernetes Engine cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]733 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]734 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]735 &quot;initialClusterVersion&quot;: &quot;A String&quot;, # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;&quot;,&quot;-&quot;: picks the default Kubernetes version
736 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
737 &quot;currentNodeCount&quot;: 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]738 &quot;status&quot;: &quot;A String&quot;, # [Output only] The current status of this cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]739 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
740 &quot;nodePools&quot;: [ # The node pools associated with this cluster. This field should not be set if &quot;node_config&quot; or &quot;initial_node_count&quot; are specified.
741 { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
742 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
743 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]744 &quot;A String&quot;,
745 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]746 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
747 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
748 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
749 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
750 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]751 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]752 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
753 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
754 &quot;A String&quot;,
755 ],
756 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
757 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
758 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
759 { # AcceleratorConfig represents a Hardware Accelerator request.
760 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
761 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
762 },
763 ],
764 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
765 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
766 },
767 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
768 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
769 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
770 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
771 &quot;A String&quot;,
772 ],
773 },
774 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
775 &quot;a_key&quot;: &quot;A String&quot;,
776 },
777 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
778 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
779 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
780 },
781 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
782 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
783 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
784 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
785 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
786 &quot;a_key&quot;: &quot;A String&quot;,
787 },
788 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
789 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
790 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
791 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
792 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
793 },
794 ],
795 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
796 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
797 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
798 },
799 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
800 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
801 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
802 &quot;A String&quot;,
803 ],
804 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
805 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
806 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
807 &quot;A String&quot;,
808 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]809 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]810 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
811 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
812 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
813 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
814 },
815 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
816 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
817 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
818 },
819 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
820 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
821 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
822 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
823 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
824 },
825 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
826 },
827 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
828 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
829 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
830 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
831 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
832 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
833 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
834 },
835 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]836 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]837 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]838 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this cluster, if available.
839 &quot;expireTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
840 &quot;shieldedNodes&quot;: { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
841 &quot;enabled&quot;: True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]842 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]843 &quot;initialNodeCount&quot;: 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;node_config&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
844 &quot;description&quot;: &quot;A String&quot;, # An optional description of this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]845 &quot;legacyAbac&quot;: { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
846 &quot;enabled&quot;: True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
847 },
848 &quot;masterAuth&quot;: { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to &quot;admin&quot;, a random password will be generated, and a client certificate will be issued.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]849 &quot;username&quot;: &quot;A String&quot;, # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
850 &quot;clientKey&quot;: &quot;A String&quot;, # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]851 &quot;password&quot;: &quot;A String&quot;, # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]852 &quot;clientCertificateConfig&quot;: { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
853 &quot;issueClientCertificate&quot;: True or False, # Issue a client certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]854 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]855 &quot;clusterCaCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]856 &quot;clientCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]857 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]858 &quot;enableTpu&quot;: True or False, # Enable the ability to use Cloud TPUs in this cluster.
859 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
860 &quot;networkConfig&quot;: { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
861 &quot;network&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
862 &quot;enableIntraNodeVisibility&quot;: True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
863 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
864 &quot;defaultSnatStatus&quot;: { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.
865 &quot;disabled&quot;: True or False, # Disables cluster default sNAT rules.
866 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]867 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]868 &quot;databaseEncryption&quot;: { # Configuration of etcd encryption. # Configuration of etcd encryption.
869 &quot;keyName&quot;: &quot;A String&quot;, # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
870 &quot;state&quot;: &quot;A String&quot;, # Denotes the state of etcd encryption.
871 },
872 &quot;currentNodeVersion&quot;: &quot;A String&quot;, # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they&#x27;re in the process of being upgraded, this reflects the minimum version of all nodes.
873 &quot;releaseChannel&quot;: { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.
874 &quot;channel&quot;: &quot;A String&quot;, # channel specifies which release channel the cluster is subscribed to.
875 },
876 &quot;resourceLabels&quot;: { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
877 &quot;a_key&quot;: &quot;A String&quot;,
878 },
879 &quot;enableKubernetesAlpha&quot;: True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
880 &quot;networkPolicy&quot;: { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
881 &quot;enabled&quot;: True or False, # Whether network policy is enabled on the cluster.
882 &quot;provider&quot;: &quot;A String&quot;, # The selected network policy provider.
883 },
884 &quot;subnetwork&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
885 &quot;authenticatorGroupsConfig&quot;: { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
886 &quot;securityGroup&quot;: &quot;A String&quot;, # The name of the security group-of-groups to be used. Only relevant if enabled = true.
887 &quot;enabled&quot;: True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
888 },
889 &quot;binaryAuthorization&quot;: { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
890 &quot;enabled&quot;: True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.
891 },
892 &quot;zone&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
893 &quot;defaultMaxPodsConstraint&quot;: { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
894 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
895 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]896 &quot;endpoint&quot;: &quot;A String&quot;, # [Output only] The IP address of this cluster&#x27;s master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]897 &quot;verticalPodAutoscaling&quot;: { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
898 &quot;enabled&quot;: True or False, # Enables vertical pod autoscaling.
899 },
900 &quot;autoscaling&quot;: { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
901 &quot;autoprovisioningLocations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes can be created by NAP.
902 &quot;A String&quot;,
903 ],
904 &quot;autoprovisioningNodePoolDefaults&quot;: { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
905 &quot;oauthScopes&quot;: [ # Scopes that are used by NAP when creating node pools.
906 &quot;A String&quot;,
907 ],
908 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
909 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
910 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
911 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
912 },
913 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
914 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
915 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
916 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
917 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
918 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
919 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
920 },
921 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
922 },
923 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
924 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools
925 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
926 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
927 },
928 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass &quot;automatic&quot; as field value.
929 },
930 &quot;resourceLimits&quot;: [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
931 { # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
932 &quot;maximum&quot;: &quot;A String&quot;, # Maximum amount of the resource in the cluster.
933 &quot;minimum&quot;: &quot;A String&quot;, # Minimum amount of the resource in the cluster.
934 &quot;resourceType&quot;: &quot;A String&quot;, # Resource name &quot;cpu&quot;, &quot;memory&quot; or gpu-specific string.
935 },
936 ],
937 &quot;enableNodeAutoprovisioning&quot;: True or False, # Enables automatic node pool creation and deletion.
938 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]939 &quot;masterAuthorizedNetworksConfig&quot;: { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.
940 &quot;enabled&quot;: True or False, # Whether or not master authorized networks is enabled.
941 &quot;cidrBlocks&quot;: [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
942 { # CidrBlock contains an optional name and one CIDR block.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]943 &quot;cidrBlock&quot;: &quot;A String&quot;, # cidr_block must be specified in CIDR notation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]944 &quot;displayName&quot;: &quot;A String&quot;, # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]945 },
946 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]947 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]948 &quot;conditions&quot;: [ # Which conditions caused the current cluster state.
949 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
950 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
951 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
952 },
953 ],
954 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the set of labels for this cluster.
955 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster&#x27;s nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
956 &quot;A String&quot;,
957 ],
958 &quot;privateClusterConfig&quot;: { # Configuration options for private clusters. # Configuration for private cluster.
959 &quot;publicEndpoint&quot;: &quot;A String&quot;, # Output only. The external IP address of this cluster&#x27;s master endpoint.
960 &quot;privateEndpoint&quot;: &quot;A String&quot;, # Output only. The internal IP address of this cluster&#x27;s master endpoint.
961 &quot;enablePrivateEndpoint&quot;: True or False, # Whether the master&#x27;s internal IP address is used as the cluster endpoint.
962 &quot;masterGlobalAccessConfig&quot;: { # Configuration for controlling master global access settings. # Controls master global access settings.
963 &quot;enabled&quot;: True or False, # Whenever master is accessible globally or not.
964 },
965 &quot;masterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster&#x27;s network.
966 &quot;enablePrivateNodes&quot;: True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
967 &quot;peeringName&quot;: &quot;A String&quot;, # Output only. The peering name in the customer VPC used by this cluster.
968 },
969 &quot;workloadIdentityConfig&quot;: { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
970 &quot;workloadPool&quot;: &quot;A String&quot;, # The workload pool to attach all Kubernetes service accounts to.
971 },
972 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
973 &quot;instanceGroupUrls&quot;: [ # Deprecated. Use node_pools.instance_group_urls.
974 &quot;A String&quot;,
975 ],
976 &quot;name&quot;: &quot;A String&quot;, # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
977 &quot;currentMasterVersion&quot;: &quot;A String&quot;, # [Output only] The current software version of the master endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]978 &quot;addonsConfig&quot;: { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]979 &quot;horizontalPodAutoscaling&quot;: { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
980 &quot;disabled&quot;: True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
981 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]982 &quot;dnsCacheConfig&quot;: { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
983 &quot;enabled&quot;: True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
984 },
985 &quot;kubernetesDashboard&quot;: { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
986 &quot;disabled&quot;: True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
987 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]988 &quot;configConnectorConfig&quot;: { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
989 &quot;enabled&quot;: True or False, # Whether Cloud Connector is enabled for this cluster.
990 },
991 &quot;cloudRunConfig&quot;: { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
992 &quot;disabled&quot;: True or False, # Whether Cloud Run addon is enabled for this cluster.
993 &quot;loadBalancerType&quot;: &quot;A String&quot;, # Which load balancer type is installed for Cloud Run.
994 },
995 &quot;networkPolicyConfig&quot;: { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
996 &quot;disabled&quot;: True or False, # Whether NetworkPolicy is enabled for this cluster.
997 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]998 &quot;httpLoadBalancing&quot;: { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
999 &quot;disabled&quot;: True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1000 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1001 },
1002 &quot;resourceUsageExportConfig&quot;: { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1003 &quot;consumptionMeteringConfig&quot;: { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
1004 &quot;enabled&quot;: True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
1005 },
1006 &quot;bigqueryDestination&quot;: { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
1007 &quot;datasetId&quot;: &quot;A String&quot;, # The ID of a BigQuery Dataset.
1008 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1009 &quot;enableNetworkEgressMetering&quot;: True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1010 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1011 &quot;maintenancePolicy&quot;: { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
1012 &quot;window&quot;: { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
1013 &quot;maintenanceExclusions&quot;: { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
1014 &quot;a_key&quot;: { # Represents an arbitrary window of time.
1015 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
1016 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
1017 },
1018 },
1019 &quot;dailyMaintenanceWindow&quot;: { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
1020 &quot;startTime&quot;: &quot;A String&quot;, # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;HH:MM&quot;, where HH : [00-23] and MM : [00-59] GMT.
1021 &quot;duration&quot;: &quot;A String&quot;, # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;PTnHnMnS&quot;.
1022 },
1023 &quot;recurringWindow&quot;: { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.
1024 &quot;recurrence&quot;: &quot;A String&quot;, # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you&#x27;d use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you&#x27;d use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time&#x27;s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
1025 &quot;window&quot;: { # Represents an arbitrary window of time. # The window of the first recurrence.
1026 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
1027 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
1028 },
1029 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1030 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1031 &quot;resourceVersion&quot;: &quot;A String&quot;, # A hash identifying the version of this policy, so that updates to fields of the policy won&#x27;t accidentally undo intermediate changes (and so that users of the API unaware of some fields won&#x27;t accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1032 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1033 &quot;nodeIpv4CidrSize&quot;: 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1034 &quot;monitoringService&quot;: &quot;A String&quot;, # The monitoring service the cluster should use to write metrics. Currently available options: * &quot;monitoring.googleapis.com/kubernetes&quot; - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1035 &quot;nodeConfig&quot;: { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster&#x27;s nodes. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;initial_node_count&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
1036 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
1037 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
1038 { # AcceleratorConfig represents a Hardware Accelerator request.
1039 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
1040 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1041 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1042 ],
1043 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
1044 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
1045 },
1046 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
1047 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
1048 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
1049 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1050 &quot;A String&quot;,
1051 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1052 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1053 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
1054 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1055 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1056 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
1057 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
1058 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
1059 },
1060 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
1061 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
1062 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
1063 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
1064 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1065 &quot;a_key&quot;: &quot;A String&quot;,
1066 },
1067 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1068 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
1069 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
1070 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
1071 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
1072 },
1073 ],
1074 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1075 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1076 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
1077 },
1078 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
1079 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
1080 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
1081 &quot;A String&quot;,
1082 ],
1083 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
1084 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
1085 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
1086 &quot;A String&quot;,
1087 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1088 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1089 &quot;loggingService&quot;: &quot;A String&quot;, # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1090 &quot;createTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1091 &quot;ipAllocationPolicy&quot;: { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
1092 &quot;clusterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1093 &quot;createSubnetwork&quot;: True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
1094 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use services_ipv4_cidr_block.
1095 &quot;clusterSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
1096 &quot;subnetworkName&quot;: &quot;A String&quot;, # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
1097 &quot;servicesSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
1098 &quot;useRoutes&quot;: True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
1099 &quot;nodeIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use node_ipv4_cidr_block.
1100 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1101 &quot;servicesIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1102 &quot;nodeIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1103 &quot;useIpAliases&quot;: True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
1104 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use cluster_ipv4_cidr_block.
1105 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1106 }</pre>
1107</div>
1108
1109<div class="method">
1110 <code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1111 <pre>Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1112
1113Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1114 parent: string, The cluster (project, location, cluster id) to get keys for. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1115 x__xgafv: string, V1 error format.
1116 Allowed values
1117 1 - v1 error format
1118 2 - v2 error format
1119
1120Returns:
1121 An object of the form:
1122
1123 { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1124 &quot;keys&quot;: [ # The public component of the keys used by the cluster to sign token requests.
1125 { # Jwk is a JSON Web Key as specified in RFC 7517
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1126 &quot;alg&quot;: &quot;A String&quot;, # Algorithm.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1127 &quot;kid&quot;: &quot;A String&quot;, # Key ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1128 &quot;x&quot;: &quot;A String&quot;, # Used for ECDSA keys.
1129 &quot;use&quot;: &quot;A String&quot;, # Permitted uses for the public keys.
1130 &quot;y&quot;: &quot;A String&quot;, # Used for ECDSA keys.
1131 &quot;kty&quot;: &quot;A String&quot;, # Key Type.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1132 &quot;n&quot;: &quot;A String&quot;, # Used for RSA keys.
1133 &quot;crv&quot;: &quot;A String&quot;, # Used for ECDSA keys.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1134 &quot;e&quot;: &quot;A String&quot;, # Used for RSA keys.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1135 },
1136 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1137 &quot;cacheHeader&quot;: { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1138 &quot;age&quot;: &quot;A String&quot;, # 14.6 response cache age, in seconds since the response is generated
1139 &quot;expires&quot;: &quot;A String&quot;, # 14.21 response cache expires, in RFC 1123 date format
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1140 &quot;directive&quot;: &quot;A String&quot;, # 14.9 request and response directives
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1141 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1142 }</pre>
1143</div>
1144
1145<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1146 <code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1147 <pre>Lists all clusters owned by a project in either the specified zone or all zones.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1148
1149Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1150 parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location &quot;-&quot; matches all zones and all regions. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1151 projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1152 zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or &quot;-&quot; for all zones. This field has been deprecated and replaced by the parent field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1153 x__xgafv: string, V1 error format.
1154 Allowed values
1155 1 - v1 error format
1156 2 - v2 error format
1157
1158Returns:
1159 An object of the form:
1160
1161 { # ListClustersResponse is the result of ListClustersRequest.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1162 &quot;missingZones&quot;: [ # If any zones are listed here, the list of clusters returned may be missing those zones.
1163 &quot;A String&quot;,
1164 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1165 &quot;clusters&quot;: [ # A list of clusters in the project in the specified zone, or across all ones.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1166 { # A Google Kubernetes Engine cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1167 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1168 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1169 &quot;initialClusterVersion&quot;: &quot;A String&quot;, # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;&quot;,&quot;-&quot;: picks the default Kubernetes version
1170 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
1171 &quot;currentNodeCount&quot;: 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1172 &quot;status&quot;: &quot;A String&quot;, # [Output only] The current status of this cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1173 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
1174 &quot;nodePools&quot;: [ # The node pools associated with this cluster. This field should not be set if &quot;node_config&quot; or &quot;initial_node_count&quot; are specified.
1175 { # NodePool contains the name and configuration for a cluster&#x27;s node pool. Node pools are a set of nodes (i.e. VM&#x27;s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
1176 &quot;version&quot;: &quot;A String&quot;, # The version of the Kubernetes of this node.
1177 &quot;instanceGroupUrls&quot;: [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1178 &quot;A String&quot;,
1179 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1180 &quot;autoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
1181 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
1182 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
1183 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
1184 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1185 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1186 &quot;status&quot;: &quot;A String&quot;, # [Output only] The status of the nodes in this pool instance.
1187 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
1188 &quot;A String&quot;,
1189 ],
1190 &quot;config&quot;: { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
1191 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
1192 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
1193 { # AcceleratorConfig represents a Hardware Accelerator request.
1194 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
1195 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
1196 },
1197 ],
1198 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
1199 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
1200 },
1201 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
1202 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
1203 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
1204 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
1205 &quot;A String&quot;,
1206 ],
1207 },
1208 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
1209 &quot;a_key&quot;: &quot;A String&quot;,
1210 },
1211 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
1212 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
1213 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
1214 },
1215 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
1216 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
1217 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
1218 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
1219 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1220 &quot;a_key&quot;: &quot;A String&quot;,
1221 },
1222 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1223 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
1224 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
1225 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
1226 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
1227 },
1228 ],
1229 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1230 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1231 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
1232 },
1233 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
1234 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
1235 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
1236 &quot;A String&quot;,
1237 ],
1238 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
1239 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
1240 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
1241 &quot;A String&quot;,
1242 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1243 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1244 &quot;initialNodeCount&quot;: 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
1245 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Upgrade settings control disruption and speed of the upgrade.
1246 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
1247 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
1248 },
1249 &quot;name&quot;: &quot;A String&quot;, # The name of the node pool.
1250 &quot;maxPodsConstraint&quot;: { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
1251 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
1252 },
1253 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
1254 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
1255 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
1256 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
1257 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1258 },
1259 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
1260 },
1261 &quot;podIpv4CidrSize&quot;: 42, # [Output only] The pod CIDR block size per node in this node pool.
1262 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
1263 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this node pool instance, if available.
1264 &quot;conditions&quot;: [ # Which conditions caused the current node pool state.
1265 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1266 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1267 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1268 },
1269 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1270 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1271 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1272 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output only] Additional information about the current status of this cluster, if available.
1273 &quot;expireTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1274 &quot;shieldedNodes&quot;: { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
1275 &quot;enabled&quot;: True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1276 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1277 &quot;initialNodeCount&quot;: 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;node_config&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
1278 &quot;description&quot;: &quot;A String&quot;, # An optional description of this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1279 &quot;legacyAbac&quot;: { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
1280 &quot;enabled&quot;: True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
1281 },
1282 &quot;masterAuth&quot;: { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to &quot;admin&quot;, a random password will be generated, and a client certificate will be issued.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1283 &quot;username&quot;: &quot;A String&quot;, # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
1284 &quot;clientKey&quot;: &quot;A String&quot;, # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1285 &quot;password&quot;: &quot;A String&quot;, # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1286 &quot;clientCertificateConfig&quot;: { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
1287 &quot;issueClientCertificate&quot;: True or False, # Issue a client certificate.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1288 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1289 &quot;clusterCaCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1290 &quot;clientCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1291 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1292 &quot;enableTpu&quot;: True or False, # Enable the ability to use Cloud TPUs in this cluster.
1293 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1294 &quot;networkConfig&quot;: { # NetworkConfig reports the relative names of network &amp; subnetwork. # Configuration for cluster networking.
1295 &quot;network&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
1296 &quot;enableIntraNodeVisibility&quot;: True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
1297 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
1298 &quot;defaultSnatStatus&quot;: { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.
1299 &quot;disabled&quot;: True or False, # Disables cluster default sNAT rules.
1300 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1301 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1302 &quot;databaseEncryption&quot;: { # Configuration of etcd encryption. # Configuration of etcd encryption.
1303 &quot;keyName&quot;: &quot;A String&quot;, # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
1304 &quot;state&quot;: &quot;A String&quot;, # Denotes the state of etcd encryption.
1305 },
1306 &quot;currentNodeVersion&quot;: &quot;A String&quot;, # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they&#x27;re in the process of being upgraded, this reflects the minimum version of all nodes.
1307 &quot;releaseChannel&quot;: { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # Release channel configuration.
1308 &quot;channel&quot;: &quot;A String&quot;, # channel specifies which release channel the cluster is subscribed to.
1309 },
1310 &quot;resourceLabels&quot;: { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
1311 &quot;a_key&quot;: &quot;A String&quot;,
1312 },
1313 &quot;enableKubernetesAlpha&quot;: True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
1314 &quot;networkPolicy&quot;: { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
1315 &quot;enabled&quot;: True or False, # Whether network policy is enabled on the cluster.
1316 &quot;provider&quot;: &quot;A String&quot;, # The selected network policy provider.
1317 },
1318 &quot;subnetwork&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
1319 &quot;authenticatorGroupsConfig&quot;: { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
1320 &quot;securityGroup&quot;: &quot;A String&quot;, # The name of the security group-of-groups to be used. Only relevant if enabled = true.
1321 &quot;enabled&quot;: True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
1322 },
1323 &quot;binaryAuthorization&quot;: { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
1324 &quot;enabled&quot;: True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.
1325 },
1326 &quot;zone&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
1327 &quot;defaultMaxPodsConstraint&quot;: { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
1328 &quot;maxPodsPerNode&quot;: &quot;A String&quot;, # Constraint enforced on the max num of pods per node.
1329 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1330 &quot;endpoint&quot;: &quot;A String&quot;, # [Output only] The IP address of this cluster&#x27;s master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1331 &quot;verticalPodAutoscaling&quot;: { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
1332 &quot;enabled&quot;: True or False, # Enables vertical pod autoscaling.
1333 },
1334 &quot;autoscaling&quot;: { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
1335 &quot;autoprovisioningLocations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes can be created by NAP.
1336 &quot;A String&quot;,
1337 ],
1338 &quot;autoprovisioningNodePoolDefaults&quot;: { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
1339 &quot;oauthScopes&quot;: [ # Scopes that are used by NAP when creating node pools.
1340 &quot;A String&quot;,
1341 ],
1342 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
1343 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
1344 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
1345 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
1346 },
1347 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
1348 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
1349 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
1350 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
1351 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
1352 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
1353 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1354 },
1355 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
1356 },
1357 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
1358 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools
1359 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
1360 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
1361 },
1362 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass &quot;automatic&quot; as field value.
1363 },
1364 &quot;resourceLimits&quot;: [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
1365 { # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
1366 &quot;maximum&quot;: &quot;A String&quot;, # Maximum amount of the resource in the cluster.
1367 &quot;minimum&quot;: &quot;A String&quot;, # Minimum amount of the resource in the cluster.
1368 &quot;resourceType&quot;: &quot;A String&quot;, # Resource name &quot;cpu&quot;, &quot;memory&quot; or gpu-specific string.
1369 },
1370 ],
1371 &quot;enableNodeAutoprovisioning&quot;: True or False, # Enables automatic node pool creation and deletion.
1372 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1373 &quot;masterAuthorizedNetworksConfig&quot;: { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature.
1374 &quot;enabled&quot;: True or False, # Whether or not master authorized networks is enabled.
1375 &quot;cidrBlocks&quot;: [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
1376 { # CidrBlock contains an optional name and one CIDR block.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1377 &quot;cidrBlock&quot;: &quot;A String&quot;, # cidr_block must be specified in CIDR notation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1378 &quot;displayName&quot;: &quot;A String&quot;, # display_name is an optional field for users to identify CIDR blocks.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1379 },
1380 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1381 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1382 &quot;conditions&quot;: [ # Which conditions caused the current cluster state.
1383 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1384 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1385 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1386 },
1387 ],
1388 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the set of labels for this cluster.
1389 &quot;locations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster&#x27;s nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
1390 &quot;A String&quot;,
1391 ],
1392 &quot;privateClusterConfig&quot;: { # Configuration options for private clusters. # Configuration for private cluster.
1393 &quot;publicEndpoint&quot;: &quot;A String&quot;, # Output only. The external IP address of this cluster&#x27;s master endpoint.
1394 &quot;privateEndpoint&quot;: &quot;A String&quot;, # Output only. The internal IP address of this cluster&#x27;s master endpoint.
1395 &quot;enablePrivateEndpoint&quot;: True or False, # Whether the master&#x27;s internal IP address is used as the cluster endpoint.
1396 &quot;masterGlobalAccessConfig&quot;: { # Configuration for controlling master global access settings. # Controls master global access settings.
1397 &quot;enabled&quot;: True or False, # Whenever master is accessible globally or not.
1398 },
1399 &quot;masterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster&#x27;s network.
1400 &quot;enablePrivateNodes&quot;: True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
1401 &quot;peeringName&quot;: &quot;A String&quot;, # Output only. The peering name in the customer VPC used by this cluster.
1402 },
1403 &quot;workloadIdentityConfig&quot;: { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
1404 &quot;workloadPool&quot;: &quot;A String&quot;, # The workload pool to attach all Kubernetes service accounts to.
1405 },
1406 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
1407 &quot;instanceGroupUrls&quot;: [ # Deprecated. Use node_pools.instance_group_urls.
1408 &quot;A String&quot;,
1409 ],
1410 &quot;name&quot;: &quot;A String&quot;, # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
1411 &quot;currentMasterVersion&quot;: &quot;A String&quot;, # [Output only] The current software version of the master endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1412 &quot;addonsConfig&quot;: { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1413 &quot;horizontalPodAutoscaling&quot;: { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
1414 &quot;disabled&quot;: True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
1415 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1416 &quot;dnsCacheConfig&quot;: { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
1417 &quot;enabled&quot;: True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
1418 },
1419 &quot;kubernetesDashboard&quot;: { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
1420 &quot;disabled&quot;: True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
1421 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1422 &quot;configConnectorConfig&quot;: { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
1423 &quot;enabled&quot;: True or False, # Whether Cloud Connector is enabled for this cluster.
1424 },
1425 &quot;cloudRunConfig&quot;: { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
1426 &quot;disabled&quot;: True or False, # Whether Cloud Run addon is enabled for this cluster.
1427 &quot;loadBalancerType&quot;: &quot;A String&quot;, # Which load balancer type is installed for Cloud Run.
1428 },
1429 &quot;networkPolicyConfig&quot;: { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
1430 &quot;disabled&quot;: True or False, # Whether NetworkPolicy is enabled for this cluster.
1431 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1432 &quot;httpLoadBalancing&quot;: { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
1433 &quot;disabled&quot;: True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1434 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1435 },
1436 &quot;resourceUsageExportConfig&quot;: { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1437 &quot;consumptionMeteringConfig&quot;: { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
1438 &quot;enabled&quot;: True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
1439 },
1440 &quot;bigqueryDestination&quot;: { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
1441 &quot;datasetId&quot;: &quot;A String&quot;, # The ID of a BigQuery Dataset.
1442 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1443 &quot;enableNetworkEgressMetering&quot;: True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1444 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1445 &quot;maintenancePolicy&quot;: { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
1446 &quot;window&quot;: { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
1447 &quot;maintenanceExclusions&quot;: { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
1448 &quot;a_key&quot;: { # Represents an arbitrary window of time.
1449 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
1450 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
1451 },
1452 },
1453 &quot;dailyMaintenanceWindow&quot;: { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
1454 &quot;startTime&quot;: &quot;A String&quot;, # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;HH:MM&quot;, where HH : [00-23] and MM : [00-59] GMT.
1455 &quot;duration&quot;: &quot;A String&quot;, # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;PTnHnMnS&quot;.
1456 },
1457 &quot;recurringWindow&quot;: { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.
1458 &quot;recurrence&quot;: &quot;A String&quot;, # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you&#x27;d use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you&#x27;d use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time&#x27;s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
1459 &quot;window&quot;: { # Represents an arbitrary window of time. # The window of the first recurrence.
1460 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
1461 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
1462 },
1463 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1464 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1465 &quot;resourceVersion&quot;: &quot;A String&quot;, # A hash identifying the version of this policy, so that updates to fields of the policy won&#x27;t accidentally undo intermediate changes (and so that users of the API unaware of some fields won&#x27;t accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1466 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1467 &quot;nodeIpv4CidrSize&quot;: 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1468 &quot;monitoringService&quot;: &quot;A String&quot;, # The monitoring service the cluster should use to write metrics. Currently available options: * &quot;monitoring.googleapis.com/kubernetes&quot; - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1469 &quot;nodeConfig&quot;: { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster&#x27;s nodes. For requests, this field should only be used in lieu of a &quot;node_pool&quot; object, since this configuration (along with the &quot;initial_node_count&quot;) will be used to create a &quot;NodePool&quot; object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
1470 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
1471 &quot;accelerators&quot;: [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
1472 { # AcceleratorConfig represents a Hardware Accelerator request.
1473 &quot;acceleratorCount&quot;: &quot;A String&quot;, # The number of the accelerator cards exposed to an instance.
1474 &quot;acceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1475 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1476 ],
1477 &quot;workloadMetadataConfig&quot;: { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
1478 &quot;mode&quot;: &quot;A String&quot;, # Mode is the configuration for how to expose metadata to workloads running on the node pool.
1479 },
1480 &quot;reservationAffinity&quot;: { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
1481 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify &quot;googleapis.com/reservation-name&quot; as the key and specify the name of your reservation as its value.
1482 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Corresponds to the type of reservation consumption.
1483 &quot;values&quot;: [ # Corresponds to the label value(s) of reservation resource(s).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1484 &quot;A String&quot;,
1485 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1486 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1487 &quot;metadata&quot;: { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - &quot;cluster-location&quot; - &quot;cluster-name&quot; - &quot;cluster-uid&quot; - &quot;configure-sh&quot; - &quot;containerd-configure-sh&quot; - &quot;enable-os-login&quot; - &quot;gci-ensure-gke-docker&quot; - &quot;gci-metrics-enabled&quot; - &quot;gci-update-strategy&quot; - &quot;instance-template&quot; - &quot;kube-env&quot; - &quot;startup-script&quot; - &quot;user-data&quot; - &quot;disable-address-manager&quot; - &quot;windows-startup-script-ps1&quot; - &quot;common-psm1&quot; - &quot;k8s-node-setup-psm1&quot; - &quot;install-ssh-psm1&quot; - &quot;user-profile-psm1&quot; The following keys are reserved for Windows nodes: - &quot;serial-port-logging-enable&quot; Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value&#x27;s size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
1488 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1489 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1490 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
1491 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
1492 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
1493 },
1494 &quot;imageType&quot;: &quot;A String&quot;, # The image type to use for this node. Note that for a given image type, the latest version of it will be used.
1495 &quot;nodeGroup&quot;: &quot;A String&quot;, # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
1496 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
1497 &quot;localSsdCount&quot;: 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
1498 &quot;labels&quot;: { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it&#x27;s best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1499 &quot;a_key&quot;: &quot;A String&quot;,
1500 },
1501 &quot;taints&quot;: [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1502 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
1503 &quot;value&quot;: &quot;A String&quot;, # Value for taint.
1504 &quot;key&quot;: &quot;A String&quot;, # Key for taint.
1505 &quot;effect&quot;: &quot;A String&quot;, # Effect for taint.
1506 },
1507 ],
1508 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: &quot;Intel Haswell&quot;` or `minCpuPlatform: &quot;Intel Sandy Bridge&quot;`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1509 &quot;sandboxConfig&quot;: { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
1510 &quot;type&quot;: &quot;A String&quot;, # Type of the sandbox to use for the node.
1511 },
1512 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the &quot;default&quot; service account is used.
1513 &quot;preemptible&quot;: True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
1514 &quot;tags&quot;: [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
1515 &quot;A String&quot;,
1516 ],
1517 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
1518 &quot;machineType&quot;: &quot;A String&quot;, # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
1519 &quot;oauthScopes&quot;: [ # The set of Google API scopes to be made available on all of the node VMs under the &quot;default&quot; service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
1520 &quot;A String&quot;,
1521 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1522 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1523 &quot;loggingService&quot;: &quot;A String&quot;, # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1524 &quot;createTime&quot;: &quot;A String&quot;, # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1525 &quot;ipAllocationPolicy&quot;: { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
1526 &quot;clusterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1527 &quot;createSubnetwork&quot;: True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
1528 &quot;servicesIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use services_ipv4_cidr_block.
1529 &quot;clusterSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
1530 &quot;subnetworkName&quot;: &quot;A String&quot;, # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
1531 &quot;servicesSecondaryRangeName&quot;: &quot;A String&quot;, # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
1532 &quot;useRoutes&quot;: True or False, # Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
1533 &quot;nodeIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use node_ipv4_cidr_block.
1534 &quot;tpuIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1535 &quot;servicesIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1536 &quot;nodeIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
1537 &quot;useIpAliases&quot;: True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
1538 &quot;clusterIpv4Cidr&quot;: &quot;A String&quot;, # This field is deprecated, use cluster_ipv4_cidr_block.
1539 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1540 },
1541 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1542 }</pre>
1543</div>
1544
1545<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1546 <code class="details" id="setAddons">setAddons(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1547 <pre>Sets the addons for a specific cluster.
1548
1549Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1550 name: string, The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1551 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1552 The object takes the form of:
1553
1554{ # SetAddonsConfigRequest sets the addons associated with the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1555 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1556 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
1557 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
1558 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1559 &quot;addonsConfig&quot;: { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1560 &quot;horizontalPodAutoscaling&quot;: { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
1561 &quot;disabled&quot;: True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
1562 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1563 &quot;dnsCacheConfig&quot;: { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
1564 &quot;enabled&quot;: True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
1565 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1566 &quot;kubernetesDashboard&quot;: { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
1567 &quot;disabled&quot;: True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1568 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1569 &quot;configConnectorConfig&quot;: { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
1570 &quot;enabled&quot;: True or False, # Whether Cloud Connector is enabled for this cluster.
1571 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1572 &quot;cloudRunConfig&quot;: { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
1573 &quot;disabled&quot;: True or False, # Whether Cloud Run addon is enabled for this cluster.
1574 &quot;loadBalancerType&quot;: &quot;A String&quot;, # Which load balancer type is installed for Cloud Run.
1575 },
1576 &quot;networkPolicyConfig&quot;: { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
1577 &quot;disabled&quot;: True or False, # Whether NetworkPolicy is enabled for this cluster.
1578 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1579 &quot;httpLoadBalancing&quot;: { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
1580 &quot;disabled&quot;: True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
1581 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1582 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1583 }
1584
1585 x__xgafv: string, V1 error format.
1586 Allowed values
1587 1 - v1 error format
1588 2 - v2 error format
1589
1590Returns:
1591 An object of the form:
1592
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1593 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1594 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1595 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1596 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1597 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1598 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1599 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1600 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1601 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1602 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1603 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1604 },
1605 ],
1606 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1607 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1608 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1609 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1610 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1611 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1612 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1613 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1614 },
1615 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1616 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1617 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1618 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1619 &quot;stages&quot;: [ # Substages of an operation or a stage.
1620 # Object with schema name: OperationProgress
1621 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1622 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1623 { # Progress metric is (string, int|float|string) pair.
1624 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1625 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1626 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1627 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1628 },
1629 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1630 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1631 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1632 }</pre>
1633</div>
1634
1635<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1636 <code class="details" id="setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1637 <pre>Enables or disables the ABAC authorization mechanism on a cluster.
1638
1639Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1640 name: string, The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1641 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1642 The object takes the form of:
1643
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1644{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1645 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1646 &quot;enabled&quot;: True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1647 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
1648 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1649 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1650 }
1651
1652 x__xgafv: string, V1 error format.
1653 Allowed values
1654 1 - v1 error format
1655 2 - v2 error format
1656
1657Returns:
1658 An object of the form:
1659
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1660 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1661 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1662 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1663 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1664 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1665 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1666 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1667 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1668 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1669 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1670 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1671 },
1672 ],
1673 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1674 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1675 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1676 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1677 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1678 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1679 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1680 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1681 },
1682 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1683 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1684 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1685 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1686 &quot;stages&quot;: [ # Substages of an operation or a stage.
1687 # Object with schema name: OperationProgress
1688 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1689 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1690 { # Progress metric is (string, int|float|string) pair.
1691 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1692 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1693 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1694 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1695 },
1696 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1697 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1698 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1699 }</pre>
1700</div>
1701
1702<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1703 <code class="details" id="setLocations">setLocations(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1704 <pre>Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1705
1706Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1707 name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1708 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1709 The object takes the form of:
1710
1711{ # SetLocationsRequest sets the locations of the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1712 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1713 &quot;locations&quot;: [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster&#x27;s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster&#x27;s primary zone.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1714 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1715 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1716 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1717 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
1718 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1719 }
1720
1721 x__xgafv: string, V1 error format.
1722 Allowed values
1723 1 - v1 error format
1724 2 - v2 error format
1725
1726Returns:
1727 An object of the form:
1728
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1729 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1730 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1731 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1732 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1733 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1734 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1735 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1736 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1737 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1738 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1739 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1740 },
1741 ],
1742 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1743 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1744 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1745 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1746 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1747 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1748 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1749 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1750 },
1751 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1752 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1753 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1754 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1755 &quot;stages&quot;: [ # Substages of an operation or a stage.
1756 # Object with schema name: OperationProgress
1757 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1758 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1759 { # Progress metric is (string, int|float|string) pair.
1760 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1761 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1762 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1763 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1764 },
1765 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1766 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1767 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1768 }</pre>
1769</div>
1770
1771<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1772 <code class="details" id="setLogging">setLogging(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1773 <pre>Sets the logging service for a specific cluster.
1774
1775Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1776 name: string, The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1777 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1778 The object takes the form of:
1779
1780{ # SetLoggingServiceRequest sets the logging service of a cluster.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1781 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1782 &quot;loggingService&quot;: &quot;A String&quot;, # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
1783 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1784 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1785 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1786 }
1787
1788 x__xgafv: string, V1 error format.
1789 Allowed values
1790 1 - v1 error format
1791 2 - v2 error format
1792
1793Returns:
1794 An object of the form:
1795
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1796 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1797 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1798 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1799 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1800 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1801 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1802 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1803 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1804 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1805 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1806 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1807 },
1808 ],
1809 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1810 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1811 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1812 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1813 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1814 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1815 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1816 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1817 },
1818 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1819 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1820 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1821 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1822 &quot;stages&quot;: [ # Substages of an operation or a stage.
1823 # Object with schema name: OperationProgress
1824 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1825 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1826 { # Progress metric is (string, int|float|string) pair.
1827 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1828 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1829 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1830 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1831 },
1832 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1833 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1834 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1835 }</pre>
1836</div>
1837
1838<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1839 <code class="details" id="setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1840 <pre>Sets the maintenance policy for a cluster.
1841
1842Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1843 name: string, The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1844 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1845 The object takes the form of:
1846
1847{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1848 &quot;clusterId&quot;: &quot;A String&quot;, # Required. The name of the cluster to update.
1849 &quot;projectId&quot;: &quot;A String&quot;, # Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1850 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1851 &quot;zone&quot;: &quot;A String&quot;, # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1852 &quot;maintenancePolicy&quot;: { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1853 &quot;window&quot;: { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1854 &quot;maintenanceExclusions&quot;: { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1855 &quot;a_key&quot;: { # Represents an arbitrary window of time.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1856 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1857 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1858 },
1859 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1860 &quot;dailyMaintenanceWindow&quot;: { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1861 &quot;startTime&quot;: &quot;A String&quot;, # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;HH:MM&quot;, where HH : [00-23] and MM : [00-59] GMT.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1862 &quot;duration&quot;: &quot;A String&quot;, # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format &quot;PTnHnMnS&quot;.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1863 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1864 &quot;recurringWindow&quot;: { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.
1865 &quot;recurrence&quot;: &quot;A String&quot;, # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you&#x27;d use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you&#x27;d use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time&#x27;s specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
1866 &quot;window&quot;: { # Represents an arbitrary window of time. # The window of the first recurrence.
1867 &quot;startTime&quot;: &quot;A String&quot;, # The time that the window first starts.
1868 &quot;endTime&quot;: &quot;A String&quot;, # The time that the window ends. The end time should take place after the start time.
1869 },
1870 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1871 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1872 &quot;resourceVersion&quot;: &quot;A String&quot;, # A hash identifying the version of this policy, so that updates to fields of the policy won&#x27;t accidentally undo intermediate changes (and so that users of the API unaware of some fields won&#x27;t accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1873 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1874 }
1875
1876 x__xgafv: string, V1 error format.
1877 Allowed values
1878 1 - v1 error format
1879 2 - v2 error format
1880
1881Returns:
1882 An object of the form:
1883
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1884 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1885 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1886 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1887 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1888 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1889 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1890 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1891 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1892 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1893 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1894 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1895 },
1896 ],
1897 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1898 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1899 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1900 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1901 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1902 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1903 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1904 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1905 },
1906 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1907 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1908 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1909 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1910 &quot;stages&quot;: [ # Substages of an operation or a stage.
1911 # Object with schema name: OperationProgress
1912 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1913 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1914 { # Progress metric is (string, int|float|string) pair.
1915 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1916 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1917 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1918 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1919 },
1920 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1921 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1922 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1923 }</pre>
1924</div>
1925
1926<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1927 <code class="details" id="setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1928 <pre>Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1929
1930Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1931 name: string, The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1932 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1933 The object takes the form of:
1934
1935{ # SetMasterAuthRequest updates the admin password of a cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1936 &quot;update&quot;: { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1937 &quot;username&quot;: &quot;A String&quot;, # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
1938 &quot;clientKey&quot;: &quot;A String&quot;, # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1939 &quot;password&quot;: &quot;A String&quot;, # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1940 &quot;clientCertificateConfig&quot;: { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1941 &quot;issueClientCertificate&quot;: True or False, # Issue a client certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1942 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1943 &quot;clusterCaCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1944 &quot;clientCertificate&quot;: &quot;A String&quot;, # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1945 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1946 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1947 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
1948 &quot;action&quot;: &quot;A String&quot;, # Required. The exact form of action to be taken on the master auth.
1949 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
1950 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1951 }
1952
1953 x__xgafv: string, V1 error format.
1954 Allowed values
1955 1 - v1 error format
1956 2 - v2 error format
1957
1958Returns:
1959 An object of the form:
1960
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1961 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1962 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
1963 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1964 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
1965 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
1966 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
1967 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
1968 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
1969 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1970 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1971 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1972 },
1973 ],
1974 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
1975 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
1976 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1977 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1978 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
1979 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
1980 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
1981 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
1982 },
1983 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1984 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1985 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
1986 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1987 &quot;stages&quot;: [ # Substages of an operation or a stage.
1988 # Object with schema name: OperationProgress
1989 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1990 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
1991 { # Progress metric is (string, int|float|string) pair.
1992 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
1993 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
1994 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
1995 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
1996 },
1997 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1998 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1999 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2000 }</pre>
2001</div>
2002
2003<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2004 <code class="details" id="setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2005 <pre>Sets the monitoring service for a specific cluster.
2006
2007Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2008 name: string, The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2009 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2010 The object takes the form of:
2011
2012{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2013 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2014 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2015 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2016 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2017 &quot;monitoringService&quot;: &quot;A String&quot;, # Required. The monitoring service the cluster should use to write metrics. Currently available options: * &quot;monitoring.googleapis.com/kubernetes&quot; - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2018 }
2019
2020 x__xgafv: string, V1 error format.
2021 Allowed values
2022 1 - v1 error format
2023 2 - v2 error format
2024
2025Returns:
2026 An object of the form:
2027
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2028 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2029 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2030 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2031 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2032 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2033 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2034 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2035 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2036 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2037 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2038 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2039 },
2040 ],
2041 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2042 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2043 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2044 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2045 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2046 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2047 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2048 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2049 },
2050 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2051 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2052 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2053 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2054 &quot;stages&quot;: [ # Substages of an operation or a stage.
2055 # Object with schema name: OperationProgress
2056 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2057 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2058 { # Progress metric is (string, int|float|string) pair.
2059 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2060 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2061 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2062 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2063 },
2064 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2065 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2066 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2067 }</pre>
2068</div>
2069
2070<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2071 <code class="details" id="setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2072 <pre>Enables or disables Network Policy for a cluster.
2073
2074Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2075 name: string, The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2076 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2077 The object takes the form of:
2078
2079{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2080 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2081 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2082 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2083 &quot;networkPolicy&quot;: { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.
2084 &quot;enabled&quot;: True or False, # Whether network policy is enabled on the cluster.
2085 &quot;provider&quot;: &quot;A String&quot;, # The selected network policy provider.
2086 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2087 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2088 }
2089
2090 x__xgafv: string, V1 error format.
2091 Allowed values
2092 1 - v1 error format
2093 2 - v2 error format
2094
2095Returns:
2096 An object of the form:
2097
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2098 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2099 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2100 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2101 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2102 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2103 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2104 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2105 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2106 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2107 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2108 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2109 },
2110 ],
2111 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2112 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2113 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2114 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2115 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2116 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2117 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2118 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2119 },
2120 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2121 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2122 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2123 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2124 &quot;stages&quot;: [ # Substages of an operation or a stage.
2125 # Object with schema name: OperationProgress
2126 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2127 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2128 { # Progress metric is (string, int|float|string) pair.
2129 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2130 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2131 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2132 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2133 },
2134 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2135 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2136 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2137 }</pre>
2138</div>
2139
2140<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2141 <code class="details" id="setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2142 <pre>Sets labels on a cluster.
2143
2144Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2145 name: string, The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2146 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2147 The object takes the form of:
2148
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2149{ # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster
2150 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2151 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
2152 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
2153 &quot;labelFingerprint&quot;: &quot;A String&quot;, # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]2154 &quot;resourceLabels&quot;: { # Required. The labels to set for that cluster.
2155 &quot;a_key&quot;: &quot;A String&quot;,
2156 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2157 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2158 }
2159
2160 x__xgafv: string, V1 error format.
2161 Allowed values
2162 1 - v1 error format
2163 2 - v2 error format
2164
2165Returns:
2166 An object of the form:
2167
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2168 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2169 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2170 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2171 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2172 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2173 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2174 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2175 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2176 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2177 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2178 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2179 },
2180 ],
2181 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2182 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2183 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2184 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2185 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2186 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2187 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2188 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2189 },
2190 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2191 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2192 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2193 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2194 &quot;stages&quot;: [ # Substages of an operation or a stage.
2195 # Object with schema name: OperationProgress
2196 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2197 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2198 { # Progress metric is (string, int|float|string) pair.
2199 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2200 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2201 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2202 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2203 },
2204 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2205 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2206 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2207 }</pre>
2208</div>
2209
2210<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2211 <code class="details" id="startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2212 <pre>Starts master IP rotation.
2213
2214Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2215 name: string, The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2216 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2217 The object takes the form of:
2218
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2219{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2220 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2221 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2222 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2223 &quot;rotateCredentials&quot;: True or False, # Whether to rotate credentials during IP rotation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2224 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2225 }
2226
2227 x__xgafv: string, V1 error format.
2228 Allowed values
2229 1 - v1 error format
2230 2 - v2 error format
2231
2232Returns:
2233 An object of the form:
2234
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2235 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2236 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2237 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2238 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2239 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2240 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2241 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2242 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2243 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2244 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2245 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2246 },
2247 ],
2248 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2249 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2250 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2251 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2252 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2253 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2254 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2255 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2256 },
2257 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2258 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2259 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2260 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2261 &quot;stages&quot;: [ # Substages of an operation or a stage.
2262 # Object with schema name: OperationProgress
2263 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2264 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2265 { # Progress metric is (string, int|float|string) pair.
2266 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2267 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2268 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2269 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2270 },
2271 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2272 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2273 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2274 }</pre>
2275</div>
2276
2277<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2278 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2279 <pre>Updates the settings of a specific cluster.
2280
2281Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2282 name: string, The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2284 The object takes the form of:
2285
2286{ # UpdateClusterRequest updates the settings of a cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2287 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2288 &quot;update&quot;: { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2289 &quot;desiredClusterAutoscaling&quot;: { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
2290 &quot;autoprovisioningLocations&quot;: [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool&#x27;s nodes can be created by NAP.
2291 &quot;A String&quot;,
2292 ],
2293 &quot;autoprovisioningNodePoolDefaults&quot;: { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
2294 &quot;oauthScopes&quot;: [ # Scopes that are used by NAP when creating node pools.
2295 &quot;A String&quot;,
2296 ],
2297 &quot;diskType&quot;: &quot;A String&quot;, # Type of the disk attached to each node (e.g. &#x27;pd-standard&#x27; or &#x27;pd-ssd&#x27;) If unspecified, the default disk type is &#x27;pd-standard&#x27;
2298 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Shielded Instance options.
2299 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
2300 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
2301 },
2302 &quot;bootDiskKmsKey&quot;: &quot;A String&quot;, # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
2303 &quot;serviceAccount&quot;: &quot;A String&quot;, # The Google Cloud Platform Service Account to be used by the node VMs.
2304 &quot;management&quot;: { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
2305 &quot;autoRepair&quot;: True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
2306 &quot;upgradeOptions&quot;: { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
2307 &quot;description&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
2308 &quot;autoUpgradeStartTime&quot;: &quot;A String&quot;, # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2309 },
2310 &quot;autoUpgrade&quot;: True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
2311 },
2312 &quot;diskSizeGb&quot;: 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
2313 &quot;upgradeSettings&quot;: { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. # Specifies the upgrade settings for NAP created node pools
2314 &quot;maxSurge&quot;: 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
2315 &quot;maxUnavailable&quot;: 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
2316 },
2317 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass &quot;automatic&quot; as field value.
2318 },
2319 &quot;resourceLimits&quot;: [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
2320 { # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
2321 &quot;maximum&quot;: &quot;A String&quot;, # Maximum amount of the resource in the cluster.
2322 &quot;minimum&quot;: &quot;A String&quot;, # Minimum amount of the resource in the cluster.
2323 &quot;resourceType&quot;: &quot;A String&quot;, # Resource name &quot;cpu&quot;, &quot;memory&quot; or gpu-specific string.
2324 },
2325 ],
2326 &quot;enableNodeAutoprovisioning&quot;: True or False, # Enables automatic node pool creation and deletion.
2327 },
2328 &quot;desiredShieldedNodes&quot;: { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.
2329 &quot;enabled&quot;: True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
2330 },
2331 &quot;desiredWorkloadIdentityConfig&quot;: { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.
2332 &quot;workloadPool&quot;: &quot;A String&quot;, # The workload pool to attach all Kubernetes service accounts to.
2333 },
2334 &quot;desiredBinaryAuthorization&quot;: { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.
2335 &quot;enabled&quot;: True or False, # Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.
2336 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2337 &quot;desiredVerticalPodAutoscaling&quot;: { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
2338 &quot;enabled&quot;: True or False, # Enables vertical pod autoscaling.
2339 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2340 &quot;desiredReleaseChannel&quot;: { # ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. # The desired release channel configuration.
2341 &quot;channel&quot;: &quot;A String&quot;, # channel specifies which release channel the cluster is subscribed to.
2342 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2343 &quot;desiredAddonsConfig&quot;: { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2344 &quot;horizontalPodAutoscaling&quot;: { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
2345 &quot;disabled&quot;: True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
2346 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2347 &quot;dnsCacheConfig&quot;: { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
2348 &quot;enabled&quot;: True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
2349 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2350 &quot;kubernetesDashboard&quot;: { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
2351 &quot;disabled&quot;: True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2352 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2353 &quot;configConnectorConfig&quot;: { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
2354 &quot;enabled&quot;: True or False, # Whether Cloud Connector is enabled for this cluster.
2355 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2356 &quot;cloudRunConfig&quot;: { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
2357 &quot;disabled&quot;: True or False, # Whether Cloud Run addon is enabled for this cluster.
2358 &quot;loadBalancerType&quot;: &quot;A String&quot;, # Which load balancer type is installed for Cloud Run.
2359 },
2360 &quot;networkPolicyConfig&quot;: { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
2361 &quot;disabled&quot;: True or False, # Whether NetworkPolicy is enabled for this cluster.
2362 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2363 &quot;httpLoadBalancing&quot;: { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
2364 &quot;disabled&quot;: True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
2365 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2366 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2367 &quot;desiredIntraNodeVisibilityConfig&quot;: { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility.
2368 &quot;enabled&quot;: True or False, # Enables intra node visibility for this cluster.
2369 },
2370 &quot;desiredImageType&quot;: &quot;A String&quot;, # The desired image type for the node pool. NOTE: Set the &quot;desired_node_pool&quot; field as well.
2371 &quot;desiredDatabaseEncryption&quot;: { # Configuration of etcd encryption. # Configuration of etcd encryption.
2372 &quot;keyName&quot;: &quot;A String&quot;, # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
2373 &quot;state&quot;: &quot;A String&quot;, # Denotes the state of etcd encryption.
2374 },
2375 &quot;desiredDefaultSnatStatus&quot;: { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # The desired status of whether to disable default sNAT for this cluster.
2376 &quot;disabled&quot;: True or False, # Disables cluster default sNAT rules.
2377 },
2378 &quot;desiredNodeVersion&quot;: &quot;A String&quot;, # The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;-&quot;: picks the Kubernetes master version
2379 &quot;desiredNodePoolAutoscaling&quot;: { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
2380 &quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the NodePool. Must be &gt;= min_node_count. There has to enough quota to scale up the cluster.
2381 &quot;autoprovisioned&quot;: True or False, # Can this node pool be deleted automatically.
2382 &quot;enabled&quot;: True or False, # Is autoscaling enabled for this node pool.
2383 &quot;minNodeCount&quot;: 42, # Minimum number of nodes in the NodePool. Must be &gt;= 1 and &lt;= max_node_count.
2384 },
2385 &quot;desiredNodePoolId&quot;: &quot;A String&quot;, # The node pool to be upgraded. This field is mandatory if &quot;desired_node_version&quot;, &quot;desired_image_family&quot; or &quot;desired_node_pool_autoscaling&quot; is specified and there is more than one node pool on the cluster.
2386 &quot;desiredLoggingService&quot;: &quot;A String&quot;, # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
2387 &quot;desiredMasterAuthorizedNetworksConfig&quot;: { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The desired configuration options for master authorized networks feature.
2388 &quot;enabled&quot;: True or False, # Whether or not master authorized networks is enabled.
2389 &quot;cidrBlocks&quot;: [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
2390 { # CidrBlock contains an optional name and one CIDR block.
2391 &quot;cidrBlock&quot;: &quot;A String&quot;, # cidr_block must be specified in CIDR notation.
2392 &quot;displayName&quot;: &quot;A String&quot;, # display_name is an optional field for users to identify CIDR blocks.
2393 },
2394 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2395 },
2396 &quot;desiredPrivateClusterConfig&quot;: { # Configuration options for private clusters. # The desired private cluster configuration.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2397 &quot;publicEndpoint&quot;: &quot;A String&quot;, # Output only. The external IP address of this cluster&#x27;s master endpoint.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2398 &quot;privateEndpoint&quot;: &quot;A String&quot;, # Output only. The internal IP address of this cluster&#x27;s master endpoint.
2399 &quot;enablePrivateEndpoint&quot;: True or False, # Whether the master&#x27;s internal IP address is used as the cluster endpoint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2400 &quot;masterGlobalAccessConfig&quot;: { # Configuration for controlling master global access settings. # Controls master global access settings.
2401 &quot;enabled&quot;: True or False, # Whenever master is accessible globally or not.
2402 },
2403 &quot;masterIpv4CidrBlock&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster&#x27;s network.
2404 &quot;enablePrivateNodes&quot;: True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2405 &quot;peeringName&quot;: &quot;A String&quot;, # Output only. The peering name in the customer VPC used by this cluster.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2406 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2407 &quot;desiredMasterVersion&quot;: &quot;A String&quot;, # The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;-&quot;: picks the default Kubernetes version
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2408 &quot;desiredResourceUsageExportConfig&quot;: { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2409 &quot;consumptionMeteringConfig&quot;: { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
2410 &quot;enabled&quot;: True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
2411 },
2412 &quot;bigqueryDestination&quot;: { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
2413 &quot;datasetId&quot;: &quot;A String&quot;, # The ID of a BigQuery Dataset.
2414 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2415 &quot;enableNetworkEgressMetering&quot;: True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2416 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2417 &quot;desiredLocations&quot;: [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster&#x27;s nodes should be located. This list must always include the cluster&#x27;s primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
2418 &quot;A String&quot;,
2419 ],
2420 &quot;desiredMonitoringService&quot;: &quot;A String&quot;, # The monitoring service the cluster should use to write metrics. Currently available options: * &quot;monitoring.googleapis.com/kubernetes&quot; - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2421 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2422 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2423 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2424 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2425 }
2426
2427 x__xgafv: string, V1 error format.
2428 Allowed values
2429 1 - v1 error format
2430 2 - v2 error format
2431
2432Returns:
2433 An object of the form:
2434
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2435 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2436 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2437 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2438 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2439 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2440 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2441 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2442 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2443 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2444 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2445 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2446 },
2447 ],
2448 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2449 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2450 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2451 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2452 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2453 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2454 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2455 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2456 },
2457 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2458 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2459 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2460 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2461 &quot;stages&quot;: [ # Substages of an operation or a stage.
2462 # Object with schema name: OperationProgress
2463 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2464 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2465 { # Progress metric is (string, int|float|string) pair.
2466 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2467 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2468 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2469 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2470 },
2471 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2472 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2473 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2474 }</pre>
2475</div>
2476
2477<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2478 <code class="details" id="updateMaster">updateMaster(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2479 <pre>Updates the master for a specific cluster.
2480
2481Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2482 name: string, The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2483 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2484 The object takes the form of:
2485
2486{ # UpdateMasterRequest updates the master of the cluster.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2487 &quot;zone&quot;: &quot;A String&quot;, # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2488 &quot;masterVersion&quot;: &quot;A String&quot;, # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - &quot;latest&quot;: picks the highest valid Kubernetes version - &quot;1.X&quot;: picks the highest valid patch+gke.N patch in the 1.X version - &quot;1.X.Y&quot;: picks the highest valid gke.N patch in the 1.X.Y version - &quot;1.X.Y-gke.N&quot;: picks an explicit Kubernetes version - &quot;-&quot;: picks the default Kubernetes version
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2489 &quot;clusterId&quot;: &quot;A String&quot;, # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2490 &quot;projectId&quot;: &quot;A String&quot;, # Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2491 &quot;name&quot;: &quot;A String&quot;, # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2492 }
2493
2494 x__xgafv: string, V1 error format.
2495 Allowed values
2496 1 - v1 error format
2497 2 - v2 error format
2498
2499Returns:
2500 An object of the form:
2501
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2502 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2503 &quot;status&quot;: &quot;A String&quot;, # The current status of the operation.
2504 &quot;startTime&quot;: &quot;A String&quot;, # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
2505 &quot;targetLink&quot;: &quot;A String&quot;, # Server-defined URL for the target of the operation.
2506 &quot;location&quot;: &quot;A String&quot;, # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
2507 &quot;detail&quot;: &quot;A String&quot;, # Detailed operation progress, if available.
2508 &quot;operationType&quot;: &quot;A String&quot;, # The operation type.
2509 &quot;nodepoolConditions&quot;: [ # Which conditions caused the current node pool state.
2510 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2511 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2512 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2513 },
2514 ],
2515 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. If an error has occurred, a textual description of the error.
2516 &quot;name&quot;: &quot;A String&quot;, # The server-assigned ID for the operation.
2517 &quot;endTime&quot;: &quot;A String&quot;, # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2518 &quot;zone&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2519 &quot;clusterConditions&quot;: [ # Which conditions caused the current cluster state.
2520 { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
2521 &quot;message&quot;: &quot;A String&quot;, # Human-friendly representation of the condition
2522 &quot;code&quot;: &quot;A String&quot;, # Machine-friendly representation of the condition
2523 },
2524 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2525 &quot;progress&quot;: { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2526 &quot;name&quot;: &quot;A String&quot;, # A non-parameterized string describing an operation stage. Unset for single-stage operations.
2527 &quot;status&quot;: &quot;A String&quot;, # Status of an operation stage. Unset for single-stage operations.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2528 &quot;stages&quot;: [ # Substages of an operation or a stage.
2529 # Object with schema name: OperationProgress
2530 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2531 &quot;metrics&quot;: [ # Progress metric bundle, for example: metrics: [{name: &quot;nodes done&quot;, int_value: 15}, {name: &quot;nodes total&quot;, int_value: 32}] or metrics: [{name: &quot;progress&quot;, double_value: 0.56}, {name: &quot;progress scale&quot;, double_value: 1.0}]
2532 { # Progress metric is (string, int|float|string) pair.
2533 &quot;intValue&quot;: &quot;A String&quot;, # For metrics with integer value.
2534 &quot;doubleValue&quot;: 3.14, # For metrics with floating point value.
2535 &quot;stringValue&quot;: &quot;A String&quot;, # For metrics with custom values (ratios, visual progress, etc.).
2536 &quot;name&quot;: &quot;A String&quot;, # Required. Metric name, e.g., &quot;nodes total&quot;, &quot;percent done&quot;.
2537 },
2538 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2539 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2540 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2541 }</pre>
2542</div>
2543
2544</body></html>