| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | </p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 85 | <p class="firstline">Returns the well_known Resource.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | |
| 87 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <code><a href="#completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="firstline">Completes master IP rotation.</p> |
| 90 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 91 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="firstline">Creates a cluster, consisting of the specified number and type of Google</p> |
| 93 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | <code><a href="#delete">delete(name, projectId=None, zone=None, clusterId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker</p> |
| 96 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 97 | <code><a href="#get">get(name, clusterId=None, projectId=None, zone=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="firstline">Gets the details of a specific cluster.</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#getJwks">getJwks(parent, x__xgafv=None)</a></code></p> |
| 101 | <p class="firstline">Gets the public component of the cluster signing keys in</p> |
| 102 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | <code><a href="#list">list(parent, projectId=None, zone=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | <p class="firstline">Lists all clusters owned by a project in either the specified zone or all</p> |
| 105 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 106 | <code><a href="#setAddons">setAddons(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | <p class="firstline">Sets the addons for a specific cluster.</p> |
| 108 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 109 | <code><a href="#setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | <p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p> |
| 111 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | <code><a href="#setLocations">setLocations(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <p class="firstline">Sets the locations for a specific cluster.</p> |
| 114 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | <code><a href="#setLogging">setLogging(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | <p class="firstline">Sets the logging service for a specific cluster.</p> |
| 117 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | <code><a href="#setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | <p class="firstline">Sets the maintenance policy for a cluster.</p> |
| 120 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | <code><a href="#setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | <p class="firstline">Sets master auth materials. Currently supports changing the admin password</p> |
| 123 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 124 | <code><a href="#setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | <p class="firstline">Sets the monitoring service for a specific cluster.</p> |
| 126 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | <code><a href="#setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 128 | <p class="firstline">Enables or disables Network Policy for a cluster.</p> |
| 129 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 130 | <code><a href="#setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | <p class="firstline">Sets labels on a cluster.</p> |
| 132 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | <code><a href="#startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | <p class="firstline">Starts master IP rotation.</p> |
| 135 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 136 | <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 137 | <p class="firstline">Updates the settings of a specific cluster.</p> |
| 138 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 139 | <code><a href="#updateMaster">updateMaster(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 140 | <p class="firstline">Updates the master for a specific cluster.</p> |
| 141 | <h3>Method Details</h3> |
| 142 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 143 | <code class="details" id="completeIpRotation">completeIpRotation(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 144 | <pre>Completes master IP rotation. |
| 145 | |
| 146 | Args: |
| 147 | name: string, The name (project, location, cluster id) of the cluster to complete IP |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 149 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 150 | The object takes the form of: |
| 151 | |
| 152 | { # CompleteIPRotationRequest moves the cluster master back into single-IP mode. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 153 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 154 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "name": "A String", # The name (project, location, cluster id) of the cluster to complete IP |
| 156 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| 157 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 158 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 159 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 161 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 162 | # cluster resides. This field has been deprecated and replaced by the name |
| 163 | # field. |
| Bu Sun Kim | 715bd7f | 2019-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 | |
| 171 | Returns: |
| 172 | An object of the form: |
| 173 | |
| 174 | { # This operation resource represents operations that may have happened or are |
| 175 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 176 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 177 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 178 | # (e.g., ERROR or DEGRADED). |
| 179 | "code": "A String", # Machine-friendly representation of the condition |
| 180 | "message": "A String", # Human-friendly representation of the condition |
| 181 | }, |
| 182 | ], |
| 183 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 184 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 185 | # Unset for single-stage operations. |
| 186 | "stages": [ # Substages of an operation or a stage. |
| 187 | # Object with schema name: OperationProgress |
| 188 | ], |
| 189 | "metrics": [ # Progress metric bundle, for example: |
| 190 | # metrics: [{name: "nodes done", int_value: 15}, |
| 191 | # {name: "nodes total", int_value: 32}] |
| 192 | # or |
| 193 | # metrics: [{name: "progress", double_value: 0.56}, |
| 194 | # {name: "progress scale", double_value: 1.0}] |
| 195 | { # Progress metric is (string, int|float|string) pair. |
| 196 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 197 | "doubleValue": 3.14, # For metrics with floating point value. |
| 198 | "intValue": "A String", # For metrics with integer value. |
| 199 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 200 | }, |
| 201 | ], |
| 202 | "status": "A String", # Status of an operation stage. |
| 203 | # Unset for single-stage operations. |
| 204 | }, |
| 205 | "zone": "A String", # The name of the Google Compute Engine |
| 206 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 207 | # operation is taking place. This field is deprecated, use location instead. |
| 208 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 209 | "selfLink": "A String", # Server-defined URL for the resource. |
| 210 | "detail": "A String", # Detailed operation progress, if available. |
| 211 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 212 | "operationType": "A String", # The operation type. |
| 213 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 214 | "name": "A String", # The server-assigned ID for the operation. |
| 215 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 216 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 217 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 219 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 220 | }, |
| 221 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 223 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 224 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 225 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 226 | # or |
| 227 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 228 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 229 | "startTime": "A String", # [Output only] The time the operation started, in |
| 230 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 231 | }</pre> |
| 232 | </div> |
| 233 | |
| 234 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 235 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 236 | <pre>Creates a cluster, consisting of the specified number and type of Google |
| 237 | Compute Engine instances. |
| 238 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 239 | By default, the cluster is created in the project's |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 240 | [default |
| 241 | network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 242 | |
| 243 | One firewall is added for the cluster. After cluster creation, |
| 244 | the Kubelet creates routes for each node to allow the containers |
| 245 | on that node to communicate with all other instances in the |
| 246 | cluster. |
| 247 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 248 | Finally, an entry is added to the project's global metadata indicating |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 249 | which CIDR range the cluster is using. |
| 250 | |
| 251 | Args: |
| 252 | parent: string, The parent (project and location) where the cluster will be created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | Specified in the format `projects/*/locations/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 254 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 255 | The object takes the form of: |
| 256 | |
| 257 | { # CreateClusterRequest creates a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 258 | "parent": "A String", # The parent (project and location) where the cluster will be created. |
| 259 | # Specified in the format `projects/*/locations/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 261 | # resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 262 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 263 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 264 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 265 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 266 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 267 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 268 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 269 | # required by Cluster Autoscaler to automatically adjust |
| 270 | # the size of the cluster and create/delete |
| 271 | # node pools based on the current needs. |
| 272 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 273 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 274 | # NodePool's nodes can be created by NAP. |
| 275 | "A String", |
| 276 | ], |
| 277 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 278 | # amount of resources in the cluster. |
| 279 | { # Contains information about amount of some resource in the cluster. |
| 280 | # For memory, value should be in GB. |
| 281 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 282 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 283 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 284 | }, |
| 285 | ], |
| 286 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 287 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 288 | # created by NAP. |
| 289 | # by NAP. |
| 290 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 291 | # node pool. |
| 292 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 293 | # the Auto Upgrades will proceed. |
| 294 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 295 | # with the approximate start time for the upgrades, in |
| 296 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 297 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 298 | # with the description of the upgrade. |
| 299 | }, |
| 300 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 301 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 302 | # they fail health checks too many times, an automatic repair action will be |
| 303 | # triggered. |
| 304 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 305 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 306 | # up to date with the latest release version of Kubernetes. |
| 307 | }, |
| 308 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 309 | # specified, service_account should be empty. |
| 310 | "A String", |
| 311 | ], |
| 312 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 313 | # disruption caused by an upgrade. |
| 314 | # |
| 315 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 316 | # unavailable. |
| 317 | # |
| 318 | # maxSurge controls the number of additional nodes that can be added to the |
| 319 | # node pool temporarily for the time of the upgrade to increase the number of |
| 320 | # available nodes. |
| 321 | # |
| 322 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 323 | # nodes are being upgraded at the same time). |
| 324 | # |
| 325 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 326 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 327 | # this holds true. (Disruption stays within the limits of |
| 328 | # PodDisruptionBudget, if it is configured.) |
| 329 | # |
| 330 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 331 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 332 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 333 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 334 | # there are always at least 4 nodes available. |
| 335 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 336 | # the upgrade process. A node is considered available if its status is |
| 337 | # Ready. |
| 338 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 339 | # of the node pool during the upgrade process. |
| 340 | }, |
| 341 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 342 | # service_account is specified, scopes should be empty. |
| 343 | }, |
| 344 | }, |
| 345 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 346 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 347 | # is sufficient for this number of instances. You must also have available |
| 348 | # firewall and routes quota. |
| 349 | # For requests, this field should only be used in lieu of a |
| 350 | # "node_pool" object, since this configuration (along with the |
| 351 | # "node_config") will be used to create a "NodePool" object with an |
| 352 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 353 | # |
| 354 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 355 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 356 | "A String", |
| 357 | ], |
| 358 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 359 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 360 | # range will be used for assigning internal IP addresses to the master or |
| 361 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 362 | # any other ranges in use within the cluster's network. |
| 363 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 364 | # given only RFC 1918 private addresses and communicate with the master via |
| 365 | # private networking. |
| 366 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 367 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 368 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 369 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 370 | }, |
| 371 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 372 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 373 | }, |
| 374 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 375 | # required by Vertical Pod Autoscaler to automatically adjust |
| 376 | # the resources of pods controlled by it. |
| 377 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 378 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 380 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 381 | # if cluster created with IP Alias support. |
| 382 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 383 | }, |
| 384 | "network": "A String", # The name of the Google Compute Engine |
| 385 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 386 | # to which the cluster is connected. If left unspecified, the `default` |
| 387 | # network will be used. |
| 388 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 389 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 391 | # range. This field will only be set when cluster is in route-based network |
| 392 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 393 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 394 | # master authorized networks will disallow all external traffic to access |
| 395 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 396 | # Google Compute Engine Public IPs and Google Prod IPs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 397 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 398 | # Kubernetes master through HTTPS. |
| 399 | { # CidrBlock contains an optional name and one CIDR block. |
| 400 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 401 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 402 | }, |
| 403 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 404 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 405 | }, |
| 406 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 407 | # cluster, if available. |
| 408 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 409 | # If unspecified, the defaults are used: |
| 410 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 411 | # be set to "admin", a random password will be generated, and a client |
| 412 | # certificate will be issued. |
| 413 | # Authentication can be done using HTTP basic auth or using client |
| 414 | # certificates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 415 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 416 | # Because the master endpoint is open to the Internet, you should create a |
| 417 | # strong password. If a password is provided for cluster creation, username |
| 418 | # must be non-empty. |
| 419 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 420 | # clusters before v1.12, if no configuration is specified, a client |
| 421 | # certificate is issued. |
| 422 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 423 | }, |
| 424 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 425 | # to the cluster endpoint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 426 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 427 | # trust for the cluster. |
| 428 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 429 | # authenticate to the cluster endpoint. |
| 430 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 431 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 432 | # leaving username unspecified (or setting it to the empty string). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | }, |
| 434 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 435 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 436 | # during authentication using a group of security groups. |
| 437 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 438 | # if enabled = true. |
| 439 | }, |
| 440 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 441 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 442 | # cluster, enabling additional functionality. |
| 443 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 444 | # is enabled or not on the Master, it does not track whether network policy |
| 445 | # is enabled for the nodes. |
| 446 | # is enabled or not on the Master, it does not track whether network policy |
| 447 | # is enabled for the nodes. |
| 448 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 449 | }, |
| 450 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 451 | # managed Knative service. |
| 452 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 453 | }, |
| 454 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 455 | # increases or decreases the number of replica pods a replication controller |
| 456 | # has based on the resource usage of the existing pods. |
| 457 | # increases or decreases the number of replica pods a replication controller |
| 458 | # has based on the resource usage of the existing pods. |
| 459 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 460 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 461 | # Monitoring. |
| 462 | }, |
| 463 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 464 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 465 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 466 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 467 | # When enabled, it runs a small pod in the cluster that manages the load |
| 468 | # balancers. |
| 469 | }, |
| 470 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 471 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 472 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 473 | # workloads and applications. For more information, see: |
| 474 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 475 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 476 | }, |
| 477 | }, |
| 478 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 479 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 480 | # instead. The current version of the node software components. If they are |
| 481 | # currently at multiple versions because they're in the process of being |
| 482 | # upgraded, this reflects the minimum version of all nodes. |
| 483 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 484 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 485 | # the cluster is connected. |
| 486 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 487 | # Google Compute Engine resources. |
| 488 | "a_key": "A String", |
| 489 | }, |
| 490 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 491 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 492 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 493 | # occur in these windows. |
| 494 | "a_key": { # Represents an arbitrary window of time. |
| 495 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 496 | # start time. |
| 497 | "startTime": "A String", # The time that the window first starts. |
| 498 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 499 | }, |
| 500 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 501 | # maintenance to occur. The time windows may be overlapping. If no |
| 502 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 503 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 504 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 505 | # start time. |
| 506 | "startTime": "A String", # The time that the window first starts. |
| 507 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 508 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 509 | # this window reccurs. They go on for the span of time between the start and |
| 510 | # end time. |
| 511 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 512 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 513 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 514 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 515 | # <code>FREQ=DAILY</code> |
| 516 | # For the first weekend of every month: |
| 517 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 518 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 519 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 520 | # <code> |
| 521 | # start time = 2019-01-01T09:00:00-0400 |
| 522 | # end time = 2019-01-01T17:00:00-0400 |
| 523 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 524 | # </code> |
| 525 | # Windows can span multiple days. Eg, to make the window encompass every |
| 526 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 527 | # <code> |
| 528 | # start time = 2019-01-05T00:00:00Z |
| 529 | # end time = 2019-01-07T23:59:00Z |
| 530 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 531 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 532 | # Note the start and end time's specific dates are largely arbitrary except |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 533 | # to specify duration of the window and when it first starts. |
| 534 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 535 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 536 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 537 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 538 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 539 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 540 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 541 | # smallest possible in the given scenario. |
| 542 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 543 | # format "PTnHnMnS". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 544 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 545 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 546 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 547 | # the policy won't accidentally undo intermediate changes (and so that users |
| 548 | # of the API unaware of some fields won't accidentally remove other fields). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 549 | # Make a <code>get()</code> request to the cluster to get the current |
| 550 | # resource version and include it with requests to set the policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 551 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 552 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 553 | # found in validMasterVersions returned by getServerConfig. The version can |
| 554 | # be upgraded over time; such upgrades are reflected in |
| 555 | # currentMasterVersion and currentNodeVersion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 556 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 557 | # Users may specify either explicit versions offered by |
| 558 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 559 | # |
| 560 | # - "latest": picks the highest valid Kubernetes version |
| 561 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 562 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 563 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 564 | # - "","-": picks the default Kubernetes version |
| 565 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 567 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 568 | # block. The secondary range will be used for pod IP |
| 569 | # addresses. This must be an existing secondary range associated |
| 570 | # with the cluster subnetwork. |
| 571 | # |
| 572 | # This field is only applicable with use_ip_aliases is true and |
| 573 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 575 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 576 | # |
| 577 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | # |
| 579 | # Set to blank to have a range chosen with the default size. |
| 580 | # |
| 581 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 582 | # netmask. |
| 583 | # |
| 584 | # Set to a |
| 585 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 586 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 587 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 588 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 589 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 590 | # |
| 591 | # This is applicable only if `create_subnetwork` is true. |
| 592 | # |
| 593 | # Set to blank to have a range chosen with the default size. |
| 594 | # |
| 595 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 596 | # netmask. |
| 597 | # |
| 598 | # Set to a |
| 599 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 600 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 601 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 602 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 604 | # range will be automatically chosen with the default size. |
| 605 | # |
| 606 | # This field is only applicable when `use_ip_aliases` is true. |
| 607 | # |
| 608 | # If unspecified, the range will use the default size. |
| 609 | # |
| 610 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 611 | # netmask. |
| 612 | # |
| 613 | # Set to a |
| 614 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 615 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 616 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 617 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 618 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 619 | "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 620 | # CIDR block. The secondary range will be used for service |
| 621 | # ClusterIPs. This must be an existing secondary range associated |
| 622 | # with the cluster subnetwork. |
| 623 | # |
| 624 | # This field is only applicable with use_ip_aliases is true and |
| 625 | # create_subnetwork is false. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 626 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 627 | # |
| 628 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 629 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 630 | # this field is empty, then an automatic name will be chosen for the new |
| 631 | # subnetwork. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 632 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 633 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 634 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 635 | # will be automatically chosen with the default size. |
| 636 | # |
| 637 | # This field is only applicable when `use_ip_aliases` is true. |
| 638 | # |
| 639 | # Set to blank to have a range chosen with the default size. |
| 640 | # |
| 641 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 642 | # netmask. |
| 643 | # |
| 644 | # Set to a |
| 645 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 646 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 647 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 648 | # to use. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 649 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 650 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 651 | # mode. |
| 652 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 653 | # identities in the system, including service accounts, nodes, and |
| 654 | # controllers, will have statically granted permissions beyond those |
| 655 | # provided by the RBAC configuration or IAM. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 656 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 657 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 658 | # disabled when this config is unspecified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 659 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 660 | # daemonset will be created in the cluster to meter network egress traffic. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 661 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 662 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 663 | # second BigQuery table will be created to hold resource consumption |
| 664 | # records. |
| 665 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 666 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 667 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 668 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 669 | }, |
| 670 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 671 | "locations": [ # The list of Google Compute Engine |
| 672 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 673 | # cluster's nodes should be located. |
| 674 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 675 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 676 | "nodePools": [ # The node pools associated with this cluster. |
| 677 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 678 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 679 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 680 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 681 | # specification, under the control of the cluster master. They may have a set |
| 682 | # of Kubernetes labels applied to them, which may be used to reference them |
| 683 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 684 | # the workload. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 685 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 686 | # node pool instance, if available. |
| 687 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 688 | # only if a valid configuration is present. |
| 689 | # adjust the size of the node pool to the current cluster usage. |
| 690 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 691 | # has to enough quota to scale up the cluster. |
| 692 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 693 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 694 | # max_node_count. |
| 695 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 696 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 697 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 698 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 699 | # is sufficient for this number of instances. You must also have available |
| 700 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 701 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 702 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 703 | # disruption caused by an upgrade. |
| 704 | # |
| 705 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 706 | # unavailable. |
| 707 | # |
| 708 | # maxSurge controls the number of additional nodes that can be added to the |
| 709 | # node pool temporarily for the time of the upgrade to increase the number of |
| 710 | # available nodes. |
| 711 | # |
| 712 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 713 | # nodes are being upgraded at the same time). |
| 714 | # |
| 715 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 716 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 717 | # this holds true. (Disruption stays within the limits of |
| 718 | # PodDisruptionBudget, if it is configured.) |
| 719 | # |
| 720 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 721 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 722 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 723 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 724 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 725 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 726 | # the upgrade process. A node is considered available if its status is |
| 727 | # Ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 728 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 729 | # of the node pool during the upgrade process. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 730 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 731 | "locations": [ # The list of Google Compute Engine |
| 732 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 733 | # NodePool's nodes should be located. |
| 734 | "A String", |
| 735 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 736 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 737 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 738 | # associated with this node pool. |
| 739 | "A String", |
| 740 | ], |
| 741 | "version": "A String", # The version of the Kubernetes of this node. |
| 742 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 743 | "conditions": [ # Which conditions caused the current node pool state. |
| 744 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 745 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 746 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 747 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 748 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | ], |
| 750 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 751 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 752 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 753 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 754 | # |
| 755 | # The following scopes are recommended, but not required, and by default are |
| 756 | # not included: |
| 757 | # |
| 758 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 759 | # persistent storage on your nodes. |
| 760 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 761 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 762 | # (the [Google Container |
| 763 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 764 | # |
| 765 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 766 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 767 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 768 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 769 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 770 | # |
| 771 | # For more information, including usage and the valid values, see: |
| 772 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 773 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 774 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 775 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 776 | # See |
| 777 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 778 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 779 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 780 | "value": "A String", # Value for taint. |
| 781 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 782 | }, |
| 783 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 784 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 785 | # These will added in addition to any default label(s) that |
| 786 | # Kubernetes may apply to the node. |
| 787 | # In case of conflict in label keys, the applied set may differ depending on |
| 788 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 789 | # and conflicts should be avoided. |
| 790 | # For more information, including usage and the valid values, see: |
| 791 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 792 | "a_key": "A String", |
| 793 | }, |
| 794 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 795 | # The smallest allowed disk size is 10GB. |
| 796 | # |
| 797 | # If unspecified, the default disk size is 100GB. |
| 798 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 799 | # workloads on the node pool. |
| 800 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 801 | # on the node pool. |
| 802 | }, |
| 803 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 804 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 805 | # support for GPUs. |
| 806 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 807 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 808 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 809 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 810 | }, |
| 811 | ], |
| 812 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 813 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 814 | # `n1-standard-1`). |
| 815 | # |
| 816 | # If unspecified, the default machine type is |
| 817 | # `n1-standard-1`. |
| 818 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 819 | # |
| 820 | # If unspecified, the default disk type is 'pd-standard' |
| 821 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 822 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 823 | # |
| 824 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 825 | # The attestation is performed against the integrity policy baseline. This |
| 826 | # baseline is initially derived from the implicitly trusted boot image when |
| 827 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 828 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 829 | # |
| 830 | # Secure Boot helps ensure that the system only runs authentic software by |
| 831 | # verifying the digital signature of all boot components, and halting the |
| 832 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 833 | }, |
| 834 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 835 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 836 | # friendly names of CPU platforms, such as |
| 837 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 838 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 839 | # information, read [how to specify min CPU |
| 840 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 841 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 842 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 843 | # information about preemptible VM instances. |
| 844 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 845 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 846 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 847 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 848 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 849 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 850 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 851 | "type": "A String", # Type of the sandbox to use for the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 852 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 853 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 854 | # |
| 855 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 856 | # in length. These are reflected as part of a URL in the metadata server. |
| 857 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 858 | # metadata keys for the project or be one of the reserved keys: |
| 859 | # "cluster-location" |
| 860 | # "cluster-name" |
| 861 | # "cluster-uid" |
| 862 | # "configure-sh" |
| 863 | # "containerd-configure-sh" |
| 864 | # "enable-os-login" |
| 865 | # "gci-ensure-gke-docker" |
| 866 | # "gci-metrics-enabled" |
| 867 | # "gci-update-strategy" |
| 868 | # "instance-template" |
| 869 | # "kube-env" |
| 870 | # "startup-script" |
| 871 | # "user-data" |
| 872 | # "disable-address-manager" |
| 873 | # "windows-startup-script-ps1" |
| 874 | # "common-psm1" |
| 875 | # "k8s-node-setup-psm1" |
| 876 | # "install-ssh-psm1" |
| 877 | # "user-profile-psm1" |
| 878 | # "serial-port-logging-enable" |
| 879 | # |
| 880 | # Values are free-form strings, and only have meaning as interpreted by |
| 881 | # the image running in the instance. The only restriction placed on them is |
| 882 | # that each value's size must be less than or equal to 32 KB. |
| 883 | # |
| 884 | # The total size of all keys and values must be less than 512 KB. |
| 885 | "a_key": "A String", |
| 886 | }, |
| 887 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 888 | # the specified [Zonal Compute |
| 889 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 890 | # to this node pool. |
| 891 | # is the configuration of desired reservation which instances could take |
| 892 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 893 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 894 | "A String", |
| 895 | ], |
| 896 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 897 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 898 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 899 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 900 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 901 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 902 | # valid sources or targets for network firewalls and are specified by |
| 903 | # the client during cluster or node pool creation. Each tag within the list |
| 904 | # must comply with RFC1035. |
| 905 | "A String", |
| 906 | ], |
| 907 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 908 | # Specify the email address of the Service Account; otherwise, if no Service |
| 909 | # Account is specified, the "default" service account is used. |
| 910 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 911 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 912 | }, |
| 913 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 914 | # simultaneously on a node in the node pool. |
| 915 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 916 | }, |
| 917 | "name": "A String", # The name of the node pool. |
| 918 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 919 | # node pool. |
| 920 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 921 | # the Auto Upgrades will proceed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 922 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 923 | # with the approximate start time for the upgrades, in |
| 924 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 925 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 926 | # with the description of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 927 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 928 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 929 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 930 | # they fail health checks too many times, an automatic repair action will be |
| 931 | # triggered. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 932 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 933 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 934 | # up to date with the latest release version of Kubernetes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 935 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 936 | }, |
| 937 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 938 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 939 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 940 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 941 | "provider": "A String", # The selected network policy provider. |
| 942 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 943 | }, |
| 944 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 945 | # this cluster, in |
| 946 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 947 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 948 | # typically put in the last `/16` from the container CIDR. |
| 949 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 950 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 951 | # the kubernetes version of the master and nodes. |
| 952 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 953 | # Alpha enabled clusters are automatically deleted thirty days after |
| 954 | # creation. |
| 955 | "description": "A String", # An optional description of this cluster. |
| 956 | "conditions": [ # Which conditions caused the current cluster state. |
| 957 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 958 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 959 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 960 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 961 | }, |
| 962 | ], |
| 963 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 964 | # Call Kubernetes API directly to retrieve node information. |
| 965 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 966 | # Currently available options: |
| 967 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 968 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 969 | # service with a Kubernetes-native resource model |
| 970 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 971 | # longer available as of GKE 1.15). |
| 972 | # * `none` - No metrics will be exported from the cluster. |
| 973 | # |
| 974 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 975 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 976 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 977 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 978 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 979 | "state": "A String", # Denotes the state of etcd encryption. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 980 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 981 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 982 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 983 | # images will be validated by Binary Authorization. |
| 984 | }, |
| 985 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 986 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 987 | # notation (e.g. `1.2.3.4/29`). |
| 988 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 989 | # policies. |
| 990 | # policies. |
| 991 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 992 | }, |
| 993 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 994 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 995 | # cluster resides. This field is deprecated, use location instead. |
| 996 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 997 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 998 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 999 | # Currently available options: |
| 1000 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1001 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 1002 | # service with a Kubernetes-native resource model |
| 1003 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 1004 | # available as of GKE 1.15). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1005 | # * `none` - no logs will be exported from the cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1006 | # |
| 1007 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 1008 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1009 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1010 | # For requests, this field should only be used in lieu of a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1011 | # "node_pool" object, since this configuration (along with the |
| 1012 | # "initial_node_count") will be used to create a "NodePool" object with an |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1013 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1014 | # For responses, this field will be populated with the node configuration of |
| 1015 | # the first node pool. (For configuration of each node pool, see |
| 1016 | # `node_pool.config`) |
| 1017 | # |
| 1018 | # If unspecified, the defaults are used. |
| 1019 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1020 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1021 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1022 | # |
| 1023 | # The following scopes are recommended, but not required, and by default are |
| 1024 | # not included: |
| 1025 | # |
| 1026 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1027 | # persistent storage on your nodes. |
| 1028 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1029 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1030 | # (the [Google Container |
| 1031 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1032 | # |
| 1033 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1034 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1035 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1036 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1037 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1038 | # |
| 1039 | # For more information, including usage and the valid values, see: |
| 1040 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1041 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1042 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1043 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1044 | # See |
| 1045 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1046 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1047 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1048 | "value": "A String", # Value for taint. |
| 1049 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1050 | }, |
| 1051 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1052 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1053 | # These will added in addition to any default label(s) that |
| 1054 | # Kubernetes may apply to the node. |
| 1055 | # In case of conflict in label keys, the applied set may differ depending on |
| 1056 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1057 | # and conflicts should be avoided. |
| 1058 | # For more information, including usage and the valid values, see: |
| 1059 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1060 | "a_key": "A String", |
| 1061 | }, |
| 1062 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1063 | # The smallest allowed disk size is 10GB. |
| 1064 | # |
| 1065 | # If unspecified, the default disk size is 100GB. |
| 1066 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1067 | # workloads on the node pool. |
| 1068 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1069 | # on the node pool. |
| 1070 | }, |
| 1071 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1072 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1073 | # support for GPUs. |
| 1074 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1075 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1076 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1077 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1078 | }, |
| 1079 | ], |
| 1080 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1081 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1082 | # `n1-standard-1`). |
| 1083 | # |
| 1084 | # If unspecified, the default machine type is |
| 1085 | # `n1-standard-1`. |
| 1086 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1087 | # |
| 1088 | # If unspecified, the default disk type is 'pd-standard' |
| 1089 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1090 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1091 | # |
| 1092 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1093 | # The attestation is performed against the integrity policy baseline. This |
| 1094 | # baseline is initially derived from the implicitly trusted boot image when |
| 1095 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1096 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1097 | # |
| 1098 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1099 | # verifying the digital signature of all boot components, and halting the |
| 1100 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1101 | }, |
| 1102 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1103 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1104 | # friendly names of CPU platforms, such as |
| 1105 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1106 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1107 | # information, read [how to specify min CPU |
| 1108 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1109 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1110 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1111 | # information about preemptible VM instances. |
| 1112 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1113 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1114 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1115 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1116 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1117 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1118 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1119 | "type": "A String", # Type of the sandbox to use for the node. |
| 1120 | }, |
| 1121 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1122 | # |
| 1123 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1124 | # in length. These are reflected as part of a URL in the metadata server. |
| 1125 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1126 | # metadata keys for the project or be one of the reserved keys: |
| 1127 | # "cluster-location" |
| 1128 | # "cluster-name" |
| 1129 | # "cluster-uid" |
| 1130 | # "configure-sh" |
| 1131 | # "containerd-configure-sh" |
| 1132 | # "enable-os-login" |
| 1133 | # "gci-ensure-gke-docker" |
| 1134 | # "gci-metrics-enabled" |
| 1135 | # "gci-update-strategy" |
| 1136 | # "instance-template" |
| 1137 | # "kube-env" |
| 1138 | # "startup-script" |
| 1139 | # "user-data" |
| 1140 | # "disable-address-manager" |
| 1141 | # "windows-startup-script-ps1" |
| 1142 | # "common-psm1" |
| 1143 | # "k8s-node-setup-psm1" |
| 1144 | # "install-ssh-psm1" |
| 1145 | # "user-profile-psm1" |
| 1146 | # "serial-port-logging-enable" |
| 1147 | # |
| 1148 | # Values are free-form strings, and only have meaning as interpreted by |
| 1149 | # the image running in the instance. The only restriction placed on them is |
| 1150 | # that each value's size must be less than or equal to 32 KB. |
| 1151 | # |
| 1152 | # The total size of all keys and values must be less than 512 KB. |
| 1153 | "a_key": "A String", |
| 1154 | }, |
| 1155 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1156 | # the specified [Zonal Compute |
| 1157 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1158 | # to this node pool. |
| 1159 | # is the configuration of desired reservation which instances could take |
| 1160 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1161 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1162 | "A String", |
| 1163 | ], |
| 1164 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1165 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1166 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1167 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1168 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1169 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 1170 | # valid sources or targets for network firewalls and are specified by |
| 1171 | # the client during cluster or node pool creation. Each tag within the list |
| 1172 | # must comply with RFC1035. |
| 1173 | "A String", |
| 1174 | ], |
| 1175 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 1176 | # Specify the email address of the Service Account; otherwise, if no Service |
| 1177 | # Account is specified, the "default" service account is used. |
| 1178 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1179 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1180 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1181 | "status": "A String", # [Output only] The current status of this cluster. |
| 1182 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1183 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 1184 | # This makes same node pod to pod traffic visible for VPC network. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1185 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 1186 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 1187 | # cluster is connected. Example: |
| 1188 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 1189 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 1190 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1191 | # to which the cluster is connected. Example: |
| 1192 | # projects/my-project/global/networks/my-network |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1193 | }, |
| 1194 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 1195 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 1196 | # the following restrictions: |
| 1197 | # |
| 1198 | # * Lowercase letters, numbers, and hyphens only. |
| 1199 | # * Must start with a letter. |
| 1200 | # * Must end with a number or a letter. |
| 1201 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 1202 | # The endpoint can be accessed from the internet at |
| 1203 | # `https://username:password@endpoint/`. |
| 1204 | # |
| 1205 | # See the `masterAuth` property of this resource for username and |
| 1206 | # password information. |
| 1207 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1208 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1209 | # or |
| 1210 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1211 | # in which the cluster resides. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1212 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1213 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 1214 | # number](https://support.google.com/cloud/answer/6158840). |
| 1215 | # This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1216 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 1217 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1218 | # cluster resides. This field has been deprecated and replaced by the parent |
| 1219 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1220 | } |
| 1221 | |
| 1222 | x__xgafv: string, V1 error format. |
| 1223 | Allowed values |
| 1224 | 1 - v1 error format |
| 1225 | 2 - v2 error format |
| 1226 | |
| 1227 | Returns: |
| 1228 | An object of the form: |
| 1229 | |
| 1230 | { # This operation resource represents operations that may have happened or are |
| 1231 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1232 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1233 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1234 | # (e.g., ERROR or DEGRADED). |
| 1235 | "code": "A String", # Machine-friendly representation of the condition |
| 1236 | "message": "A String", # Human-friendly representation of the condition |
| 1237 | }, |
| 1238 | ], |
| 1239 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1240 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1241 | # Unset for single-stage operations. |
| 1242 | "stages": [ # Substages of an operation or a stage. |
| 1243 | # Object with schema name: OperationProgress |
| 1244 | ], |
| 1245 | "metrics": [ # Progress metric bundle, for example: |
| 1246 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1247 | # {name: "nodes total", int_value: 32}] |
| 1248 | # or |
| 1249 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1250 | # {name: "progress scale", double_value: 1.0}] |
| 1251 | { # Progress metric is (string, int|float|string) pair. |
| 1252 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1253 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1254 | "intValue": "A String", # For metrics with integer value. |
| 1255 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1256 | }, |
| 1257 | ], |
| 1258 | "status": "A String", # Status of an operation stage. |
| 1259 | # Unset for single-stage operations. |
| 1260 | }, |
| 1261 | "zone": "A String", # The name of the Google Compute Engine |
| 1262 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1263 | # operation is taking place. This field is deprecated, use location instead. |
| 1264 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1265 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1266 | "detail": "A String", # Detailed operation progress, if available. |
| 1267 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1268 | "operationType": "A String", # The operation type. |
| 1269 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1270 | "name": "A String", # The server-assigned ID for the operation. |
| 1271 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1272 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1273 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1274 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1275 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1276 | }, |
| 1277 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1278 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1279 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1280 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1281 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1282 | # or |
| 1283 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1284 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1285 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1286 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1287 | }</pre> |
| 1288 | </div> |
| 1289 | |
| 1290 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1291 | <code class="details" id="delete">delete(name, projectId=None, zone=None, clusterId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1292 | <pre>Deletes the cluster, including the Kubernetes endpoint and all worker |
| 1293 | nodes. |
| 1294 | |
| 1295 | Firewalls and routes that were configured during cluster creation |
| 1296 | are also deleted. |
| 1297 | |
| 1298 | Other Google Compute Engine resources that might be in use by the cluster, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1299 | such as load balancer resources, are not deleted if they weren't present |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1300 | when the cluster was initially created. |
| 1301 | |
| 1302 | Args: |
| 1303 | name: string, The name (project, location, cluster) of the cluster to delete. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1304 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1305 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 1306 | number](https://support.google.com/cloud/answer/6158840). |
| 1307 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1308 | zone: string, Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1309 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1310 | cluster resides. This field has been deprecated and replaced by the name |
| 1311 | field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1312 | clusterId: string, Deprecated. The name of the cluster to delete. |
| 1313 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1314 | x__xgafv: string, V1 error format. |
| 1315 | Allowed values |
| 1316 | 1 - v1 error format |
| 1317 | 2 - v2 error format |
| 1318 | |
| 1319 | Returns: |
| 1320 | An object of the form: |
| 1321 | |
| 1322 | { # This operation resource represents operations that may have happened or are |
| 1323 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1324 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1325 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1326 | # (e.g., ERROR or DEGRADED). |
| 1327 | "code": "A String", # Machine-friendly representation of the condition |
| 1328 | "message": "A String", # Human-friendly representation of the condition |
| 1329 | }, |
| 1330 | ], |
| 1331 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1332 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1333 | # Unset for single-stage operations. |
| 1334 | "stages": [ # Substages of an operation or a stage. |
| 1335 | # Object with schema name: OperationProgress |
| 1336 | ], |
| 1337 | "metrics": [ # Progress metric bundle, for example: |
| 1338 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1339 | # {name: "nodes total", int_value: 32}] |
| 1340 | # or |
| 1341 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1342 | # {name: "progress scale", double_value: 1.0}] |
| 1343 | { # Progress metric is (string, int|float|string) pair. |
| 1344 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1345 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1346 | "intValue": "A String", # For metrics with integer value. |
| 1347 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1348 | }, |
| 1349 | ], |
| 1350 | "status": "A String", # Status of an operation stage. |
| 1351 | # Unset for single-stage operations. |
| 1352 | }, |
| 1353 | "zone": "A String", # The name of the Google Compute Engine |
| 1354 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1355 | # operation is taking place. This field is deprecated, use location instead. |
| 1356 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1357 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1358 | "detail": "A String", # Detailed operation progress, if available. |
| 1359 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1360 | "operationType": "A String", # The operation type. |
| 1361 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1362 | "name": "A String", # The server-assigned ID for the operation. |
| 1363 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1364 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1365 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1366 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1367 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1368 | }, |
| 1369 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1370 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1371 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1372 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1373 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1374 | # or |
| 1375 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1376 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1377 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1378 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1379 | }</pre> |
| 1380 | </div> |
| 1381 | |
| 1382 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1383 | <code class="details" id="get">get(name, clusterId=None, projectId=None, zone=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1384 | <pre>Gets the details of a specific cluster. |
| 1385 | |
| 1386 | Args: |
| 1387 | name: string, The name (project, location, cluster) of the cluster to retrieve. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1388 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1389 | clusterId: string, Deprecated. The name of the cluster to retrieve. |
| 1390 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1391 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 1392 | number](https://support.google.com/cloud/answer/6158840). |
| 1393 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1394 | zone: string, Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1395 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1396 | cluster resides. This field has been deprecated and replaced by the name |
| 1397 | field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1398 | x__xgafv: string, V1 error format. |
| 1399 | Allowed values |
| 1400 | 1 - v1 error format |
| 1401 | 2 - v2 error format |
| 1402 | |
| 1403 | Returns: |
| 1404 | An object of the form: |
| 1405 | |
| 1406 | { # A Google Kubernetes Engine cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1407 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 1408 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1409 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 1410 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1411 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 1412 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 1413 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 1414 | # required by Cluster Autoscaler to automatically adjust |
| 1415 | # the size of the cluster and create/delete |
| 1416 | # node pools based on the current needs. |
| 1417 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 1418 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1419 | # NodePool's nodes can be created by NAP. |
| 1420 | "A String", |
| 1421 | ], |
| 1422 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 1423 | # amount of resources in the cluster. |
| 1424 | { # Contains information about amount of some resource in the cluster. |
| 1425 | # For memory, value should be in GB. |
| 1426 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 1427 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 1428 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 1429 | }, |
| 1430 | ], |
| 1431 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 1432 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 1433 | # created by NAP. |
| 1434 | # by NAP. |
| 1435 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 1436 | # node pool. |
| 1437 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1438 | # the Auto Upgrades will proceed. |
| 1439 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1440 | # with the approximate start time for the upgrades, in |
| 1441 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1442 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1443 | # with the description of the upgrade. |
| 1444 | }, |
| 1445 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 1446 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 1447 | # they fail health checks too many times, an automatic repair action will be |
| 1448 | # triggered. |
| 1449 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 1450 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 1451 | # up to date with the latest release version of Kubernetes. |
| 1452 | }, |
| 1453 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 1454 | # specified, service_account should be empty. |
| 1455 | "A String", |
| 1456 | ], |
| 1457 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 1458 | # disruption caused by an upgrade. |
| 1459 | # |
| 1460 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1461 | # unavailable. |
| 1462 | # |
| 1463 | # maxSurge controls the number of additional nodes that can be added to the |
| 1464 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1465 | # available nodes. |
| 1466 | # |
| 1467 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1468 | # nodes are being upgraded at the same time). |
| 1469 | # |
| 1470 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1471 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1472 | # this holds true. (Disruption stays within the limits of |
| 1473 | # PodDisruptionBudget, if it is configured.) |
| 1474 | # |
| 1475 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1476 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1477 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1478 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1479 | # there are always at least 4 nodes available. |
| 1480 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 1481 | # the upgrade process. A node is considered available if its status is |
| 1482 | # Ready. |
| 1483 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1484 | # of the node pool during the upgrade process. |
| 1485 | }, |
| 1486 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 1487 | # service_account is specified, scopes should be empty. |
| 1488 | }, |
| 1489 | }, |
| 1490 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 1491 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 1492 | # is sufficient for this number of instances. You must also have available |
| 1493 | # firewall and routes quota. |
| 1494 | # For requests, this field should only be used in lieu of a |
| 1495 | # "node_pool" object, since this configuration (along with the |
| 1496 | # "node_config") will be used to create a "NodePool" object with an |
| 1497 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1498 | # |
| 1499 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 1500 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 1501 | "A String", |
| 1502 | ], |
| 1503 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 1504 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 1505 | # range will be used for assigning internal IP addresses to the master or |
| 1506 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 1507 | # any other ranges in use within the cluster's network. |
| 1508 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 1509 | # given only RFC 1918 private addresses and communicate with the master via |
| 1510 | # private networking. |
| 1511 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 1512 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 1513 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 1514 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 1515 | }, |
| 1516 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 1517 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 1518 | }, |
| 1519 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 1520 | # required by Vertical Pod Autoscaler to automatically adjust |
| 1521 | # the resources of pods controlled by it. |
| 1522 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 1523 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1524 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 1525 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 1526 | # if cluster created with IP Alias support. |
| 1527 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1528 | }, |
| 1529 | "network": "A String", # The name of the Google Compute Engine |
| 1530 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1531 | # to which the cluster is connected. If left unspecified, the `default` |
| 1532 | # network will be used. |
| 1533 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 1534 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1535 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 1536 | # range. This field will only be set when cluster is in route-based network |
| 1537 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1538 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 1539 | # master authorized networks will disallow all external traffic to access |
| 1540 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 1541 | # Google Compute Engine Public IPs and Google Prod IPs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1542 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 1543 | # Kubernetes master through HTTPS. |
| 1544 | { # CidrBlock contains an optional name and one CIDR block. |
| 1545 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 1546 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 1547 | }, |
| 1548 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1549 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1550 | }, |
| 1551 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1552 | # cluster, if available. |
| 1553 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 1554 | # If unspecified, the defaults are used: |
| 1555 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 1556 | # be set to "admin", a random password will be generated, and a client |
| 1557 | # certificate will be issued. |
| 1558 | # Authentication can be done using HTTP basic auth or using client |
| 1559 | # certificates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1560 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 1561 | # Because the master endpoint is open to the Internet, you should create a |
| 1562 | # strong password. If a password is provided for cluster creation, username |
| 1563 | # must be non-empty. |
| 1564 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 1565 | # clusters before v1.12, if no configuration is specified, a client |
| 1566 | # certificate is issued. |
| 1567 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 1568 | }, |
| 1569 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 1570 | # to the cluster endpoint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1571 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 1572 | # trust for the cluster. |
| 1573 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 1574 | # authenticate to the cluster endpoint. |
| 1575 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 1576 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 1577 | # leaving username unspecified (or setting it to the empty string). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1578 | }, |
| 1579 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 1580 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 1581 | # during authentication using a group of security groups. |
| 1582 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 1583 | # if enabled = true. |
| 1584 | }, |
| 1585 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 1586 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 1587 | # cluster, enabling additional functionality. |
| 1588 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 1589 | # is enabled or not on the Master, it does not track whether network policy |
| 1590 | # is enabled for the nodes. |
| 1591 | # is enabled or not on the Master, it does not track whether network policy |
| 1592 | # is enabled for the nodes. |
| 1593 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 1594 | }, |
| 1595 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 1596 | # managed Knative service. |
| 1597 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 1598 | }, |
| 1599 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 1600 | # increases or decreases the number of replica pods a replication controller |
| 1601 | # has based on the resource usage of the existing pods. |
| 1602 | # increases or decreases the number of replica pods a replication controller |
| 1603 | # has based on the resource usage of the existing pods. |
| 1604 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 1605 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 1606 | # Monitoring. |
| 1607 | }, |
| 1608 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 1609 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 1610 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 1611 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 1612 | # When enabled, it runs a small pod in the cluster that manages the load |
| 1613 | # balancers. |
| 1614 | }, |
| 1615 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 1616 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 1617 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 1618 | # workloads and applications. For more information, see: |
| 1619 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 1620 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 1621 | }, |
| 1622 | }, |
| 1623 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 1624 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 1625 | # instead. The current version of the node software components. If they are |
| 1626 | # currently at multiple versions because they're in the process of being |
| 1627 | # upgraded, this reflects the minimum version of all nodes. |
| 1628 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 1629 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 1630 | # the cluster is connected. |
| 1631 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 1632 | # Google Compute Engine resources. |
| 1633 | "a_key": "A String", |
| 1634 | }, |
| 1635 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 1636 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1637 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 1638 | # occur in these windows. |
| 1639 | "a_key": { # Represents an arbitrary window of time. |
| 1640 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1641 | # start time. |
| 1642 | "startTime": "A String", # The time that the window first starts. |
| 1643 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1644 | }, |
| 1645 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1646 | # maintenance to occur. The time windows may be overlapping. If no |
| 1647 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1648 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 1649 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1650 | # start time. |
| 1651 | "startTime": "A String", # The time that the window first starts. |
| 1652 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1653 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1654 | # this window reccurs. They go on for the span of time between the start and |
| 1655 | # end time. |
| 1656 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1657 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1658 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 1659 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 1660 | # <code>FREQ=DAILY</code> |
| 1661 | # For the first weekend of every month: |
| 1662 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 1663 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1664 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1665 | # <code> |
| 1666 | # start time = 2019-01-01T09:00:00-0400 |
| 1667 | # end time = 2019-01-01T17:00:00-0400 |
| 1668 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 1669 | # </code> |
| 1670 | # Windows can span multiple days. Eg, to make the window encompass every |
| 1671 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 1672 | # <code> |
| 1673 | # start time = 2019-01-05T00:00:00Z |
| 1674 | # end time = 2019-01-07T23:59:00Z |
| 1675 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 1676 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1677 | # Note the start and end time's specific dates are largely arbitrary except |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1678 | # to specify duration of the window and when it first starts. |
| 1679 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1680 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1681 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 1682 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 1683 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 1684 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 1685 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 1686 | # smallest possible in the given scenario. |
| 1687 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 1688 | # format "PTnHnMnS". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1689 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1690 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1691 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 1692 | # the policy won't accidentally undo intermediate changes (and so that users |
| 1693 | # of the API unaware of some fields won't accidentally remove other fields). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1694 | # Make a <code>get()</code> request to the cluster to get the current |
| 1695 | # resource version and include it with requests to set the policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1696 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1697 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 1698 | # found in validMasterVersions returned by getServerConfig. The version can |
| 1699 | # be upgraded over time; such upgrades are reflected in |
| 1700 | # currentMasterVersion and currentNodeVersion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1701 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1702 | # Users may specify either explicit versions offered by |
| 1703 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 1704 | # |
| 1705 | # - "latest": picks the highest valid Kubernetes version |
| 1706 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 1707 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 1708 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 1709 | # - "","-": picks the default Kubernetes version |
| 1710 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1711 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1712 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 1713 | # block. The secondary range will be used for pod IP |
| 1714 | # addresses. This must be an existing secondary range associated |
| 1715 | # with the cluster subnetwork. |
| 1716 | # |
| 1717 | # This field is only applicable with use_ip_aliases is true and |
| 1718 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1719 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 1720 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1721 | # |
| 1722 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1723 | # |
| 1724 | # Set to blank to have a range chosen with the default size. |
| 1725 | # |
| 1726 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1727 | # netmask. |
| 1728 | # |
| 1729 | # Set to a |
| 1730 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1731 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1732 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1733 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1734 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1735 | # |
| 1736 | # This is applicable only if `create_subnetwork` is true. |
| 1737 | # |
| 1738 | # Set to blank to have a range chosen with the default size. |
| 1739 | # |
| 1740 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1741 | # netmask. |
| 1742 | # |
| 1743 | # Set to a |
| 1744 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1745 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1746 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1747 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1748 | "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1749 | # range will be automatically chosen with the default size. |
| 1750 | # |
| 1751 | # This field is only applicable when `use_ip_aliases` is true. |
| 1752 | # |
| 1753 | # If unspecified, the range will use the default size. |
| 1754 | # |
| 1755 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1756 | # netmask. |
| 1757 | # |
| 1758 | # Set to a |
| 1759 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1760 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1761 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1762 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1763 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 1764 | "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1765 | # CIDR block. The secondary range will be used for service |
| 1766 | # ClusterIPs. This must be an existing secondary range associated |
| 1767 | # with the cluster subnetwork. |
| 1768 | # |
| 1769 | # This field is only applicable with use_ip_aliases is true and |
| 1770 | # create_subnetwork is false. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1771 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 1772 | # |
| 1773 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1774 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 1775 | # this field is empty, then an automatic name will be chosen for the new |
| 1776 | # subnetwork. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1777 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 1778 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 1779 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 1780 | # will be automatically chosen with the default size. |
| 1781 | # |
| 1782 | # This field is only applicable when `use_ip_aliases` is true. |
| 1783 | # |
| 1784 | # Set to blank to have a range chosen with the default size. |
| 1785 | # |
| 1786 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1787 | # netmask. |
| 1788 | # |
| 1789 | # Set to a |
| 1790 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1791 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1792 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1793 | # to use. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1794 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1795 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 1796 | # mode. |
| 1797 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 1798 | # identities in the system, including service accounts, nodes, and |
| 1799 | # controllers, will have statically granted permissions beyond those |
| 1800 | # provided by the RBAC configuration or IAM. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1801 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1802 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1803 | # disabled when this config is unspecified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1804 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1805 | # daemonset will be created in the cluster to meter network egress traffic. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1806 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 1807 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1808 | # second BigQuery table will be created to hold resource consumption |
| 1809 | # records. |
| 1810 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1811 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 1812 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1813 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1814 | }, |
| 1815 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 1816 | "locations": [ # The list of Google Compute Engine |
| 1817 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1818 | # cluster's nodes should be located. |
| 1819 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1820 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1821 | "nodePools": [ # The node pools associated with this cluster. |
| 1822 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1823 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1824 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 1825 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1826 | # specification, under the control of the cluster master. They may have a set |
| 1827 | # of Kubernetes labels applied to them, which may be used to reference them |
| 1828 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 1829 | # the workload. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1830 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1831 | # node pool instance, if available. |
| 1832 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 1833 | # only if a valid configuration is present. |
| 1834 | # adjust the size of the node pool to the current cluster usage. |
| 1835 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 1836 | # has to enough quota to scale up the cluster. |
| 1837 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 1838 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 1839 | # max_node_count. |
| 1840 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 1841 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1842 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 1843 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 1844 | # is sufficient for this number of instances. You must also have available |
| 1845 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1846 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1847 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1848 | # disruption caused by an upgrade. |
| 1849 | # |
| 1850 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1851 | # unavailable. |
| 1852 | # |
| 1853 | # maxSurge controls the number of additional nodes that can be added to the |
| 1854 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1855 | # available nodes. |
| 1856 | # |
| 1857 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1858 | # nodes are being upgraded at the same time). |
| 1859 | # |
| 1860 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1861 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1862 | # this holds true. (Disruption stays within the limits of |
| 1863 | # PodDisruptionBudget, if it is configured.) |
| 1864 | # |
| 1865 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1866 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1867 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1868 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1869 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1870 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1871 | # the upgrade process. A node is considered available if its status is |
| 1872 | # Ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1873 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1874 | # of the node pool during the upgrade process. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1875 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1876 | "locations": [ # The list of Google Compute Engine |
| 1877 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1878 | # NodePool's nodes should be located. |
| 1879 | "A String", |
| 1880 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1881 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 1882 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 1883 | # associated with this node pool. |
| 1884 | "A String", |
| 1885 | ], |
| 1886 | "version": "A String", # The version of the Kubernetes of this node. |
| 1887 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 1888 | "conditions": [ # Which conditions caused the current node pool state. |
| 1889 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1890 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1891 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1892 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1893 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1894 | ], |
| 1895 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 1896 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1897 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1898 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1899 | # |
| 1900 | # The following scopes are recommended, but not required, and by default are |
| 1901 | # not included: |
| 1902 | # |
| 1903 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1904 | # persistent storage on your nodes. |
| 1905 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1906 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1907 | # (the [Google Container |
| 1908 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1909 | # |
| 1910 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1911 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1912 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1913 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1914 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1915 | # |
| 1916 | # For more information, including usage and the valid values, see: |
| 1917 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1918 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1919 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1920 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1921 | # See |
| 1922 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1923 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1924 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1925 | "value": "A String", # Value for taint. |
| 1926 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1927 | }, |
| 1928 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1929 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1930 | # These will added in addition to any default label(s) that |
| 1931 | # Kubernetes may apply to the node. |
| 1932 | # In case of conflict in label keys, the applied set may differ depending on |
| 1933 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1934 | # and conflicts should be avoided. |
| 1935 | # For more information, including usage and the valid values, see: |
| 1936 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1937 | "a_key": "A String", |
| 1938 | }, |
| 1939 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1940 | # The smallest allowed disk size is 10GB. |
| 1941 | # |
| 1942 | # If unspecified, the default disk size is 100GB. |
| 1943 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1944 | # workloads on the node pool. |
| 1945 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1946 | # on the node pool. |
| 1947 | }, |
| 1948 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1949 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1950 | # support for GPUs. |
| 1951 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1952 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1953 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1954 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1955 | }, |
| 1956 | ], |
| 1957 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1958 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1959 | # `n1-standard-1`). |
| 1960 | # |
| 1961 | # If unspecified, the default machine type is |
| 1962 | # `n1-standard-1`. |
| 1963 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1964 | # |
| 1965 | # If unspecified, the default disk type is 'pd-standard' |
| 1966 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1967 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1968 | # |
| 1969 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1970 | # The attestation is performed against the integrity policy baseline. This |
| 1971 | # baseline is initially derived from the implicitly trusted boot image when |
| 1972 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1973 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1974 | # |
| 1975 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1976 | # verifying the digital signature of all boot components, and halting the |
| 1977 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1978 | }, |
| 1979 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1980 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1981 | # friendly names of CPU platforms, such as |
| 1982 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1983 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1984 | # information, read [how to specify min CPU |
| 1985 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1986 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1987 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1988 | # information about preemptible VM instances. |
| 1989 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1990 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1991 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1992 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1993 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1994 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1995 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1996 | "type": "A String", # Type of the sandbox to use for the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1997 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1998 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1999 | # |
| 2000 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2001 | # in length. These are reflected as part of a URL in the metadata server. |
| 2002 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2003 | # metadata keys for the project or be one of the reserved keys: |
| 2004 | # "cluster-location" |
| 2005 | # "cluster-name" |
| 2006 | # "cluster-uid" |
| 2007 | # "configure-sh" |
| 2008 | # "containerd-configure-sh" |
| 2009 | # "enable-os-login" |
| 2010 | # "gci-ensure-gke-docker" |
| 2011 | # "gci-metrics-enabled" |
| 2012 | # "gci-update-strategy" |
| 2013 | # "instance-template" |
| 2014 | # "kube-env" |
| 2015 | # "startup-script" |
| 2016 | # "user-data" |
| 2017 | # "disable-address-manager" |
| 2018 | # "windows-startup-script-ps1" |
| 2019 | # "common-psm1" |
| 2020 | # "k8s-node-setup-psm1" |
| 2021 | # "install-ssh-psm1" |
| 2022 | # "user-profile-psm1" |
| 2023 | # "serial-port-logging-enable" |
| 2024 | # |
| 2025 | # Values are free-form strings, and only have meaning as interpreted by |
| 2026 | # the image running in the instance. The only restriction placed on them is |
| 2027 | # that each value's size must be less than or equal to 32 KB. |
| 2028 | # |
| 2029 | # The total size of all keys and values must be less than 512 KB. |
| 2030 | "a_key": "A String", |
| 2031 | }, |
| 2032 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2033 | # the specified [Zonal Compute |
| 2034 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2035 | # to this node pool. |
| 2036 | # is the configuration of desired reservation which instances could take |
| 2037 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2038 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2039 | "A String", |
| 2040 | ], |
| 2041 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2042 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2043 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2044 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2045 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2046 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 2047 | # valid sources or targets for network firewalls and are specified by |
| 2048 | # the client during cluster or node pool creation. Each tag within the list |
| 2049 | # must comply with RFC1035. |
| 2050 | "A String", |
| 2051 | ], |
| 2052 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2053 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2054 | # Account is specified, the "default" service account is used. |
| 2055 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2056 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2057 | }, |
| 2058 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 2059 | # simultaneously on a node in the node pool. |
| 2060 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2061 | }, |
| 2062 | "name": "A String", # The name of the node pool. |
| 2063 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 2064 | # node pool. |
| 2065 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2066 | # the Auto Upgrades will proceed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2067 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2068 | # with the approximate start time for the upgrades, in |
| 2069 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2070 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2071 | # with the description of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2072 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2073 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 2074 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 2075 | # they fail health checks too many times, an automatic repair action will be |
| 2076 | # triggered. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2077 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 2078 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 2079 | # up to date with the latest release version of Kubernetes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2080 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2081 | }, |
| 2082 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2083 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2084 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 2085 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 2086 | "provider": "A String", # The selected network policy provider. |
| 2087 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 2088 | }, |
| 2089 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 2090 | # this cluster, in |
| 2091 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2092 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 2093 | # typically put in the last `/16` from the container CIDR. |
| 2094 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 2095 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 2096 | # the kubernetes version of the master and nodes. |
| 2097 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 2098 | # Alpha enabled clusters are automatically deleted thirty days after |
| 2099 | # creation. |
| 2100 | "description": "A String", # An optional description of this cluster. |
| 2101 | "conditions": [ # Which conditions caused the current cluster state. |
| 2102 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2103 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2104 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2105 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2106 | }, |
| 2107 | ], |
| 2108 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 2109 | # Call Kubernetes API directly to retrieve node information. |
| 2110 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2111 | # Currently available options: |
| 2112 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2113 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2114 | # service with a Kubernetes-native resource model |
| 2115 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 2116 | # longer available as of GKE 1.15). |
| 2117 | # * `none` - No metrics will be exported from the cluster. |
| 2118 | # |
| 2119 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 2120 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2121 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 2122 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 2123 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 2124 | "state": "A String", # Denotes the state of etcd encryption. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2125 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2126 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 2127 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 2128 | # images will be validated by Binary Authorization. |
| 2129 | }, |
| 2130 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 2131 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2132 | # notation (e.g. `1.2.3.4/29`). |
| 2133 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 2134 | # policies. |
| 2135 | # policies. |
| 2136 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 2137 | }, |
| 2138 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 2139 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2140 | # cluster resides. This field is deprecated, use location instead. |
| 2141 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 2142 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2143 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2144 | # Currently available options: |
| 2145 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2146 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 2147 | # service with a Kubernetes-native resource model |
| 2148 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 2149 | # available as of GKE 1.15). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2150 | # * `none` - no logs will be exported from the cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2151 | # |
| 2152 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 2153 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2154 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2155 | # For requests, this field should only be used in lieu of a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2156 | # "node_pool" object, since this configuration (along with the |
| 2157 | # "initial_node_count") will be used to create a "NodePool" object with an |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2158 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2159 | # For responses, this field will be populated with the node configuration of |
| 2160 | # the first node pool. (For configuration of each node pool, see |
| 2161 | # `node_pool.config`) |
| 2162 | # |
| 2163 | # If unspecified, the defaults are used. |
| 2164 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2165 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2166 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2167 | # |
| 2168 | # The following scopes are recommended, but not required, and by default are |
| 2169 | # not included: |
| 2170 | # |
| 2171 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2172 | # persistent storage on your nodes. |
| 2173 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2174 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2175 | # (the [Google Container |
| 2176 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2177 | # |
| 2178 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2179 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2180 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2181 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2182 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2183 | # |
| 2184 | # For more information, including usage and the valid values, see: |
| 2185 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2186 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2187 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2188 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2189 | # See |
| 2190 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2191 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2192 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2193 | "value": "A String", # Value for taint. |
| 2194 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2195 | }, |
| 2196 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2197 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2198 | # These will added in addition to any default label(s) that |
| 2199 | # Kubernetes may apply to the node. |
| 2200 | # In case of conflict in label keys, the applied set may differ depending on |
| 2201 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2202 | # and conflicts should be avoided. |
| 2203 | # For more information, including usage and the valid values, see: |
| 2204 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2205 | "a_key": "A String", |
| 2206 | }, |
| 2207 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2208 | # The smallest allowed disk size is 10GB. |
| 2209 | # |
| 2210 | # If unspecified, the default disk size is 100GB. |
| 2211 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2212 | # workloads on the node pool. |
| 2213 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2214 | # on the node pool. |
| 2215 | }, |
| 2216 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2217 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2218 | # support for GPUs. |
| 2219 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2220 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2221 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2222 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2223 | }, |
| 2224 | ], |
| 2225 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 2226 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 2227 | # `n1-standard-1`). |
| 2228 | # |
| 2229 | # If unspecified, the default machine type is |
| 2230 | # `n1-standard-1`. |
| 2231 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2232 | # |
| 2233 | # If unspecified, the default disk type is 'pd-standard' |
| 2234 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2235 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 2236 | # |
| 2237 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2238 | # The attestation is performed against the integrity policy baseline. This |
| 2239 | # baseline is initially derived from the implicitly trusted boot image when |
| 2240 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2241 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2242 | # |
| 2243 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2244 | # verifying the digital signature of all boot components, and halting the |
| 2245 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2246 | }, |
| 2247 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2248 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2249 | # friendly names of CPU platforms, such as |
| 2250 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2251 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2252 | # information, read [how to specify min CPU |
| 2253 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2254 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2255 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2256 | # information about preemptible VM instances. |
| 2257 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2258 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2259 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2260 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2261 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2262 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2263 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2264 | "type": "A String", # Type of the sandbox to use for the node. |
| 2265 | }, |
| 2266 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 2267 | # |
| 2268 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2269 | # in length. These are reflected as part of a URL in the metadata server. |
| 2270 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2271 | # metadata keys for the project or be one of the reserved keys: |
| 2272 | # "cluster-location" |
| 2273 | # "cluster-name" |
| 2274 | # "cluster-uid" |
| 2275 | # "configure-sh" |
| 2276 | # "containerd-configure-sh" |
| 2277 | # "enable-os-login" |
| 2278 | # "gci-ensure-gke-docker" |
| 2279 | # "gci-metrics-enabled" |
| 2280 | # "gci-update-strategy" |
| 2281 | # "instance-template" |
| 2282 | # "kube-env" |
| 2283 | # "startup-script" |
| 2284 | # "user-data" |
| 2285 | # "disable-address-manager" |
| 2286 | # "windows-startup-script-ps1" |
| 2287 | # "common-psm1" |
| 2288 | # "k8s-node-setup-psm1" |
| 2289 | # "install-ssh-psm1" |
| 2290 | # "user-profile-psm1" |
| 2291 | # "serial-port-logging-enable" |
| 2292 | # |
| 2293 | # Values are free-form strings, and only have meaning as interpreted by |
| 2294 | # the image running in the instance. The only restriction placed on them is |
| 2295 | # that each value's size must be less than or equal to 32 KB. |
| 2296 | # |
| 2297 | # The total size of all keys and values must be less than 512 KB. |
| 2298 | "a_key": "A String", |
| 2299 | }, |
| 2300 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2301 | # the specified [Zonal Compute |
| 2302 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2303 | # to this node pool. |
| 2304 | # is the configuration of desired reservation which instances could take |
| 2305 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2306 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2307 | "A String", |
| 2308 | ], |
| 2309 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2310 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2311 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2312 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2313 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2314 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 2315 | # valid sources or targets for network firewalls and are specified by |
| 2316 | # the client during cluster or node pool creation. Each tag within the list |
| 2317 | # must comply with RFC1035. |
| 2318 | "A String", |
| 2319 | ], |
| 2320 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2321 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2322 | # Account is specified, the "default" service account is used. |
| 2323 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2324 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2325 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2326 | "status": "A String", # [Output only] The current status of this cluster. |
| 2327 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2328 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 2329 | # This makes same node pod to pod traffic visible for VPC network. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2330 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 2331 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 2332 | # cluster is connected. Example: |
| 2333 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 2334 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 2335 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2336 | # to which the cluster is connected. Example: |
| 2337 | # projects/my-project/global/networks/my-network |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2338 | }, |
| 2339 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 2340 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 2341 | # the following restrictions: |
| 2342 | # |
| 2343 | # * Lowercase letters, numbers, and hyphens only. |
| 2344 | # * Must start with a letter. |
| 2345 | # * Must end with a number or a letter. |
| 2346 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 2347 | # The endpoint can be accessed from the internet at |
| 2348 | # `https://username:password@endpoint/`. |
| 2349 | # |
| 2350 | # See the `masterAuth` property of this resource for username and |
| 2351 | # password information. |
| 2352 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 2353 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2354 | # or |
| 2355 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2356 | # in which the cluster resides. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2357 | }</pre> |
| 2358 | </div> |
| 2359 | |
| 2360 | <div class="method"> |
| 2361 | <code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code> |
| 2362 | <pre>Gets the public component of the cluster signing keys in |
| 2363 | JSON Web Key format. |
| 2364 | This API is not yet intended for general use, and is not available for all |
| 2365 | clusters. |
| 2366 | |
| 2367 | Args: |
| 2368 | parent: string, The cluster (project, location, cluster id) to get keys for. Specified in |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2369 | the format `projects/*/locations/*/clusters/*`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2370 | x__xgafv: string, V1 error format. |
| 2371 | Allowed values |
| 2372 | 1 - v1 error format |
| 2373 | 2 - v2 error format |
| 2374 | |
| 2375 | Returns: |
| 2376 | An object of the form: |
| 2377 | |
| 2378 | { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2379 | "cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP |
| 2380 | # Cache-Control header. |
| 2381 | "directive": "A String", # 14.9 request and response directives |
| 2382 | "age": "A String", # 14.6 response cache age, in seconds since the response is generated |
| 2383 | "expires": "A String", # 14.21 response cache expires, in RFC 1123 date format |
| 2384 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2385 | "keys": [ # The public component of the keys used by the cluster to sign token |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2386 | # requests. |
| 2387 | { # Jwk is a JSON Web Key as specified in RFC 7517 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2388 | "x": "A String", # Used for ECDSA keys. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2389 | "crv": "A String", # Used for ECDSA keys. |
| 2390 | "kid": "A String", # Key ID. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2391 | "kty": "A String", # Key Type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2392 | "e": "A String", # Used for RSA keys. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2393 | "n": "A String", # Used for RSA keys. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2394 | "alg": "A String", # Algorithm. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2395 | "use": "A String", # Permitted uses for the public keys. |
| 2396 | "y": "A String", # Used for ECDSA keys. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2397 | }, |
| 2398 | ], |
| 2399 | }</pre> |
| 2400 | </div> |
| 2401 | |
| 2402 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2403 | <code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2404 | <pre>Lists all clusters owned by a project in either the specified zone or all |
| 2405 | zones. |
| 2406 | |
| 2407 | Args: |
| 2408 | parent: string, The parent (project and location) where the clusters will be listed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2409 | Specified in the format `projects/*/locations/*`. |
| 2410 | Location "-" matches all zones and all regions. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2411 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 2412 | number](https://support.google.com/cloud/answer/6158840). |
| 2413 | This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2414 | zone: string, Deprecated. The name of the Google Compute Engine |
| 2415 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2416 | cluster resides, or "-" for all zones. This field has been deprecated and |
| 2417 | replaced by the parent field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2418 | x__xgafv: string, V1 error format. |
| 2419 | Allowed values |
| 2420 | 1 - v1 error format |
| 2421 | 2 - v2 error format |
| 2422 | |
| 2423 | Returns: |
| 2424 | An object of the form: |
| 2425 | |
| 2426 | { # ListClustersResponse is the result of ListClustersRequest. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2427 | "clusters": [ # A list of clusters in the project in the specified zone, or |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2428 | # across all ones. |
| 2429 | { # A Google Kubernetes Engine cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2430 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 2431 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2432 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 2433 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2434 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 2435 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 2436 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 2437 | # required by Cluster Autoscaler to automatically adjust |
| 2438 | # the size of the cluster and create/delete |
| 2439 | # node pools based on the current needs. |
| 2440 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 2441 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2442 | # NodePool's nodes can be created by NAP. |
| 2443 | "A String", |
| 2444 | ], |
| 2445 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 2446 | # amount of resources in the cluster. |
| 2447 | { # Contains information about amount of some resource in the cluster. |
| 2448 | # For memory, value should be in GB. |
| 2449 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 2450 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 2451 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 2452 | }, |
| 2453 | ], |
| 2454 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 2455 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 2456 | # created by NAP. |
| 2457 | # by NAP. |
| 2458 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 2459 | # node pool. |
| 2460 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2461 | # the Auto Upgrades will proceed. |
| 2462 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2463 | # with the approximate start time for the upgrades, in |
| 2464 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2465 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2466 | # with the description of the upgrade. |
| 2467 | }, |
| 2468 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 2469 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 2470 | # they fail health checks too many times, an automatic repair action will be |
| 2471 | # triggered. |
| 2472 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 2473 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 2474 | # up to date with the latest release version of Kubernetes. |
| 2475 | }, |
| 2476 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 2477 | # specified, service_account should be empty. |
| 2478 | "A String", |
| 2479 | ], |
| 2480 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 2481 | # disruption caused by an upgrade. |
| 2482 | # |
| 2483 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2484 | # unavailable. |
| 2485 | # |
| 2486 | # maxSurge controls the number of additional nodes that can be added to the |
| 2487 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2488 | # available nodes. |
| 2489 | # |
| 2490 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2491 | # nodes are being upgraded at the same time). |
| 2492 | # |
| 2493 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2494 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2495 | # this holds true. (Disruption stays within the limits of |
| 2496 | # PodDisruptionBudget, if it is configured.) |
| 2497 | # |
| 2498 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2499 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2500 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2501 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2502 | # there are always at least 4 nodes available. |
| 2503 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 2504 | # the upgrade process. A node is considered available if its status is |
| 2505 | # Ready. |
| 2506 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2507 | # of the node pool during the upgrade process. |
| 2508 | }, |
| 2509 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 2510 | # service_account is specified, scopes should be empty. |
| 2511 | }, |
| 2512 | }, |
| 2513 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 2514 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 2515 | # is sufficient for this number of instances. You must also have available |
| 2516 | # firewall and routes quota. |
| 2517 | # For requests, this field should only be used in lieu of a |
| 2518 | # "node_pool" object, since this configuration (along with the |
| 2519 | # "node_config") will be used to create a "NodePool" object with an |
| 2520 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2521 | # |
| 2522 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 2523 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 2524 | "A String", |
| 2525 | ], |
| 2526 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 2527 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 2528 | # range will be used for assigning internal IP addresses to the master or |
| 2529 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 2530 | # any other ranges in use within the cluster's network. |
| 2531 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 2532 | # given only RFC 1918 private addresses and communicate with the master via |
| 2533 | # private networking. |
| 2534 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 2535 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 2536 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 2537 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 2538 | }, |
| 2539 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 2540 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 2541 | }, |
| 2542 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 2543 | # required by Vertical Pod Autoscaler to automatically adjust |
| 2544 | # the resources of pods controlled by it. |
| 2545 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 2546 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2547 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 2548 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 2549 | # if cluster created with IP Alias support. |
| 2550 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2551 | }, |
| 2552 | "network": "A String", # The name of the Google Compute Engine |
| 2553 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2554 | # to which the cluster is connected. If left unspecified, the `default` |
| 2555 | # network will be used. |
| 2556 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 2557 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2558 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 2559 | # range. This field will only be set when cluster is in route-based network |
| 2560 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2561 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 2562 | # master authorized networks will disallow all external traffic to access |
| 2563 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 2564 | # Google Compute Engine Public IPs and Google Prod IPs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2565 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 2566 | # Kubernetes master through HTTPS. |
| 2567 | { # CidrBlock contains an optional name and one CIDR block. |
| 2568 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 2569 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 2570 | }, |
| 2571 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2572 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2573 | }, |
| 2574 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2575 | # cluster, if available. |
| 2576 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 2577 | # If unspecified, the defaults are used: |
| 2578 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 2579 | # be set to "admin", a random password will be generated, and a client |
| 2580 | # certificate will be issued. |
| 2581 | # Authentication can be done using HTTP basic auth or using client |
| 2582 | # certificates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2583 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 2584 | # Because the master endpoint is open to the Internet, you should create a |
| 2585 | # strong password. If a password is provided for cluster creation, username |
| 2586 | # must be non-empty. |
| 2587 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 2588 | # clusters before v1.12, if no configuration is specified, a client |
| 2589 | # certificate is issued. |
| 2590 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 2591 | }, |
| 2592 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 2593 | # to the cluster endpoint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2594 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 2595 | # trust for the cluster. |
| 2596 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 2597 | # authenticate to the cluster endpoint. |
| 2598 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 2599 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 2600 | # leaving username unspecified (or setting it to the empty string). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2601 | }, |
| 2602 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 2603 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 2604 | # during authentication using a group of security groups. |
| 2605 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 2606 | # if enabled = true. |
| 2607 | }, |
| 2608 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 2609 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 2610 | # cluster, enabling additional functionality. |
| 2611 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 2612 | # is enabled or not on the Master, it does not track whether network policy |
| 2613 | # is enabled for the nodes. |
| 2614 | # is enabled or not on the Master, it does not track whether network policy |
| 2615 | # is enabled for the nodes. |
| 2616 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 2617 | }, |
| 2618 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 2619 | # managed Knative service. |
| 2620 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 2621 | }, |
| 2622 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 2623 | # increases or decreases the number of replica pods a replication controller |
| 2624 | # has based on the resource usage of the existing pods. |
| 2625 | # increases or decreases the number of replica pods a replication controller |
| 2626 | # has based on the resource usage of the existing pods. |
| 2627 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 2628 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 2629 | # Monitoring. |
| 2630 | }, |
| 2631 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 2632 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 2633 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 2634 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 2635 | # When enabled, it runs a small pod in the cluster that manages the load |
| 2636 | # balancers. |
| 2637 | }, |
| 2638 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 2639 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 2640 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 2641 | # workloads and applications. For more information, see: |
| 2642 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 2643 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 2644 | }, |
| 2645 | }, |
| 2646 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 2647 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 2648 | # instead. The current version of the node software components. If they are |
| 2649 | # currently at multiple versions because they're in the process of being |
| 2650 | # upgraded, this reflects the minimum version of all nodes. |
| 2651 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 2652 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 2653 | # the cluster is connected. |
| 2654 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 2655 | # Google Compute Engine resources. |
| 2656 | "a_key": "A String", |
| 2657 | }, |
| 2658 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 2659 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2660 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 2661 | # occur in these windows. |
| 2662 | "a_key": { # Represents an arbitrary window of time. |
| 2663 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2664 | # start time. |
| 2665 | "startTime": "A String", # The time that the window first starts. |
| 2666 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2667 | }, |
| 2668 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2669 | # maintenance to occur. The time windows may be overlapping. If no |
| 2670 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2671 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 2672 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2673 | # start time. |
| 2674 | "startTime": "A String", # The time that the window first starts. |
| 2675 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2676 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2677 | # this window reccurs. They go on for the span of time between the start and |
| 2678 | # end time. |
| 2679 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2680 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2681 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 2682 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 2683 | # <code>FREQ=DAILY</code> |
| 2684 | # For the first weekend of every month: |
| 2685 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 2686 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2687 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2688 | # <code> |
| 2689 | # start time = 2019-01-01T09:00:00-0400 |
| 2690 | # end time = 2019-01-01T17:00:00-0400 |
| 2691 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 2692 | # </code> |
| 2693 | # Windows can span multiple days. Eg, to make the window encompass every |
| 2694 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 2695 | # <code> |
| 2696 | # start time = 2019-01-05T00:00:00Z |
| 2697 | # end time = 2019-01-07T23:59:00Z |
| 2698 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 2699 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2700 | # Note the start and end time's specific dates are largely arbitrary except |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2701 | # to specify duration of the window and when it first starts. |
| 2702 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2703 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2704 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 2705 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 2706 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 2707 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 2708 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 2709 | # smallest possible in the given scenario. |
| 2710 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 2711 | # format "PTnHnMnS". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2712 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2713 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2714 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 2715 | # the policy won't accidentally undo intermediate changes (and so that users |
| 2716 | # of the API unaware of some fields won't accidentally remove other fields). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2717 | # Make a <code>get()</code> request to the cluster to get the current |
| 2718 | # resource version and include it with requests to set the policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2719 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2720 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 2721 | # found in validMasterVersions returned by getServerConfig. The version can |
| 2722 | # be upgraded over time; such upgrades are reflected in |
| 2723 | # currentMasterVersion and currentNodeVersion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2724 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2725 | # Users may specify either explicit versions offered by |
| 2726 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 2727 | # |
| 2728 | # - "latest": picks the highest valid Kubernetes version |
| 2729 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 2730 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 2731 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 2732 | # - "","-": picks the default Kubernetes version |
| 2733 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2734 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2735 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 2736 | # block. The secondary range will be used for pod IP |
| 2737 | # addresses. This must be an existing secondary range associated |
| 2738 | # with the cluster subnetwork. |
| 2739 | # |
| 2740 | # This field is only applicable with use_ip_aliases is true and |
| 2741 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2742 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 2743 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2744 | # |
| 2745 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2746 | # |
| 2747 | # Set to blank to have a range chosen with the default size. |
| 2748 | # |
| 2749 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2750 | # netmask. |
| 2751 | # |
| 2752 | # Set to a |
| 2753 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2754 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2755 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2756 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2757 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2758 | # |
| 2759 | # This is applicable only if `create_subnetwork` is true. |
| 2760 | # |
| 2761 | # Set to blank to have a range chosen with the default size. |
| 2762 | # |
| 2763 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2764 | # netmask. |
| 2765 | # |
| 2766 | # Set to a |
| 2767 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2768 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2769 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2770 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2771 | "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2772 | # range will be automatically chosen with the default size. |
| 2773 | # |
| 2774 | # This field is only applicable when `use_ip_aliases` is true. |
| 2775 | # |
| 2776 | # If unspecified, the range will use the default size. |
| 2777 | # |
| 2778 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2779 | # netmask. |
| 2780 | # |
| 2781 | # Set to a |
| 2782 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2783 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2784 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2785 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2786 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 2787 | "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2788 | # CIDR block. The secondary range will be used for service |
| 2789 | # ClusterIPs. This must be an existing secondary range associated |
| 2790 | # with the cluster subnetwork. |
| 2791 | # |
| 2792 | # This field is only applicable with use_ip_aliases is true and |
| 2793 | # create_subnetwork is false. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2794 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 2795 | # |
| 2796 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2797 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 2798 | # this field is empty, then an automatic name will be chosen for the new |
| 2799 | # subnetwork. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2800 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 2801 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 2802 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 2803 | # will be automatically chosen with the default size. |
| 2804 | # |
| 2805 | # This field is only applicable when `use_ip_aliases` is true. |
| 2806 | # |
| 2807 | # Set to blank to have a range chosen with the default size. |
| 2808 | # |
| 2809 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2810 | # netmask. |
| 2811 | # |
| 2812 | # Set to a |
| 2813 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2814 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2815 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2816 | # to use. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2817 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2818 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 2819 | # mode. |
| 2820 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 2821 | # identities in the system, including service accounts, nodes, and |
| 2822 | # controllers, will have statically granted permissions beyond those |
| 2823 | # provided by the RBAC configuration or IAM. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2824 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2825 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2826 | # disabled when this config is unspecified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2827 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2828 | # daemonset will be created in the cluster to meter network egress traffic. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2829 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 2830 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2831 | # second BigQuery table will be created to hold resource consumption |
| 2832 | # records. |
| 2833 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2834 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 2835 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2836 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2837 | }, |
| 2838 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 2839 | "locations": [ # The list of Google Compute Engine |
| 2840 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2841 | # cluster's nodes should be located. |
| 2842 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2843 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2844 | "nodePools": [ # The node pools associated with this cluster. |
| 2845 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2846 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2847 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 2848 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2849 | # specification, under the control of the cluster master. They may have a set |
| 2850 | # of Kubernetes labels applied to them, which may be used to reference them |
| 2851 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 2852 | # the workload. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2853 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2854 | # node pool instance, if available. |
| 2855 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 2856 | # only if a valid configuration is present. |
| 2857 | # adjust the size of the node pool to the current cluster usage. |
| 2858 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 2859 | # has to enough quota to scale up the cluster. |
| 2860 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 2861 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 2862 | # max_node_count. |
| 2863 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 2864 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2865 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 2866 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 2867 | # is sufficient for this number of instances. You must also have available |
| 2868 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2869 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2870 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2871 | # disruption caused by an upgrade. |
| 2872 | # |
| 2873 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2874 | # unavailable. |
| 2875 | # |
| 2876 | # maxSurge controls the number of additional nodes that can be added to the |
| 2877 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2878 | # available nodes. |
| 2879 | # |
| 2880 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2881 | # nodes are being upgraded at the same time). |
| 2882 | # |
| 2883 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2884 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2885 | # this holds true. (Disruption stays within the limits of |
| 2886 | # PodDisruptionBudget, if it is configured.) |
| 2887 | # |
| 2888 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2889 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2890 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2891 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2892 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2893 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2894 | # the upgrade process. A node is considered available if its status is |
| 2895 | # Ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2896 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2897 | # of the node pool during the upgrade process. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2898 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2899 | "locations": [ # The list of Google Compute Engine |
| 2900 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2901 | # NodePool's nodes should be located. |
| 2902 | "A String", |
| 2903 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2904 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 2905 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 2906 | # associated with this node pool. |
| 2907 | "A String", |
| 2908 | ], |
| 2909 | "version": "A String", # The version of the Kubernetes of this node. |
| 2910 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 2911 | "conditions": [ # Which conditions caused the current node pool state. |
| 2912 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2913 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2914 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2915 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2916 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2917 | ], |
| 2918 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 2919 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2920 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2921 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2922 | # |
| 2923 | # The following scopes are recommended, but not required, and by default are |
| 2924 | # not included: |
| 2925 | # |
| 2926 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2927 | # persistent storage on your nodes. |
| 2928 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2929 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2930 | # (the [Google Container |
| 2931 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2932 | # |
| 2933 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2934 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2935 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2936 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2937 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2938 | # |
| 2939 | # For more information, including usage and the valid values, see: |
| 2940 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2941 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2942 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2943 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2944 | # See |
| 2945 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2946 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2947 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2948 | "value": "A String", # Value for taint. |
| 2949 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2950 | }, |
| 2951 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2952 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2953 | # These will added in addition to any default label(s) that |
| 2954 | # Kubernetes may apply to the node. |
| 2955 | # In case of conflict in label keys, the applied set may differ depending on |
| 2956 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2957 | # and conflicts should be avoided. |
| 2958 | # For more information, including usage and the valid values, see: |
| 2959 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2960 | "a_key": "A String", |
| 2961 | }, |
| 2962 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2963 | # The smallest allowed disk size is 10GB. |
| 2964 | # |
| 2965 | # If unspecified, the default disk size is 100GB. |
| 2966 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2967 | # workloads on the node pool. |
| 2968 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2969 | # on the node pool. |
| 2970 | }, |
| 2971 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2972 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2973 | # support for GPUs. |
| 2974 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2975 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2976 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2977 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2978 | }, |
| 2979 | ], |
| 2980 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 2981 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 2982 | # `n1-standard-1`). |
| 2983 | # |
| 2984 | # If unspecified, the default machine type is |
| 2985 | # `n1-standard-1`. |
| 2986 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2987 | # |
| 2988 | # If unspecified, the default disk type is 'pd-standard' |
| 2989 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2990 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 2991 | # |
| 2992 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2993 | # The attestation is performed against the integrity policy baseline. This |
| 2994 | # baseline is initially derived from the implicitly trusted boot image when |
| 2995 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2996 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2997 | # |
| 2998 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2999 | # verifying the digital signature of all boot components, and halting the |
| 3000 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3001 | }, |
| 3002 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3003 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3004 | # friendly names of CPU platforms, such as |
| 3005 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3006 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3007 | # information, read [how to specify min CPU |
| 3008 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3009 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3010 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3011 | # information about preemptible VM instances. |
| 3012 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3013 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3014 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3015 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3016 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3017 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3018 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3019 | "type": "A String", # Type of the sandbox to use for the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3020 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3021 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3022 | # |
| 3023 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3024 | # in length. These are reflected as part of a URL in the metadata server. |
| 3025 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3026 | # metadata keys for the project or be one of the reserved keys: |
| 3027 | # "cluster-location" |
| 3028 | # "cluster-name" |
| 3029 | # "cluster-uid" |
| 3030 | # "configure-sh" |
| 3031 | # "containerd-configure-sh" |
| 3032 | # "enable-os-login" |
| 3033 | # "gci-ensure-gke-docker" |
| 3034 | # "gci-metrics-enabled" |
| 3035 | # "gci-update-strategy" |
| 3036 | # "instance-template" |
| 3037 | # "kube-env" |
| 3038 | # "startup-script" |
| 3039 | # "user-data" |
| 3040 | # "disable-address-manager" |
| 3041 | # "windows-startup-script-ps1" |
| 3042 | # "common-psm1" |
| 3043 | # "k8s-node-setup-psm1" |
| 3044 | # "install-ssh-psm1" |
| 3045 | # "user-profile-psm1" |
| 3046 | # "serial-port-logging-enable" |
| 3047 | # |
| 3048 | # Values are free-form strings, and only have meaning as interpreted by |
| 3049 | # the image running in the instance. The only restriction placed on them is |
| 3050 | # that each value's size must be less than or equal to 32 KB. |
| 3051 | # |
| 3052 | # The total size of all keys and values must be less than 512 KB. |
| 3053 | "a_key": "A String", |
| 3054 | }, |
| 3055 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3056 | # the specified [Zonal Compute |
| 3057 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3058 | # to this node pool. |
| 3059 | # is the configuration of desired reservation which instances could take |
| 3060 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3061 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3062 | "A String", |
| 3063 | ], |
| 3064 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3065 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3066 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3067 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3068 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3069 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3070 | # valid sources or targets for network firewalls and are specified by |
| 3071 | # the client during cluster or node pool creation. Each tag within the list |
| 3072 | # must comply with RFC1035. |
| 3073 | "A String", |
| 3074 | ], |
| 3075 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3076 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3077 | # Account is specified, the "default" service account is used. |
| 3078 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3079 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3080 | }, |
| 3081 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 3082 | # simultaneously on a node in the node pool. |
| 3083 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 3084 | }, |
| 3085 | "name": "A String", # The name of the node pool. |
| 3086 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 3087 | # node pool. |
| 3088 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3089 | # the Auto Upgrades will proceed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3090 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3091 | # with the approximate start time for the upgrades, in |
| 3092 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3093 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3094 | # with the description of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3095 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3096 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 3097 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 3098 | # they fail health checks too many times, an automatic repair action will be |
| 3099 | # triggered. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3100 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 3101 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 3102 | # up to date with the latest release version of Kubernetes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3103 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3104 | }, |
| 3105 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3106 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3107 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 3108 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 3109 | "provider": "A String", # The selected network policy provider. |
| 3110 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 3111 | }, |
| 3112 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 3113 | # this cluster, in |
| 3114 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3115 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 3116 | # typically put in the last `/16` from the container CIDR. |
| 3117 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 3118 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 3119 | # the kubernetes version of the master and nodes. |
| 3120 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 3121 | # Alpha enabled clusters are automatically deleted thirty days after |
| 3122 | # creation. |
| 3123 | "description": "A String", # An optional description of this cluster. |
| 3124 | "conditions": [ # Which conditions caused the current cluster state. |
| 3125 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3126 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3127 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3128 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3129 | }, |
| 3130 | ], |
| 3131 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 3132 | # Call Kubernetes API directly to retrieve node information. |
| 3133 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3134 | # Currently available options: |
| 3135 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3136 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3137 | # service with a Kubernetes-native resource model |
| 3138 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 3139 | # longer available as of GKE 1.15). |
| 3140 | # * `none` - No metrics will be exported from the cluster. |
| 3141 | # |
| 3142 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 3143 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3144 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 3145 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 3146 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 3147 | "state": "A String", # Denotes the state of etcd encryption. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3148 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3149 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 3150 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 3151 | # images will be validated by Binary Authorization. |
| 3152 | }, |
| 3153 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 3154 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3155 | # notation (e.g. `1.2.3.4/29`). |
| 3156 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 3157 | # policies. |
| 3158 | # policies. |
| 3159 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 3160 | }, |
| 3161 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 3162 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3163 | # cluster resides. This field is deprecated, use location instead. |
| 3164 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 3165 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3166 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3167 | # Currently available options: |
| 3168 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3169 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3170 | # service with a Kubernetes-native resource model |
| 3171 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3172 | # available as of GKE 1.15). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3173 | # * `none` - no logs will be exported from the cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3174 | # |
| 3175 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3176 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3177 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3178 | # For requests, this field should only be used in lieu of a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3179 | # "node_pool" object, since this configuration (along with the |
| 3180 | # "initial_node_count") will be used to create a "NodePool" object with an |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3181 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3182 | # For responses, this field will be populated with the node configuration of |
| 3183 | # the first node pool. (For configuration of each node pool, see |
| 3184 | # `node_pool.config`) |
| 3185 | # |
| 3186 | # If unspecified, the defaults are used. |
| 3187 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3188 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3189 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3190 | # |
| 3191 | # The following scopes are recommended, but not required, and by default are |
| 3192 | # not included: |
| 3193 | # |
| 3194 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3195 | # persistent storage on your nodes. |
| 3196 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3197 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3198 | # (the [Google Container |
| 3199 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3200 | # |
| 3201 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3202 | # Monitoring are enabled, in which case their required scopes will be added. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3203 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3204 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3205 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3206 | # |
| 3207 | # For more information, including usage and the valid values, see: |
| 3208 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3209 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3210 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3211 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3212 | # See |
| 3213 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3214 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3215 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3216 | "value": "A String", # Value for taint. |
| 3217 | "key": "A String", # Key for taint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3218 | }, |
| 3219 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3220 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3221 | # These will added in addition to any default label(s) that |
| 3222 | # Kubernetes may apply to the node. |
| 3223 | # In case of conflict in label keys, the applied set may differ depending on |
| 3224 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3225 | # and conflicts should be avoided. |
| 3226 | # For more information, including usage and the valid values, see: |
| 3227 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3228 | "a_key": "A String", |
| 3229 | }, |
| 3230 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3231 | # The smallest allowed disk size is 10GB. |
| 3232 | # |
| 3233 | # If unspecified, the default disk size is 100GB. |
| 3234 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3235 | # workloads on the node pool. |
| 3236 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3237 | # on the node pool. |
| 3238 | }, |
| 3239 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3240 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3241 | # support for GPUs. |
| 3242 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3243 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3244 | # [here](https://cloud.google.com/compute/docs/gpus) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3245 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3246 | }, |
| 3247 | ], |
| 3248 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 3249 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 3250 | # `n1-standard-1`). |
| 3251 | # |
| 3252 | # If unspecified, the default machine type is |
| 3253 | # `n1-standard-1`. |
| 3254 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3255 | # |
| 3256 | # If unspecified, the default disk type is 'pd-standard' |
| 3257 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3258 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 3259 | # |
| 3260 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3261 | # The attestation is performed against the integrity policy baseline. This |
| 3262 | # baseline is initially derived from the implicitly trusted boot image when |
| 3263 | # the instance is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3264 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3265 | # |
| 3266 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3267 | # verifying the digital signature of all boot components, and halting the |
| 3268 | # boot process if signature verification fails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3269 | }, |
| 3270 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3271 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3272 | # friendly names of CPU platforms, such as |
| 3273 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3274 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3275 | # information, read [how to specify min CPU |
| 3276 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3277 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3278 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3279 | # information about preemptible VM instances. |
| 3280 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3281 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3282 | # The limit for this value is dependent upon the maximum number of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3283 | # disks available on a machine per zone. See: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3284 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3285 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3286 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3287 | "type": "A String", # Type of the sandbox to use for the node. |
| 3288 | }, |
| 3289 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3290 | # |
| 3291 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3292 | # in length. These are reflected as part of a URL in the metadata server. |
| 3293 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3294 | # metadata keys for the project or be one of the reserved keys: |
| 3295 | # "cluster-location" |
| 3296 | # "cluster-name" |
| 3297 | # "cluster-uid" |
| 3298 | # "configure-sh" |
| 3299 | # "containerd-configure-sh" |
| 3300 | # "enable-os-login" |
| 3301 | # "gci-ensure-gke-docker" |
| 3302 | # "gci-metrics-enabled" |
| 3303 | # "gci-update-strategy" |
| 3304 | # "instance-template" |
| 3305 | # "kube-env" |
| 3306 | # "startup-script" |
| 3307 | # "user-data" |
| 3308 | # "disable-address-manager" |
| 3309 | # "windows-startup-script-ps1" |
| 3310 | # "common-psm1" |
| 3311 | # "k8s-node-setup-psm1" |
| 3312 | # "install-ssh-psm1" |
| 3313 | # "user-profile-psm1" |
| 3314 | # "serial-port-logging-enable" |
| 3315 | # |
| 3316 | # Values are free-form strings, and only have meaning as interpreted by |
| 3317 | # the image running in the instance. The only restriction placed on them is |
| 3318 | # that each value's size must be less than or equal to 32 KB. |
| 3319 | # |
| 3320 | # The total size of all keys and values must be less than 512 KB. |
| 3321 | "a_key": "A String", |
| 3322 | }, |
| 3323 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3324 | # the specified [Zonal Compute |
| 3325 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3326 | # to this node pool. |
| 3327 | # is the configuration of desired reservation which instances could take |
| 3328 | # capacity from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3329 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3330 | "A String", |
| 3331 | ], |
| 3332 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3333 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3334 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3335 | # the key and specify the name of your reservation as its value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3336 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3337 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3338 | # valid sources or targets for network firewalls and are specified by |
| 3339 | # the client during cluster or node pool creation. Each tag within the list |
| 3340 | # must comply with RFC1035. |
| 3341 | "A String", |
| 3342 | ], |
| 3343 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3344 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3345 | # Account is specified, the "default" service account is used. |
| 3346 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3347 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3348 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3349 | "status": "A String", # [Output only] The current status of this cluster. |
| 3350 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3351 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 3352 | # This makes same node pod to pod traffic visible for VPC network. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3353 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 3354 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 3355 | # cluster is connected. Example: |
| 3356 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 3357 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 3358 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 3359 | # to which the cluster is connected. Example: |
| 3360 | # projects/my-project/global/networks/my-network |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3361 | }, |
| 3362 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 3363 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 3364 | # the following restrictions: |
| 3365 | # |
| 3366 | # * Lowercase letters, numbers, and hyphens only. |
| 3367 | # * Must start with a letter. |
| 3368 | # * Must end with a number or a letter. |
| 3369 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 3370 | # The endpoint can be accessed from the internet at |
| 3371 | # `https://username:password@endpoint/`. |
| 3372 | # |
| 3373 | # See the `masterAuth` property of this resource for username and |
| 3374 | # password information. |
| 3375 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 3376 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3377 | # or |
| 3378 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3379 | # in which the cluster resides. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3380 | }, |
| 3381 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3382 | "missingZones": [ # If any zones are listed here, the list of clusters returned |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3383 | # may be missing those zones. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3384 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3385 | ], |
| 3386 | }</pre> |
| 3387 | </div> |
| 3388 | |
| 3389 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3390 | <code class="details" id="setAddons">setAddons(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3391 | <pre>Sets the addons for a specific cluster. |
| 3392 | |
| 3393 | Args: |
| 3394 | name: string, The name (project, location, cluster) of the cluster to set addons. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3395 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3396 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3397 | The object takes the form of: |
| 3398 | |
| 3399 | { # SetAddonsConfigRequest sets the addons associated with the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3400 | "name": "A String", # The name (project, location, cluster) of the cluster to set addons. |
| 3401 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3402 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3403 | # number](https://support.google.com/cloud/answer/6158840). |
| 3404 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3405 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3406 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3407 | # cluster resides. This field has been deprecated and replaced by the name |
| 3408 | # field. |
| 3409 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3410 | # This field has been deprecated and replaced by the name field. |
| 3411 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Required. The desired configurations for the various addons available to run in the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3412 | # cluster. |
| 3413 | # cluster, enabling additional functionality. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3414 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 3415 | # is enabled or not on the Master, it does not track whether network policy |
| 3416 | # is enabled for the nodes. |
| 3417 | # is enabled or not on the Master, it does not track whether network policy |
| 3418 | # is enabled for the nodes. |
| 3419 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 3420 | }, |
| 3421 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 3422 | # managed Knative service. |
| 3423 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 3424 | }, |
| 3425 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 3426 | # increases or decreases the number of replica pods a replication controller |
| 3427 | # has based on the resource usage of the existing pods. |
| 3428 | # increases or decreases the number of replica pods a replication controller |
| 3429 | # has based on the resource usage of the existing pods. |
| 3430 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 3431 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 3432 | # Monitoring. |
| 3433 | }, |
| 3434 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3435 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 3436 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3437 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3438 | # When enabled, it runs a small pod in the cluster that manages the load |
| 3439 | # balancers. |
| 3440 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3441 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3442 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 3443 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 3444 | # workloads and applications. For more information, see: |
| 3445 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3446 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3447 | }, |
| 3448 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3449 | } |
| 3450 | |
| 3451 | x__xgafv: string, V1 error format. |
| 3452 | Allowed values |
| 3453 | 1 - v1 error format |
| 3454 | 2 - v2 error format |
| 3455 | |
| 3456 | Returns: |
| 3457 | An object of the form: |
| 3458 | |
| 3459 | { # This operation resource represents operations that may have happened or are |
| 3460 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3461 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3462 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3463 | # (e.g., ERROR or DEGRADED). |
| 3464 | "code": "A String", # Machine-friendly representation of the condition |
| 3465 | "message": "A String", # Human-friendly representation of the condition |
| 3466 | }, |
| 3467 | ], |
| 3468 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3469 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3470 | # Unset for single-stage operations. |
| 3471 | "stages": [ # Substages of an operation or a stage. |
| 3472 | # Object with schema name: OperationProgress |
| 3473 | ], |
| 3474 | "metrics": [ # Progress metric bundle, for example: |
| 3475 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3476 | # {name: "nodes total", int_value: 32}] |
| 3477 | # or |
| 3478 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3479 | # {name: "progress scale", double_value: 1.0}] |
| 3480 | { # Progress metric is (string, int|float|string) pair. |
| 3481 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3482 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3483 | "intValue": "A String", # For metrics with integer value. |
| 3484 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3485 | }, |
| 3486 | ], |
| 3487 | "status": "A String", # Status of an operation stage. |
| 3488 | # Unset for single-stage operations. |
| 3489 | }, |
| 3490 | "zone": "A String", # The name of the Google Compute Engine |
| 3491 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3492 | # operation is taking place. This field is deprecated, use location instead. |
| 3493 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3494 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3495 | "detail": "A String", # Detailed operation progress, if available. |
| 3496 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3497 | "operationType": "A String", # The operation type. |
| 3498 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3499 | "name": "A String", # The server-assigned ID for the operation. |
| 3500 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3501 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3502 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3503 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3504 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3505 | }, |
| 3506 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3507 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3508 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3509 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3510 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3511 | # or |
| 3512 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3513 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3514 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3515 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3516 | }</pre> |
| 3517 | </div> |
| 3518 | |
| 3519 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3520 | <code class="details" id="setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3521 | <pre>Enables or disables the ABAC authorization mechanism on a cluster. |
| 3522 | |
| 3523 | Args: |
| 3524 | name: string, The name (project, location, cluster id) of the cluster to set legacy abac. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3525 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3526 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3527 | The object takes the form of: |
| 3528 | |
| 3529 | { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for |
| 3530 | # a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3531 | "clusterId": "A String", # Deprecated. The name of the cluster to update. |
| 3532 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3533 | "name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. |
| 3534 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3535 | "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. |
| 3536 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3537 | # number](https://support.google.com/cloud/answer/6158840). |
| 3538 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3539 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3540 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3541 | # cluster resides. This field has been deprecated and replaced by the name |
| 3542 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3543 | } |
| 3544 | |
| 3545 | x__xgafv: string, V1 error format. |
| 3546 | Allowed values |
| 3547 | 1 - v1 error format |
| 3548 | 2 - v2 error format |
| 3549 | |
| 3550 | Returns: |
| 3551 | An object of the form: |
| 3552 | |
| 3553 | { # This operation resource represents operations that may have happened or are |
| 3554 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3555 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3556 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3557 | # (e.g., ERROR or DEGRADED). |
| 3558 | "code": "A String", # Machine-friendly representation of the condition |
| 3559 | "message": "A String", # Human-friendly representation of the condition |
| 3560 | }, |
| 3561 | ], |
| 3562 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3563 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3564 | # Unset for single-stage operations. |
| 3565 | "stages": [ # Substages of an operation or a stage. |
| 3566 | # Object with schema name: OperationProgress |
| 3567 | ], |
| 3568 | "metrics": [ # Progress metric bundle, for example: |
| 3569 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3570 | # {name: "nodes total", int_value: 32}] |
| 3571 | # or |
| 3572 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3573 | # {name: "progress scale", double_value: 1.0}] |
| 3574 | { # Progress metric is (string, int|float|string) pair. |
| 3575 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3576 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3577 | "intValue": "A String", # For metrics with integer value. |
| 3578 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3579 | }, |
| 3580 | ], |
| 3581 | "status": "A String", # Status of an operation stage. |
| 3582 | # Unset for single-stage operations. |
| 3583 | }, |
| 3584 | "zone": "A String", # The name of the Google Compute Engine |
| 3585 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3586 | # operation is taking place. This field is deprecated, use location instead. |
| 3587 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3588 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3589 | "detail": "A String", # Detailed operation progress, if available. |
| 3590 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3591 | "operationType": "A String", # The operation type. |
| 3592 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3593 | "name": "A String", # The server-assigned ID for the operation. |
| 3594 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3595 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3596 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3597 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3598 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3599 | }, |
| 3600 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3601 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3602 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3603 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3604 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3605 | # or |
| 3606 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3607 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3608 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3609 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3610 | }</pre> |
| 3611 | </div> |
| 3612 | |
| 3613 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3614 | <code class="details" id="setLocations">setLocations(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3615 | <pre>Sets the locations for a specific cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3616 | Deprecated. Use |
| 3617 | [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) |
| 3618 | instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3619 | |
| 3620 | Args: |
| 3621 | name: string, The name (project, location, cluster) of the cluster to set locations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3622 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3623 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3624 | The object takes the form of: |
| 3625 | |
| 3626 | { # SetLocationsRequest sets the locations of the cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3627 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3628 | # This field has been deprecated and replaced by the name field. |
| 3629 | "name": "A String", # The name (project, location, cluster) of the cluster to set locations. |
| 3630 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3631 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3632 | # number](https://support.google.com/cloud/answer/6158840). |
| 3633 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3634 | "locations": [ # Required. The desired list of Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3635 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3636 | # cluster's nodes should be located. Changing the locations a cluster is in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3637 | # will result in nodes being either created or removed from the cluster, |
| 3638 | # depending on whether locations are being added or removed. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3639 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3640 | # This list must always include the cluster's primary zone. |
| 3641 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3642 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3643 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3644 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3645 | # cluster resides. This field has been deprecated and replaced by the name |
| 3646 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3647 | } |
| 3648 | |
| 3649 | x__xgafv: string, V1 error format. |
| 3650 | Allowed values |
| 3651 | 1 - v1 error format |
| 3652 | 2 - v2 error format |
| 3653 | |
| 3654 | Returns: |
| 3655 | An object of the form: |
| 3656 | |
| 3657 | { # This operation resource represents operations that may have happened or are |
| 3658 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3659 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3660 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3661 | # (e.g., ERROR or DEGRADED). |
| 3662 | "code": "A String", # Machine-friendly representation of the condition |
| 3663 | "message": "A String", # Human-friendly representation of the condition |
| 3664 | }, |
| 3665 | ], |
| 3666 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3667 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3668 | # Unset for single-stage operations. |
| 3669 | "stages": [ # Substages of an operation or a stage. |
| 3670 | # Object with schema name: OperationProgress |
| 3671 | ], |
| 3672 | "metrics": [ # Progress metric bundle, for example: |
| 3673 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3674 | # {name: "nodes total", int_value: 32}] |
| 3675 | # or |
| 3676 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3677 | # {name: "progress scale", double_value: 1.0}] |
| 3678 | { # Progress metric is (string, int|float|string) pair. |
| 3679 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3680 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3681 | "intValue": "A String", # For metrics with integer value. |
| 3682 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3683 | }, |
| 3684 | ], |
| 3685 | "status": "A String", # Status of an operation stage. |
| 3686 | # Unset for single-stage operations. |
| 3687 | }, |
| 3688 | "zone": "A String", # The name of the Google Compute Engine |
| 3689 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3690 | # operation is taking place. This field is deprecated, use location instead. |
| 3691 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3692 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3693 | "detail": "A String", # Detailed operation progress, if available. |
| 3694 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3695 | "operationType": "A String", # The operation type. |
| 3696 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3697 | "name": "A String", # The server-assigned ID for the operation. |
| 3698 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3699 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3700 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3701 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3702 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3703 | }, |
| 3704 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3705 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3706 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3707 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3708 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3709 | # or |
| 3710 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3711 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3712 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3713 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3714 | }</pre> |
| 3715 | </div> |
| 3716 | |
| 3717 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3718 | <code class="details" id="setLogging">setLogging(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3719 | <pre>Sets the logging service for a specific cluster. |
| 3720 | |
| 3721 | Args: |
| 3722 | name: string, The name (project, location, cluster) of the cluster to set logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3723 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3724 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3725 | The object takes the form of: |
| 3726 | |
| 3727 | { # SetLoggingServiceRequest sets the logging service of a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3728 | "name": "A String", # The name (project, location, cluster) of the cluster to set logging. |
| 3729 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3730 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3731 | # number](https://support.google.com/cloud/answer/6158840). |
| 3732 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3733 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3734 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3735 | # cluster resides. This field has been deprecated and replaced by the name |
| 3736 | # field. |
| 3737 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3738 | # This field has been deprecated and replaced by the name field. |
| 3739 | "loggingService": "A String", # Required. The logging service the cluster should use to write logs. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3740 | # Currently available options: |
| 3741 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3742 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3743 | # service with a Kubernetes-native resource model |
| 3744 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3745 | # available as of GKE 1.15). |
| 3746 | # * `none` - no logs will be exported from the cluster. |
| 3747 | # |
| 3748 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3749 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3750 | } |
| 3751 | |
| 3752 | x__xgafv: string, V1 error format. |
| 3753 | Allowed values |
| 3754 | 1 - v1 error format |
| 3755 | 2 - v2 error format |
| 3756 | |
| 3757 | Returns: |
| 3758 | An object of the form: |
| 3759 | |
| 3760 | { # This operation resource represents operations that may have happened or are |
| 3761 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3762 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3763 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3764 | # (e.g., ERROR or DEGRADED). |
| 3765 | "code": "A String", # Machine-friendly representation of the condition |
| 3766 | "message": "A String", # Human-friendly representation of the condition |
| 3767 | }, |
| 3768 | ], |
| 3769 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3770 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3771 | # Unset for single-stage operations. |
| 3772 | "stages": [ # Substages of an operation or a stage. |
| 3773 | # Object with schema name: OperationProgress |
| 3774 | ], |
| 3775 | "metrics": [ # Progress metric bundle, for example: |
| 3776 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3777 | # {name: "nodes total", int_value: 32}] |
| 3778 | # or |
| 3779 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3780 | # {name: "progress scale", double_value: 1.0}] |
| 3781 | { # Progress metric is (string, int|float|string) pair. |
| 3782 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3783 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3784 | "intValue": "A String", # For metrics with integer value. |
| 3785 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3786 | }, |
| 3787 | ], |
| 3788 | "status": "A String", # Status of an operation stage. |
| 3789 | # Unset for single-stage operations. |
| 3790 | }, |
| 3791 | "zone": "A String", # The name of the Google Compute Engine |
| 3792 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3793 | # operation is taking place. This field is deprecated, use location instead. |
| 3794 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3795 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3796 | "detail": "A String", # Detailed operation progress, if available. |
| 3797 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3798 | "operationType": "A String", # The operation type. |
| 3799 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3800 | "name": "A String", # The server-assigned ID for the operation. |
| 3801 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3802 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3803 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3804 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3805 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3806 | }, |
| 3807 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3808 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3809 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3810 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3811 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3812 | # or |
| 3813 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3814 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3815 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3816 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3817 | }</pre> |
| 3818 | </div> |
| 3819 | |
| 3820 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3821 | <code class="details" id="setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3822 | <pre>Sets the maintenance policy for a cluster. |
| 3823 | |
| 3824 | Args: |
| 3825 | name: string, The name (project, location, cluster id) of the cluster to set maintenance |
| 3826 | policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3827 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3828 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3829 | The object takes the form of: |
| 3830 | |
| 3831 | { # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3832 | "name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance |
| 3833 | # policy. |
| 3834 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3835 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3836 | # clears the existing maintenance policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3837 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3838 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 3839 | # occur in these windows. |
| 3840 | "a_key": { # Represents an arbitrary window of time. |
| 3841 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 3842 | # start time. |
| 3843 | "startTime": "A String", # The time that the window first starts. |
| 3844 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3845 | }, |
| 3846 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3847 | # maintenance to occur. The time windows may be overlapping. If no |
| 3848 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3849 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 3850 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 3851 | # start time. |
| 3852 | "startTime": "A String", # The time that the window first starts. |
| 3853 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3854 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3855 | # this window reccurs. They go on for the span of time between the start and |
| 3856 | # end time. |
| 3857 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3858 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3859 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 3860 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 3861 | # <code>FREQ=DAILY</code> |
| 3862 | # For the first weekend of every month: |
| 3863 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 3864 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3865 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3866 | # <code> |
| 3867 | # start time = 2019-01-01T09:00:00-0400 |
| 3868 | # end time = 2019-01-01T17:00:00-0400 |
| 3869 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 3870 | # </code> |
| 3871 | # Windows can span multiple days. Eg, to make the window encompass every |
| 3872 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 3873 | # <code> |
| 3874 | # start time = 2019-01-05T00:00:00Z |
| 3875 | # end time = 2019-01-07T23:59:00Z |
| 3876 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 3877 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3878 | # Note the start and end time's specific dates are largely arbitrary except |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3879 | # to specify duration of the window and when it first starts. |
| 3880 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3881 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3882 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 3883 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 3884 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 3885 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 3886 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 3887 | # smallest possible in the given scenario. |
| 3888 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 3889 | # format "PTnHnMnS". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3890 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3891 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3892 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 3893 | # the policy won't accidentally undo intermediate changes (and so that users |
| 3894 | # of the API unaware of some fields won't accidentally remove other fields). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3895 | # Make a <code>get()</code> request to the cluster to get the current |
| 3896 | # resource version and include it with requests to set the policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3897 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3898 | "projectId": "A String", # Required. The Google Developers Console [project ID or project |
| 3899 | # number](https://support.google.com/cloud/answer/6158840). |
| 3900 | "zone": "A String", # Required. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3901 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3902 | # cluster resides. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3903 | "clusterId": "A String", # Required. The name of the cluster to update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3904 | } |
| 3905 | |
| 3906 | x__xgafv: string, V1 error format. |
| 3907 | Allowed values |
| 3908 | 1 - v1 error format |
| 3909 | 2 - v2 error format |
| 3910 | |
| 3911 | Returns: |
| 3912 | An object of the form: |
| 3913 | |
| 3914 | { # This operation resource represents operations that may have happened or are |
| 3915 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3916 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3917 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3918 | # (e.g., ERROR or DEGRADED). |
| 3919 | "code": "A String", # Machine-friendly representation of the condition |
| 3920 | "message": "A String", # Human-friendly representation of the condition |
| 3921 | }, |
| 3922 | ], |
| 3923 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3924 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3925 | # Unset for single-stage operations. |
| 3926 | "stages": [ # Substages of an operation or a stage. |
| 3927 | # Object with schema name: OperationProgress |
| 3928 | ], |
| 3929 | "metrics": [ # Progress metric bundle, for example: |
| 3930 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3931 | # {name: "nodes total", int_value: 32}] |
| 3932 | # or |
| 3933 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3934 | # {name: "progress scale", double_value: 1.0}] |
| 3935 | { # Progress metric is (string, int|float|string) pair. |
| 3936 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3937 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3938 | "intValue": "A String", # For metrics with integer value. |
| 3939 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3940 | }, |
| 3941 | ], |
| 3942 | "status": "A String", # Status of an operation stage. |
| 3943 | # Unset for single-stage operations. |
| 3944 | }, |
| 3945 | "zone": "A String", # The name of the Google Compute Engine |
| 3946 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3947 | # operation is taking place. This field is deprecated, use location instead. |
| 3948 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3949 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3950 | "detail": "A String", # Detailed operation progress, if available. |
| 3951 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3952 | "operationType": "A String", # The operation type. |
| 3953 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3954 | "name": "A String", # The server-assigned ID for the operation. |
| 3955 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3956 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3957 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3958 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3959 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3960 | }, |
| 3961 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3962 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3963 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3964 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3965 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3966 | # or |
| 3967 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3968 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3969 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3970 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3971 | }</pre> |
| 3972 | </div> |
| 3973 | |
| 3974 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3975 | <code class="details" id="setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3976 | <pre>Sets master auth materials. Currently supports changing the admin password |
| 3977 | or a specific cluster, either via password generation or explicitly setting |
| 3978 | the password. |
| 3979 | |
| 3980 | Args: |
| 3981 | name: string, The name (project, location, cluster) of the cluster to set auth. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3982 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3983 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3984 | The object takes the form of: |
| 3985 | |
| 3986 | { # SetMasterAuthRequest updates the admin password of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3987 | "name": "A String", # The name (project, location, cluster) of the cluster to set auth. |
| 3988 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3989 | "action": "A String", # Required. The exact form of action to be taken on the master auth. |
| 3990 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3991 | # number](https://support.google.com/cloud/answer/6158840). |
| 3992 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3993 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3994 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3995 | "update": { # The authentication information for accessing the master endpoint. # Required. A description of the update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3996 | # Authentication can be done using HTTP basic auth or using client |
| 3997 | # certificates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3998 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3999 | # Because the master endpoint is open to the Internet, you should create a |
| 4000 | # strong password. If a password is provided for cluster creation, username |
| 4001 | # must be non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4002 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4003 | # clusters before v1.12, if no configuration is specified, a client |
| 4004 | # certificate is issued. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4005 | "issueClientCertificate": True or False, # Issue a client certificate. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4006 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4007 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 4008 | # to the cluster endpoint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4009 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 4010 | # trust for the cluster. |
| 4011 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 4012 | # authenticate to the cluster endpoint. |
| 4013 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 4014 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 4015 | # leaving username unspecified (or setting it to the empty string). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4016 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4017 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4018 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4019 | # cluster resides. This field has been deprecated and replaced by the name |
| 4020 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4021 | } |
| 4022 | |
| 4023 | x__xgafv: string, V1 error format. |
| 4024 | Allowed values |
| 4025 | 1 - v1 error format |
| 4026 | 2 - v2 error format |
| 4027 | |
| 4028 | Returns: |
| 4029 | An object of the form: |
| 4030 | |
| 4031 | { # This operation resource represents operations that may have happened or are |
| 4032 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4033 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4034 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4035 | # (e.g., ERROR or DEGRADED). |
| 4036 | "code": "A String", # Machine-friendly representation of the condition |
| 4037 | "message": "A String", # Human-friendly representation of the condition |
| 4038 | }, |
| 4039 | ], |
| 4040 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4041 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4042 | # Unset for single-stage operations. |
| 4043 | "stages": [ # Substages of an operation or a stage. |
| 4044 | # Object with schema name: OperationProgress |
| 4045 | ], |
| 4046 | "metrics": [ # Progress metric bundle, for example: |
| 4047 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4048 | # {name: "nodes total", int_value: 32}] |
| 4049 | # or |
| 4050 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4051 | # {name: "progress scale", double_value: 1.0}] |
| 4052 | { # Progress metric is (string, int|float|string) pair. |
| 4053 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4054 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4055 | "intValue": "A String", # For metrics with integer value. |
| 4056 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4057 | }, |
| 4058 | ], |
| 4059 | "status": "A String", # Status of an operation stage. |
| 4060 | # Unset for single-stage operations. |
| 4061 | }, |
| 4062 | "zone": "A String", # The name of the Google Compute Engine |
| 4063 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4064 | # operation is taking place. This field is deprecated, use location instead. |
| 4065 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4066 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4067 | "detail": "A String", # Detailed operation progress, if available. |
| 4068 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4069 | "operationType": "A String", # The operation type. |
| 4070 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4071 | "name": "A String", # The server-assigned ID for the operation. |
| 4072 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4073 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4074 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4075 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4076 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4077 | }, |
| 4078 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4079 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4080 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4081 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4082 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4083 | # or |
| 4084 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4085 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4086 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4087 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4088 | }</pre> |
| 4089 | </div> |
| 4090 | |
| 4091 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4092 | <code class="details" id="setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4093 | <pre>Sets the monitoring service for a specific cluster. |
| 4094 | |
| 4095 | Args: |
| 4096 | name: string, The name (project, location, cluster) of the cluster to set monitoring. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4097 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4098 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4099 | The object takes the form of: |
| 4100 | |
| 4101 | { # SetMonitoringServiceRequest sets the monitoring service of a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4102 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 4103 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4104 | "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4105 | # Currently available options: |
| 4106 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4107 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4108 | # service with a Kubernetes-native resource model |
| 4109 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 4110 | # longer available as of GKE 1.15). |
| 4111 | # * `none` - No metrics will be exported from the cluster. |
| 4112 | # |
| 4113 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 4114 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4115 | "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. |
| 4116 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4117 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4118 | # number](https://support.google.com/cloud/answer/6158840). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4119 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4120 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4121 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4122 | # cluster resides. This field has been deprecated and replaced by the name |
| 4123 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4124 | } |
| 4125 | |
| 4126 | x__xgafv: string, V1 error format. |
| 4127 | Allowed values |
| 4128 | 1 - v1 error format |
| 4129 | 2 - v2 error format |
| 4130 | |
| 4131 | Returns: |
| 4132 | An object of the form: |
| 4133 | |
| 4134 | { # This operation resource represents operations that may have happened or are |
| 4135 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4136 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4137 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4138 | # (e.g., ERROR or DEGRADED). |
| 4139 | "code": "A String", # Machine-friendly representation of the condition |
| 4140 | "message": "A String", # Human-friendly representation of the condition |
| 4141 | }, |
| 4142 | ], |
| 4143 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4144 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4145 | # Unset for single-stage operations. |
| 4146 | "stages": [ # Substages of an operation or a stage. |
| 4147 | # Object with schema name: OperationProgress |
| 4148 | ], |
| 4149 | "metrics": [ # Progress metric bundle, for example: |
| 4150 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4151 | # {name: "nodes total", int_value: 32}] |
| 4152 | # or |
| 4153 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4154 | # {name: "progress scale", double_value: 1.0}] |
| 4155 | { # Progress metric is (string, int|float|string) pair. |
| 4156 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4157 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4158 | "intValue": "A String", # For metrics with integer value. |
| 4159 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4160 | }, |
| 4161 | ], |
| 4162 | "status": "A String", # Status of an operation stage. |
| 4163 | # Unset for single-stage operations. |
| 4164 | }, |
| 4165 | "zone": "A String", # The name of the Google Compute Engine |
| 4166 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4167 | # operation is taking place. This field is deprecated, use location instead. |
| 4168 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4169 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4170 | "detail": "A String", # Detailed operation progress, if available. |
| 4171 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4172 | "operationType": "A String", # The operation type. |
| 4173 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4174 | "name": "A String", # The server-assigned ID for the operation. |
| 4175 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4176 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4177 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4178 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4179 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4180 | }, |
| 4181 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4182 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4183 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4184 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4185 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4186 | # or |
| 4187 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4188 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4189 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4190 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4191 | }</pre> |
| 4192 | </div> |
| 4193 | |
| 4194 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4195 | <code class="details" id="setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4196 | <pre>Enables or disables Network Policy for a cluster. |
| 4197 | |
| 4198 | Args: |
| 4199 | name: string, The name (project, location, cluster id) of the cluster to set networking |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4200 | policy. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4201 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4202 | The object takes the form of: |
| 4203 | |
| 4204 | { # SetNetworkPolicyRequest enables/disables network policy for a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4205 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4206 | # This field has been deprecated and replaced by the name field. |
| 4207 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature. |
| 4208 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 4209 | "provider": "A String", # The selected network policy provider. |
| 4210 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 4211 | }, |
| 4212 | "name": "A String", # The name (project, location, cluster id) of the cluster to set networking |
| 4213 | # policy. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4214 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4215 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4216 | # This field has been deprecated and replaced by the name field. |
| 4217 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4218 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4219 | # cluster resides. This field has been deprecated and replaced by the name |
| 4220 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4221 | } |
| 4222 | |
| 4223 | x__xgafv: string, V1 error format. |
| 4224 | Allowed values |
| 4225 | 1 - v1 error format |
| 4226 | 2 - v2 error format |
| 4227 | |
| 4228 | Returns: |
| 4229 | An object of the form: |
| 4230 | |
| 4231 | { # This operation resource represents operations that may have happened or are |
| 4232 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4233 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4234 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4235 | # (e.g., ERROR or DEGRADED). |
| 4236 | "code": "A String", # Machine-friendly representation of the condition |
| 4237 | "message": "A String", # Human-friendly representation of the condition |
| 4238 | }, |
| 4239 | ], |
| 4240 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4241 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4242 | # Unset for single-stage operations. |
| 4243 | "stages": [ # Substages of an operation or a stage. |
| 4244 | # Object with schema name: OperationProgress |
| 4245 | ], |
| 4246 | "metrics": [ # Progress metric bundle, for example: |
| 4247 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4248 | # {name: "nodes total", int_value: 32}] |
| 4249 | # or |
| 4250 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4251 | # {name: "progress scale", double_value: 1.0}] |
| 4252 | { # Progress metric is (string, int|float|string) pair. |
| 4253 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4254 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4255 | "intValue": "A String", # For metrics with integer value. |
| 4256 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4257 | }, |
| 4258 | ], |
| 4259 | "status": "A String", # Status of an operation stage. |
| 4260 | # Unset for single-stage operations. |
| 4261 | }, |
| 4262 | "zone": "A String", # The name of the Google Compute Engine |
| 4263 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4264 | # operation is taking place. This field is deprecated, use location instead. |
| 4265 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4266 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4267 | "detail": "A String", # Detailed operation progress, if available. |
| 4268 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4269 | "operationType": "A String", # The operation type. |
| 4270 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4271 | "name": "A String", # The server-assigned ID for the operation. |
| 4272 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4273 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4274 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4275 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4276 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4277 | }, |
| 4278 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4279 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4280 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4281 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4282 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4283 | # or |
| 4284 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4285 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4286 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4287 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4288 | }</pre> |
| 4289 | </div> |
| 4290 | |
| 4291 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4292 | <code class="details" id="setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4293 | <pre>Sets labels on a cluster. |
| 4294 | |
| 4295 | Args: |
| 4296 | name: string, The name (project, location, cluster id) of the cluster to set labels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4297 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4298 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4299 | The object takes the form of: |
| 4300 | |
| 4301 | { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container |
| 4302 | # Engine cluster, which will in turn set them for Google Compute Engine |
| 4303 | # resources used by that cluster |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4304 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4305 | # This field has been deprecated and replaced by the name field. |
| 4306 | "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4307 | # used to detect conflicts. The fingerprint is initially generated by |
| 4308 | # Kubernetes Engine and changes after every request to modify or update |
| 4309 | # labels. You must always provide an up-to-date fingerprint hash when |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4310 | # updating or changing labels. Make a <code>get()</code> request to the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4311 | # resource to get the latest fingerprint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4312 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4313 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4314 | # cluster resides. This field has been deprecated and replaced by the name |
| 4315 | # field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4316 | "name": "A String", # The name (project, location, cluster id) of the cluster to set labels. |
| 4317 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4318 | "resourceLabels": { # Required. The labels to set for that cluster. |
| 4319 | "a_key": "A String", |
| 4320 | }, |
| 4321 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4322 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4323 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4324 | } |
| 4325 | |
| 4326 | x__xgafv: string, V1 error format. |
| 4327 | Allowed values |
| 4328 | 1 - v1 error format |
| 4329 | 2 - v2 error format |
| 4330 | |
| 4331 | Returns: |
| 4332 | An object of the form: |
| 4333 | |
| 4334 | { # This operation resource represents operations that may have happened or are |
| 4335 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4336 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4337 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4338 | # (e.g., ERROR or DEGRADED). |
| 4339 | "code": "A String", # Machine-friendly representation of the condition |
| 4340 | "message": "A String", # Human-friendly representation of the condition |
| 4341 | }, |
| 4342 | ], |
| 4343 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4344 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4345 | # Unset for single-stage operations. |
| 4346 | "stages": [ # Substages of an operation or a stage. |
| 4347 | # Object with schema name: OperationProgress |
| 4348 | ], |
| 4349 | "metrics": [ # Progress metric bundle, for example: |
| 4350 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4351 | # {name: "nodes total", int_value: 32}] |
| 4352 | # or |
| 4353 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4354 | # {name: "progress scale", double_value: 1.0}] |
| 4355 | { # Progress metric is (string, int|float|string) pair. |
| 4356 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4357 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4358 | "intValue": "A String", # For metrics with integer value. |
| 4359 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4360 | }, |
| 4361 | ], |
| 4362 | "status": "A String", # Status of an operation stage. |
| 4363 | # Unset for single-stage operations. |
| 4364 | }, |
| 4365 | "zone": "A String", # The name of the Google Compute Engine |
| 4366 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4367 | # operation is taking place. This field is deprecated, use location instead. |
| 4368 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4369 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4370 | "detail": "A String", # Detailed operation progress, if available. |
| 4371 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4372 | "operationType": "A String", # The operation type. |
| 4373 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4374 | "name": "A String", # The server-assigned ID for the operation. |
| 4375 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4376 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4377 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4378 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4379 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4380 | }, |
| 4381 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4382 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4383 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4384 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4385 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4386 | # or |
| 4387 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4388 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4389 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4390 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4391 | }</pre> |
| 4392 | </div> |
| 4393 | |
| 4394 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4395 | <code class="details" id="startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4396 | <pre>Starts master IP rotation. |
| 4397 | |
| 4398 | Args: |
| 4399 | name: string, The name (project, location, cluster id) of the cluster to start IP |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4400 | rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4401 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4402 | The object takes the form of: |
| 4403 | |
| 4404 | { # StartIPRotationRequest creates a new IP for the cluster and then performs |
| 4405 | # a node upgrade on each node pool to point to the new IP. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4406 | "name": "A String", # The name (project, location, cluster id) of the cluster to start IP |
| 4407 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4408 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4409 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4410 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4411 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4412 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4413 | # cluster resides. This field has been deprecated and replaced by the name |
| 4414 | # field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4415 | "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4416 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4417 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4418 | } |
| 4419 | |
| 4420 | x__xgafv: string, V1 error format. |
| 4421 | Allowed values |
| 4422 | 1 - v1 error format |
| 4423 | 2 - v2 error format |
| 4424 | |
| 4425 | Returns: |
| 4426 | An object of the form: |
| 4427 | |
| 4428 | { # This operation resource represents operations that may have happened or are |
| 4429 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4430 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4431 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4432 | # (e.g., ERROR or DEGRADED). |
| 4433 | "code": "A String", # Machine-friendly representation of the condition |
| 4434 | "message": "A String", # Human-friendly representation of the condition |
| 4435 | }, |
| 4436 | ], |
| 4437 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4438 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4439 | # Unset for single-stage operations. |
| 4440 | "stages": [ # Substages of an operation or a stage. |
| 4441 | # Object with schema name: OperationProgress |
| 4442 | ], |
| 4443 | "metrics": [ # Progress metric bundle, for example: |
| 4444 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4445 | # {name: "nodes total", int_value: 32}] |
| 4446 | # or |
| 4447 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4448 | # {name: "progress scale", double_value: 1.0}] |
| 4449 | { # Progress metric is (string, int|float|string) pair. |
| 4450 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4451 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4452 | "intValue": "A String", # For metrics with integer value. |
| 4453 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4454 | }, |
| 4455 | ], |
| 4456 | "status": "A String", # Status of an operation stage. |
| 4457 | # Unset for single-stage operations. |
| 4458 | }, |
| 4459 | "zone": "A String", # The name of the Google Compute Engine |
| 4460 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4461 | # operation is taking place. This field is deprecated, use location instead. |
| 4462 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4463 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4464 | "detail": "A String", # Detailed operation progress, if available. |
| 4465 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4466 | "operationType": "A String", # The operation type. |
| 4467 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4468 | "name": "A String", # The server-assigned ID for the operation. |
| 4469 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4470 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4471 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4472 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4473 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4474 | }, |
| 4475 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4476 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4477 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4478 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4479 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4480 | # or |
| 4481 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4482 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4483 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4484 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4485 | }</pre> |
| 4486 | </div> |
| 4487 | |
| 4488 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4489 | <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4490 | <pre>Updates the settings of a specific cluster. |
| 4491 | |
| 4492 | Args: |
| 4493 | name: string, The name (project, location, cluster) of the cluster to update. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4494 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4495 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4496 | The object takes the form of: |
| 4497 | |
| 4498 | { # UpdateClusterRequest updates the settings of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4499 | "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4500 | # be applied to a cluster with each request, so at most one field can be |
| 4501 | # provided. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4502 | "desiredImageType": "A String", # The desired image type for the node pool. |
| 4503 | # NOTE: Set the "desired_node_pool" field as well. |
| 4504 | "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity. |
| 4505 | # policies. |
| 4506 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 4507 | }, |
| 4508 | "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if |
| 4509 | # "desired_node_version", "desired_image_family" or |
| 4510 | # "desired_node_pool_autoscaling" is specified and there is more than one |
| 4511 | # node pool on the cluster. |
| 4512 | "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. |
| 4513 | # |
| 4514 | # Users may specify either explicit versions offered by |
| 4515 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 4516 | # |
| 4517 | # - "latest": picks the highest valid Kubernetes version |
| 4518 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4519 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4520 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4521 | # - "-": picks the default Kubernetes version |
| 4522 | "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. |
| 4523 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 4524 | }, |
| 4525 | "desiredLoggingService": "A String", # The logging service the cluster should use to write logs. |
| 4526 | # Currently available options: |
| 4527 | # |
| 4528 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 4529 | # service with a Kubernetes-native resource model |
| 4530 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 4531 | # available as of GKE 1.15). |
| 4532 | # * `none` - no logs will be exported from the cluster. |
| 4533 | # |
| 4534 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 4535 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 4536 | "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 4537 | # required by Vertical Pod Autoscaler to automatically adjust |
| 4538 | # the resources of pods controlled by it. |
| 4539 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 4540 | }, |
| 4541 | "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. |
| 4542 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 4543 | # images will be validated by Binary Authorization. |
| 4544 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4545 | "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4546 | # cluster, enabling additional functionality. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4547 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 4548 | # is enabled or not on the Master, it does not track whether network policy |
| 4549 | # is enabled for the nodes. |
| 4550 | # is enabled or not on the Master, it does not track whether network policy |
| 4551 | # is enabled for the nodes. |
| 4552 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 4553 | }, |
| 4554 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 4555 | # managed Knative service. |
| 4556 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 4557 | }, |
| 4558 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 4559 | # increases or decreases the number of replica pods a replication controller |
| 4560 | # has based on the resource usage of the existing pods. |
| 4561 | # increases or decreases the number of replica pods a replication controller |
| 4562 | # has based on the resource usage of the existing pods. |
| 4563 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 4564 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 4565 | # Monitoring. |
| 4566 | }, |
| 4567 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4568 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 4569 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4570 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4571 | # When enabled, it runs a small pod in the cluster that manages the load |
| 4572 | # balancers. |
| 4573 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4574 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4575 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 4576 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 4577 | # workloads and applications. For more information, see: |
| 4578 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4579 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4580 | }, |
| 4581 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4582 | "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an |
| 4583 | # upgrade). |
| 4584 | # |
| 4585 | # Users may specify either explicit versions offered by |
| 4586 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 4587 | # |
| 4588 | # - "latest": picks the highest valid Kubernetes version |
| 4589 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4590 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4591 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4592 | # - "-": picks the Kubernetes master version |
| 4593 | "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility. |
| 4594 | # visibility on this cluster. |
| 4595 | "enabled": True or False, # Enables intra node visibility for this cluster. |
| 4596 | }, |
| 4597 | "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4598 | # required by Cluster Autoscaler to automatically adjust |
| 4599 | # the size of the cluster and create/delete |
| 4600 | # node pools based on the current needs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4601 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 4602 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4603 | # NodePool's nodes can be created by NAP. |
| 4604 | "A String", |
| 4605 | ], |
| 4606 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 4607 | # amount of resources in the cluster. |
| 4608 | { # Contains information about amount of some resource in the cluster. |
| 4609 | # For memory, value should be in GB. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4610 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4611 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 4612 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4613 | }, |
| 4614 | ], |
| 4615 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 4616 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4617 | # created by NAP. |
| 4618 | # by NAP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4619 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4620 | # node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4621 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4622 | # the Auto Upgrades will proceed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4623 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4624 | # with the approximate start time for the upgrades, in |
| 4625 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4626 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 4627 | # with the description of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4628 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4629 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 4630 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 4631 | # they fail health checks too many times, an automatic repair action will be |
| 4632 | # triggered. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4633 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 4634 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 4635 | # up to date with the latest release version of Kubernetes. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4636 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4637 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 4638 | # specified, service_account should be empty. |
| 4639 | "A String", |
| 4640 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4641 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4642 | # disruption caused by an upgrade. |
| 4643 | # |
| 4644 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 4645 | # unavailable. |
| 4646 | # |
| 4647 | # maxSurge controls the number of additional nodes that can be added to the |
| 4648 | # node pool temporarily for the time of the upgrade to increase the number of |
| 4649 | # available nodes. |
| 4650 | # |
| 4651 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 4652 | # nodes are being upgraded at the same time). |
| 4653 | # |
| 4654 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 4655 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 4656 | # this holds true. (Disruption stays within the limits of |
| 4657 | # PodDisruptionBudget, if it is configured.) |
| 4658 | # |
| 4659 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 4660 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 4661 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 4662 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 4663 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4664 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4665 | # the upgrade process. A node is considered available if its status is |
| 4666 | # Ready. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4667 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 4668 | # of the node pool during the upgrade process. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4669 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4670 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 4671 | # service_account is specified, scopes should be empty. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4672 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4673 | }, |
| 4674 | "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 4675 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 4676 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 4677 | "state": "A String", # Denotes the state of etcd encryption. |
| 4678 | }, |
| 4679 | "desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature. |
| 4680 | # master authorized networks will disallow all external traffic to access |
| 4681 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 4682 | # Google Compute Engine Public IPs and Google Prod IPs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4683 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 4684 | # Kubernetes master through HTTPS. |
| 4685 | { # CidrBlock contains an optional name and one CIDR block. |
| 4686 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 4687 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4688 | }, |
| 4689 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4690 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4691 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4692 | "desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage. |
| 4693 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 4694 | # daemonset will be created in the cluster to meter network egress traffic. |
| 4695 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 4696 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 4697 | # second BigQuery table will be created to hold resource consumption |
| 4698 | # records. |
| 4699 | }, |
| 4700 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 4701 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 4702 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4703 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4704 | "desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in |
| 4705 | # desired_node_pool_id. If there is only one pool in the |
| 4706 | # cluster and desired_node_pool_id is not provided then |
| 4707 | # the change applies to that single node pool. |
| 4708 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4709 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 4710 | # has to enough quota to scale up the cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4711 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4712 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 4713 | # max_node_count. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4714 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4715 | }, |
| 4716 | "desiredLocations": [ # The desired list of Google Compute Engine |
| 4717 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4718 | # cluster's nodes should be located. Changing the locations a cluster is in |
| 4719 | # will result in nodes being either created or removed from the cluster, |
| 4720 | # depending on whether locations are being added or removed. |
| 4721 | # |
| 4722 | # This list must always include the cluster's primary zone. |
| 4723 | "A String", |
| 4724 | ], |
| 4725 | "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4726 | # Currently available options: |
| 4727 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4728 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4729 | # service with a Kubernetes-native resource model |
| 4730 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 4731 | # longer available as of GKE 1.15). |
| 4732 | # * `none` - No metrics will be exported from the cluster. |
| 4733 | # |
| 4734 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 4735 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4736 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4737 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 4738 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4739 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4740 | # number](https://support.google.com/cloud/answer/6158840). |
| 4741 | # This field has been deprecated and replaced by the name field. |
| 4742 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4743 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4744 | # cluster resides. This field has been deprecated and replaced by the name |
| 4745 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4746 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 4747 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4748 | } |
| 4749 | |
| 4750 | x__xgafv: string, V1 error format. |
| 4751 | Allowed values |
| 4752 | 1 - v1 error format |
| 4753 | 2 - v2 error format |
| 4754 | |
| 4755 | Returns: |
| 4756 | An object of the form: |
| 4757 | |
| 4758 | { # This operation resource represents operations that may have happened or are |
| 4759 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4760 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4761 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4762 | # (e.g., ERROR or DEGRADED). |
| 4763 | "code": "A String", # Machine-friendly representation of the condition |
| 4764 | "message": "A String", # Human-friendly representation of the condition |
| 4765 | }, |
| 4766 | ], |
| 4767 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4768 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4769 | # Unset for single-stage operations. |
| 4770 | "stages": [ # Substages of an operation or a stage. |
| 4771 | # Object with schema name: OperationProgress |
| 4772 | ], |
| 4773 | "metrics": [ # Progress metric bundle, for example: |
| 4774 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4775 | # {name: "nodes total", int_value: 32}] |
| 4776 | # or |
| 4777 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4778 | # {name: "progress scale", double_value: 1.0}] |
| 4779 | { # Progress metric is (string, int|float|string) pair. |
| 4780 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4781 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4782 | "intValue": "A String", # For metrics with integer value. |
| 4783 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4784 | }, |
| 4785 | ], |
| 4786 | "status": "A String", # Status of an operation stage. |
| 4787 | # Unset for single-stage operations. |
| 4788 | }, |
| 4789 | "zone": "A String", # The name of the Google Compute Engine |
| 4790 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4791 | # operation is taking place. This field is deprecated, use location instead. |
| 4792 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4793 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4794 | "detail": "A String", # Detailed operation progress, if available. |
| 4795 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4796 | "operationType": "A String", # The operation type. |
| 4797 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4798 | "name": "A String", # The server-assigned ID for the operation. |
| 4799 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4800 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4801 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4802 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4803 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4804 | }, |
| 4805 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4806 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4807 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4808 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4809 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4810 | # or |
| 4811 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4812 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4813 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4814 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4815 | }</pre> |
| 4816 | </div> |
| 4817 | |
| 4818 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4819 | <code class="details" id="updateMaster">updateMaster(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4820 | <pre>Updates the master for a specific cluster. |
| 4821 | |
| 4822 | Args: |
| 4823 | name: string, The name (project, location, cluster) of the cluster to update. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4824 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4825 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4826 | The object takes the form of: |
| 4827 | |
| 4828 | { # UpdateMasterRequest updates the master of the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4829 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4830 | # number](https://support.google.com/cloud/answer/6158840). |
| 4831 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4832 | "masterVersion": "A String", # Required. The Kubernetes version to change the master to. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4833 | # |
| 4834 | # Users may specify either explicit versions offered by Kubernetes Engine or |
| 4835 | # version aliases, which have the following behavior: |
| 4836 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4837 | # - "latest": picks the highest valid Kubernetes version |
| 4838 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4839 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4840 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4841 | # - "-": picks the default Kubernetes version |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4842 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4843 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4844 | # cluster resides. This field has been deprecated and replaced by the name |
| 4845 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4846 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4847 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4848 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 4849 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4850 | } |
| 4851 | |
| 4852 | x__xgafv: string, V1 error format. |
| 4853 | Allowed values |
| 4854 | 1 - v1 error format |
| 4855 | 2 - v2 error format |
| 4856 | |
| 4857 | Returns: |
| 4858 | An object of the form: |
| 4859 | |
| 4860 | { # This operation resource represents operations that may have happened or are |
| 4861 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4862 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4863 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4864 | # (e.g., ERROR or DEGRADED). |
| 4865 | "code": "A String", # Machine-friendly representation of the condition |
| 4866 | "message": "A String", # Human-friendly representation of the condition |
| 4867 | }, |
| 4868 | ], |
| 4869 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4870 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4871 | # Unset for single-stage operations. |
| 4872 | "stages": [ # Substages of an operation or a stage. |
| 4873 | # Object with schema name: OperationProgress |
| 4874 | ], |
| 4875 | "metrics": [ # Progress metric bundle, for example: |
| 4876 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4877 | # {name: "nodes total", int_value: 32}] |
| 4878 | # or |
| 4879 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4880 | # {name: "progress scale", double_value: 1.0}] |
| 4881 | { # Progress metric is (string, int|float|string) pair. |
| 4882 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4883 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4884 | "intValue": "A String", # For metrics with integer value. |
| 4885 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4886 | }, |
| 4887 | ], |
| 4888 | "status": "A String", # Status of an operation stage. |
| 4889 | # Unset for single-stage operations. |
| 4890 | }, |
| 4891 | "zone": "A String", # The name of the Google Compute Engine |
| 4892 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4893 | # operation is taking place. This field is deprecated, use location instead. |
| 4894 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4895 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4896 | "detail": "A String", # Detailed operation progress, if available. |
| 4897 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4898 | "operationType": "A String", # The operation type. |
| 4899 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4900 | "name": "A String", # The server-assigned ID for the operation. |
| 4901 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4902 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4903 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4904 | "code": "A String", # Machine-friendly representation of the condition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4905 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4906 | }, |
| 4907 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4908 | "endTime": "A String", # [Output only] The time the operation completed, in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4909 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4910 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4911 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4912 | # or |
| 4913 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4914 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4915 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4916 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4917 | }</pre> |
| 4918 | </div> |
| 4919 | |
| 4920 | </body></html> |