| 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_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.locations.html">locations</a> . <a href="container_v1beta1.projects.locations.clusters.html">clusters</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="container_v1beta1.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_v1beta1.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 | 4ed7d3f | 2020-05-27 12:20:54 -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 | d059ad8 | 2020-07-22 17:02:09 -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 for 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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 103 | <code><a href="#list">list(parent, zone=None, projectId=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 for 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 154 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 155 | # cluster resides. This field has been deprecated and replaced by the name |
| 156 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 157 | "name": "A String", # The name (project, location, cluster id) of the cluster to complete IP |
| 158 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| 159 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 160 | # This field has been deprecated and replaced by the name field. |
| 161 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 162 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 163 | # This field has been deprecated and replaced by the name 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 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 177 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 179 | "stages": [ # Substages of an operation or a stage. |
| 180 | # Object with schema name: OperationProgress |
| 181 | ], |
| 182 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 183 | # Unset for single-stage operations. |
| 184 | "status": "A String", # Status of an operation stage. |
| 185 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "metrics": [ # Progress metric bundle, for example: |
| 187 | # metrics: [{name: "nodes done", int_value: 15}, |
| 188 | # {name: "nodes total", int_value: 32}] |
| 189 | # or |
| 190 | # metrics: [{name: "progress", double_value: 0.56}, |
| 191 | # {name: "progress scale", double_value: 1.0}] |
| 192 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 195 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 196 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | }, |
| 198 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 199 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 200 | "selfLink": "A String", # Server-defined URL for the resource. |
| 201 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 202 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 203 | # or |
| 204 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 205 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 206 | "zone": "A String", # The name of the Google Compute Engine |
| 207 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 208 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 209 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 210 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 211 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 212 | "name": "A String", # The server-assigned ID for the operation. |
| 213 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 214 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 215 | # (e.g., ERROR or DEGRADED). |
| 216 | "code": "A String", # Machine-friendly representation of the condition |
| 217 | "message": "A String", # Human-friendly representation of the condition |
| 218 | }, |
| 219 | ], |
| 220 | "startTime": "A String", # [Output only] The time the operation started, in |
| 221 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 222 | "detail": "A String", # Detailed operation progress, if available. |
| 223 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 224 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 225 | # (e.g., ERROR or DEGRADED). |
| 226 | "code": "A String", # Machine-friendly representation of the condition |
| 227 | "message": "A String", # Human-friendly representation of the condition |
| 228 | }, |
| 229 | ], |
| 230 | "status": "A String", # The current status of the operation. |
| 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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 258 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 259 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 260 | # cluster resides. This field has been deprecated and replaced by the parent |
| 261 | # field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 262 | "parent": "A String", # The parent (project and location) where the cluster will be created. |
| 263 | # Specified in the format `projects/*/locations/*`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 264 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 265 | # number](https://support.google.com/cloud/answer/6158840). |
| 266 | # This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 267 | "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 268 | # resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 270 | # cluster, enabling additional functionality. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 271 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 272 | # extension to manage hosted GCP services through the Kubernetes API |
| 273 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 274 | }, |
| 275 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 276 | # enabled at cluster creation time. |
| 277 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 278 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 279 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 280 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 281 | }, |
| 282 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 283 | # is enabled or not on the Master, it does not track whether network policy |
| 284 | # is enabled for the nodes. |
| 285 | # is enabled or not on the Master, it does not track whether network policy |
| 286 | # is enabled for the nodes. |
| 287 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 288 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 289 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 290 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 291 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 292 | # workloads and applications. For more information, see: |
| 293 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 294 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 295 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 296 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 297 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 298 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 299 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 300 | # When enabled, it runs a small pod in the cluster that manages the load |
| 301 | # balancers. |
| 302 | }, |
| 303 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 304 | # microservices. |
| 305 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 306 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 307 | }, |
| 308 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 309 | # increases or decreases the number of replica pods a replication controller |
| 310 | # has based on the resource usage of the existing pods. |
| 311 | # increases or decreases the number of replica pods a replication controller |
| 312 | # has based on the resource usage of the existing pods. |
| 313 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 314 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 315 | # Monitoring. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 317 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 318 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 319 | # at cluster creation time. |
| 320 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 321 | }, |
| 322 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 323 | # applications. |
| 324 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 325 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 327 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 328 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 329 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 330 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 331 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 332 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 333 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 334 | # mode. |
| 335 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 336 | # identities in the system, including service accounts, nodes, and |
| 337 | # controllers, will have statically granted permissions beyond those |
| 338 | # provided by the RBAC configuration or IAM. |
| 339 | }, |
| 340 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 341 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 342 | # images will be validated by Google Binauthz. |
| 343 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 345 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 346 | # instead. The current version of the node software components. |
| 347 | # If they are currently at multiple versions because they're in the process |
| 348 | # of being upgraded, this reflects the minimum version of all nodes. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 349 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 350 | # Call Kubernetes API directly to retrieve node information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 351 | "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] | 352 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 353 | # will be automatically chosen with the default size. |
| 354 | # |
| 355 | # This field is only applicable when `use_ip_aliases` is true. |
| 356 | # |
| 357 | # Set to blank to have a range chosen with the default size. |
| 358 | # |
| 359 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 360 | # netmask. |
| 361 | # |
| 362 | # Set to a |
| 363 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 364 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 365 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 366 | # to use. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 367 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 368 | "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] | 369 | # range will be automatically chosen with the default size. |
| 370 | # |
| 371 | # This field is only applicable when `use_ip_aliases` is true. |
| 372 | # |
| 373 | # If unspecified, the range will use the default size. |
| 374 | # |
| 375 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 376 | # netmask. |
| 377 | # |
| 378 | # Set to a |
| 379 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 380 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 381 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 382 | # to use. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 383 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 384 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 385 | # This is used in conjunction with use_routes. It cannot |
| 386 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 387 | # false, then the server picks the default IP allocation mode |
| 388 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 389 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 390 | # |
| 391 | # This field is only applicable when `use_ip_aliases` is true. |
| 392 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 393 | # block. The secondary range will be used for pod IP |
| 394 | # addresses. This must be an existing secondary range associated |
| 395 | # with the cluster subnetwork. |
| 396 | # |
| 397 | # This field is only applicable with use_ip_aliases and |
| 398 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 399 | "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] | 400 | # CIDR block. The secondary range will be used for service |
| 401 | # ClusterIPs. This must be an existing secondary range associated |
| 402 | # with the cluster subnetwork. |
| 403 | # |
| 404 | # This field is only applicable with use_ip_aliases and |
| 405 | # create_subnetwork is false. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 406 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 407 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 408 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 409 | # then the server picks the default IP allocation mode |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 411 | # this field is empty, then an automatic name will be chosen for the new |
| 412 | # subnetwork. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 413 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 414 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 415 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 416 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 417 | # range. |
| 418 | # |
| 419 | # If this field is set to true, then cluster and services CIDRs must be |
| 420 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 421 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 422 | # `services_ipv4_cidr_block` must be fully-specified. |
| 423 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 424 | # fully-specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 426 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| 427 | # |
| 428 | # This is applicable only if `create_subnetwork` is true. |
| 429 | # |
| 430 | # Set to blank to have a range chosen with the default size. |
| 431 | # |
| 432 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 433 | # netmask. |
| 434 | # |
| 435 | # Set to a |
| 436 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 437 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 438 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 439 | # to use. |
| 440 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 441 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| 442 | # |
| 443 | # This field is only applicable when `use_ip_aliases` is true. |
| 444 | # |
| 445 | # Set to blank to have a range chosen with the default size. |
| 446 | # |
| 447 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 448 | # netmask. |
| 449 | # |
| 450 | # Set to a |
| 451 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 452 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 453 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 454 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 456 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 457 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 458 | "provider": "A String", # The selected network policy provider. |
| 459 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 460 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 461 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 462 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 463 | # given only RFC 1918 private addresses and communicate with the master via |
| 464 | # private networking. |
| 465 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 466 | # range will be used for assigning internal IP addresses to the master or |
| 467 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 468 | # any other ranges in use within the cluster's network. |
| 469 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 470 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 471 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 472 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 473 | "enabled": True or False, # Whenever master is accessible globally or not. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 474 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 475 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 476 | }, |
| 477 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 478 | # This field is deprecated, use tpu_config.enabled instead. |
| 479 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 480 | # policies. |
| 481 | # policies. |
| 482 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 483 | "identityProvider": "A String", # identity provider is the third party identity provider. |
| 484 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 485 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "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] | 487 | # Currently available options: |
| 488 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 489 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 490 | # service with a Kubernetes-native resource model |
| 491 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 492 | # longer available as of GKE 1.15). |
| 493 | # * `none` - No metrics will be exported from the cluster. |
| 494 | # |
| 495 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 496 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 497 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 498 | "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules |
| 499 | # will be disabled when default_snat_status is disabled. When disabled is set |
| 500 | # to false, default IP masquerade rules will be applied to the nodes to |
| 501 | # prevent sNAT on cluster internal traffic. |
| 502 | # be disabled on the cluster. |
| 503 | "disabled": True or False, # Disables cluster default sNAT rules. |
| 504 | }, |
| 505 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 506 | # This makes same node pod to pod traffic visible for VPC network. |
| 507 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 508 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 509 | # cluster is connected. Example: |
| 510 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 511 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 512 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 513 | # to which the cluster is connected. Example: |
| 514 | # projects/my-project/global/networks/my-network |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 515 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 516 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 517 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 518 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 519 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 520 | # If unspecified, the defaults are used: |
| 521 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 522 | # be set to "admin", a random password will be generated, and a client |
| 523 | # certificate will be issued. |
| 524 | # Authentication can be done using HTTP basic auth or using client |
| 525 | # certificates. |
| 526 | "clusterCaCertificate": "A String", |
| 527 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 528 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 529 | # leaving username unspecified (or setting it to the empty string). |
| 530 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 531 | # authenticate to the cluster endpoint. |
| 532 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 533 | # Because the master endpoint is open to the Internet, you should create a |
| 534 | # strong password. If a password is provided for cluster creation, username |
| 535 | # must be non-empty. |
| 536 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 537 | # clusters before v1.12, if no configuration is specified, a client |
| 538 | # certificate is issued. |
| 539 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 540 | }, |
| 541 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 542 | # to the cluster endpoint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 543 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 544 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 545 | # found in validMasterVersions returned by getServerConfig. The version can |
| 546 | # be upgraded over time; such upgrades are reflected in |
| 547 | # currentMasterVersion and currentNodeVersion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 548 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 549 | # Users may specify either explicit versions offered by |
| 550 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 551 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 552 | # - "latest": picks the highest valid Kubernetes version |
| 553 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 554 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 555 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 556 | # - "","-": picks the default Kubernetes version |
| 557 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 558 | # default have no external IP addresses on the nodes and where nodes and the |
| 559 | # master communicate over private IP addresses. |
| 560 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 561 | # instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 562 | "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] | 563 | # 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] | 564 | # "node_pool" object, since this configuration (along with the |
| 565 | # "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] | 566 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 567 | # For responses, this field will be populated with the node configuration of |
| 568 | # the first node pool. (For configuration of each node pool, see |
| 569 | # `node_pool.config`) |
| 570 | # |
| 571 | # If unspecified, the defaults are used. |
| 572 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 573 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 574 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 575 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 576 | # The following scopes are recommended, but not required, and by default are |
| 577 | # not included: |
| 578 | # |
| 579 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 580 | # persistent storage on your nodes. |
| 581 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 582 | # communicating with **gcr.io** |
| 583 | # (the [Google Container |
| 584 | # Registry](https://cloud.google.com/container-registry/)). |
| 585 | # |
| 586 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 587 | # Monitoring are enabled, in which case their required scopes will be added. |
| 588 | "A String", |
| 589 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 590 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 591 | # |
| 592 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 593 | # in length. These are reflected as part of a URL in the metadata server. |
| 594 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 595 | # metadata keys for the project or be one of the reserved keys: |
| 596 | # "cluster-location" |
| 597 | # "cluster-name" |
| 598 | # "cluster-uid" |
| 599 | # "configure-sh" |
| 600 | # "containerd-configure-sh" |
| 601 | # "enable-oslogin" |
| 602 | # "gci-ensure-gke-docker" |
| 603 | # "gci-metrics-enabled" |
| 604 | # "gci-update-strategy" |
| 605 | # "instance-template" |
| 606 | # "kube-env" |
| 607 | # "startup-script" |
| 608 | # "user-data" |
| 609 | # "disable-address-manager" |
| 610 | # "windows-startup-script-ps1" |
| 611 | # "common-psm1" |
| 612 | # "k8s-node-setup-psm1" |
| 613 | # "install-ssh-psm1" |
| 614 | # "user-profile-psm1" |
| 615 | # "serial-port-logging-enable" |
| 616 | # Values are free-form strings, and only have meaning as interpreted by |
| 617 | # the image running in the instance. The only restriction placed on them is |
| 618 | # that each value's size must be less than or equal to 32 KB. |
| 619 | # |
| 620 | # The total size of all keys and values must be less than 512 KB. |
| 621 | "a_key": "A String", |
| 622 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 623 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 624 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 625 | # `n1-standard-1`). |
| 626 | # |
| 627 | # If unspecified, the default machine type is |
| 628 | # `n1-standard-1`. |
| 629 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 630 | # pool to run on the specified node group. This is useful for running |
| 631 | # workloads on [sole tenant |
| 632 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 633 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 634 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 635 | # |
| 636 | # Secure Boot helps ensure that the system only runs authentic software by |
| 637 | # verifying the digital signature of all boot components, and halting the |
| 638 | # boot process if signature verification fails. |
| 639 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 640 | # |
| 641 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 642 | # The attestation is performed against the integrity policy baseline. This |
| 643 | # baseline is initially derived from the implicitly trusted boot image when |
| 644 | # the instance is created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 645 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 646 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 647 | # Specify the email address of the Service Account; otherwise, if no Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 648 | # Account is specified, the "default" service account is used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 649 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 650 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 651 | # on the nodes. |
| 652 | # |
| 653 | # The following parameters are supported. |
| 654 | # |
| 655 | # net.core.netdev_max_backlog |
| 656 | # net.core.rmem_max |
| 657 | # net.core.wmem_default |
| 658 | # net.core.wmem_max |
| 659 | # net.core.optmem_max |
| 660 | # net.core.somaxconn |
| 661 | # net.ipv4.tcp_rmem |
| 662 | # net.ipv4.tcp_wmem |
| 663 | # net.ipv4.tcp_tw_reuse |
| 664 | "a_key": "A String", |
| 665 | }, |
| 666 | }, |
| 667 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 668 | "type": "A String", # Type of the sandbox to use for the node. |
| 669 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 670 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 671 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 672 | # |
| 673 | # For more information, including usage and the valid values, see: |
| 674 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 675 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 676 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 677 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | # See |
| 679 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 680 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 681 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 682 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 683 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 684 | }, |
| 685 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 686 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 687 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 688 | # |
| 689 | # The string must be a sequence of decimal numbers, each with optional |
| 690 | # fraction and a unit suffix, such as "300ms". |
| 691 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 692 | # The value must be a positive duration. |
| 693 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 694 | # |
| 695 | # If this option is enabled, kubelet uses CFS quota |
| 696 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 697 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 698 | # all. |
| 699 | # |
| 700 | # Disable this option to mitigate CPU throttling problems while still having |
| 701 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 702 | # |
| 703 | # The default value is 'true' if unspecified. |
| 704 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 705 | # See |
| 706 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 707 | # |
| 708 | # The following values are allowed. |
| 709 | # - "none": the default, which represents the existing scheduling behavior. |
| 710 | # - "static": allows pods with certain resource characteristics to be |
| 711 | # granted increased CPU affinity and exclusivity on the node. |
| 712 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 713 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 714 | # These will added in addition to any default label(s) that |
| 715 | # Kubernetes may apply to the node. |
| 716 | # In case of conflict in label keys, the applied set may differ depending on |
| 717 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 718 | # and conflicts should be avoided. |
| 719 | # For more information, including usage and the valid values, see: |
| 720 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 721 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 722 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 723 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 724 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 725 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 726 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 727 | # workloads on the node pool. |
| 728 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 729 | # workloads running on the node. |
| 730 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 731 | # on the node pool. |
| 732 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 733 | "bootDiskKmsKey": "A String", # |
| 734 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 735 | # to each node in the node pool. This should be of the form |
| 736 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 737 | # For more information about protecting resources with Cloud KMS Keys please |
| 738 | # see: |
| 739 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 740 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 741 | # The smallest allowed disk size is 10GB. |
| 742 | # |
| 743 | # If unspecified, the default disk size is 100GB. |
| 744 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 745 | # the specified [Zonal Compute |
| 746 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 747 | # to this node pool. |
| 748 | # is the configuration of desired reservation which instances could take |
| 749 | # capacity from. |
| 750 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 751 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 752 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 753 | # the key and specify the name of your reservation as its value. |
| 754 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 755 | "A String", |
| 756 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 757 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 758 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 759 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 760 | # inforamtion about preemptible VM instances. |
| 761 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 762 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 763 | # friendly names of CPU platforms, such as |
| 764 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 765 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 766 | # information, read [how to specify min CPU |
| 767 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 768 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 769 | # valid sources or targets for network firewalls and are specified by |
| 770 | # the client during cluster or node pool creation. Each tag within the list |
| 771 | # must comply with RFC1035. |
| 772 | "A String", |
| 773 | ], |
| 774 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 775 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 776 | # support for GPUs. |
| 777 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 778 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 779 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 780 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 781 | }, |
| 782 | ], |
| 783 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 784 | # |
| 785 | # The limit for this value is dependent upon the maximum number of |
| 786 | # disks available on a machine per zone. See: |
| 787 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 788 | # for more information. |
| 789 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 790 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 791 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 792 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 793 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 794 | # master authorized networks will disallow all external traffic to access |
| 795 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 796 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 797 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 798 | # Kubernetes master through HTTPS. |
| 799 | { # CidrBlock contains an optional name and one CIDR block. |
| 800 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 801 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 802 | }, |
| 803 | ], |
| 804 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 805 | }, |
| 806 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 807 | # this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 808 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 809 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 810 | # typically put in the last `/16` from the container CIDR. |
| 811 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 812 | # This prefix will be used for assigning private IP addresses to the |
| 813 | # master or set of masters, as well as the ILB VIP. |
| 814 | # This field is deprecated, use |
| 815 | # private_cluster_config.master_ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 816 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 817 | # required by Cluster Autoscaler to automatically adjust |
| 818 | # the size of the cluster and create/delete |
| 819 | # node pools based on the current needs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 820 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 821 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 822 | # created by NAP. |
| 823 | # by NAP. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 824 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 825 | # disruption caused by an upgrade. |
| 826 | # |
| 827 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 828 | # unavailable. |
| 829 | # |
| 830 | # maxSurge controls the number of additional nodes that can be added to the |
| 831 | # node pool temporarily for the time of the upgrade to increase the number of |
| 832 | # available nodes. |
| 833 | # |
| 834 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 835 | # nodes are being upgraded at the same time). |
| 836 | # |
| 837 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 838 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 839 | # this holds true. (Disruption stays within the limits of |
| 840 | # PodDisruptionBudget, if it is configured.) |
| 841 | # |
| 842 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 843 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 844 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 845 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 846 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 847 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 848 | # the upgrade process. A node is considered available if its status is |
| 849 | # Ready. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 850 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 851 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 852 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 853 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 854 | # Specify the email address of the Service Account; otherwise, if no Service |
| 855 | # Account is specified, the "default" service account is used. |
| 856 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 857 | # node VMs under the "default" service account. |
| 858 | # |
| 859 | # The following scopes are recommended, but not required, and by default are |
| 860 | # not included: |
| 861 | # |
| 862 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 863 | # persistent storage on your nodes. |
| 864 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 865 | # communicating with **gcr.io** |
| 866 | # (the [Google Container |
| 867 | # Registry](https://cloud.google.com/container-registry/)). |
| 868 | # |
| 869 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 870 | # Monitoring are enabled, in which case their required scopes will be added. |
| 871 | "A String", |
| 872 | ], |
| 873 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 874 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 875 | # friendly names of CPU platforms, such as |
| 876 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 877 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 878 | # information, read [how to specify min CPU |
| 879 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 880 | # To unset the min cpu platform field pass "automatic" |
| 881 | # as field value. |
| 882 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 883 | # node pool. |
| 884 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 885 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 886 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 887 | # the Auto Upgrades will proceed. |
| 888 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 889 | # with the description of the upgrade. |
| 890 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 891 | # with the approximate start time for the upgrades, in |
| 892 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 893 | }, |
| 894 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 895 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 896 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 897 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 898 | # amount of resources in the cluster. |
| 899 | { # Contains information about amount of some resource in the cluster. |
| 900 | # For memory, value should be in GB. |
| 901 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 902 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 903 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 904 | }, |
| 905 | ], |
| 906 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 907 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 908 | # NodePool's nodes can be created by NAP. |
| 909 | "A String", |
| 910 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 911 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 912 | "locations": [ # The list of Google Compute Engine |
| 913 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 914 | # cluster's nodes should be located. |
| 915 | "A String", |
| 916 | ], |
| 917 | "conditions": [ # Which conditions caused the current cluster state. |
| 918 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 919 | # (e.g., ERROR or DEGRADED). |
| 920 | "code": "A String", # Machine-friendly representation of the condition |
| 921 | "message": "A String", # Human-friendly representation of the condition |
| 922 | }, |
| 923 | ], |
| 924 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 925 | # Currently available options: |
| 926 | # |
| 927 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 928 | # service with a Kubernetes-native resource model |
| 929 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 930 | # available as of GKE 1.15). |
| 931 | # * `none` - no logs will be exported from the cluster. |
| 932 | # |
| 933 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 934 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 935 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 936 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 937 | # the kubernetes version of the master and nodes. |
| 938 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 939 | # Alpha enabled clusters are automatically deleted thirty days after |
| 940 | # creation. |
| 941 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 942 | "A String", |
| 943 | ], |
| 944 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 945 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 946 | # the following restrictions: |
| 947 | # |
| 948 | # * Lowercase letters, numbers, and hyphens only. |
| 949 | # * Must start with a letter. |
| 950 | # * Must end with a number or a letter. |
| 951 | "master": { # Master is the configuration for components on master. # Configuration for master components. |
| 952 | }, |
| 953 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 954 | # The endpoint can be accessed from the internet at |
| 955 | # `https://username:password@endpoint/`. |
| 956 | # |
| 957 | # See the `masterAuth` property of this resource for username and |
| 958 | # password information. |
| 959 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 960 | # disabled when this config unspecified. |
| 961 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 962 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 963 | # second BigQuery table will be created to hold resource consumption |
| 964 | # records. |
| 965 | }, |
| 966 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 967 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 968 | }, |
| 969 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 970 | # daemonset will be created in the cluster to meter network egress traffic. |
| 971 | }, |
| 972 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 973 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 974 | # or |
| 975 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 976 | # in which the cluster resides. |
| 977 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 978 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 979 | # if enabled = true. |
| 980 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 981 | # during authentication using a group of security groups. |
| 982 | }, |
| 983 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 984 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 985 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 986 | # the name. |
| 987 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 988 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 989 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| 990 | # maintenance to occur. The time windows may be overlapping. If no |
| 991 | # maintenance windows are set, maintenance can occur at any time. |
| 992 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| 993 | # this window reccurs. They go on for the span of time between the start and |
| 994 | # end time. |
| 995 | # |
| 996 | # For example, to have something repeat every weekday, you'd use: |
| 997 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 998 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 999 | # <code>FREQ=DAILY</code> |
| 1000 | # For the first weekend of every month: |
| 1001 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 1002 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| 1003 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| 1004 | # <code> |
| 1005 | # start time = 2019-01-01T09:00:00-0400 |
| 1006 | # end time = 2019-01-01T17:00:00-0400 |
| 1007 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 1008 | # </code> |
| 1009 | # Windows can span multiple days. Eg, to make the window encompass every |
| 1010 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 1011 | # <code> |
| 1012 | # start time = 2019-01-05T00:00:00Z |
| 1013 | # end time = 2019-01-07T23:59:00Z |
| 1014 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 1015 | # </code> |
| 1016 | # Note the start and end time's specific dates are largely arbitrary except |
| 1017 | # to specify duration of the window and when it first starts. |
| 1018 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| 1019 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 1020 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1021 | # start time. |
| 1022 | "startTime": "A String", # The time that the window first starts. |
| 1023 | }, |
| 1024 | }, |
| 1025 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 1026 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 1027 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 1028 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 1029 | # smallest possible in the given scenario. |
| 1030 | }, |
| 1031 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 1032 | # occur in these windows. |
| 1033 | "a_key": { # Represents an arbitrary window of time. |
| 1034 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1035 | # start time. |
| 1036 | "startTime": "A String", # The time that the window first starts. |
| 1037 | }, |
| 1038 | }, |
| 1039 | }, |
| 1040 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 1041 | # the policy won't accidentally undo intermediate changes (and so that users |
| 1042 | # of the API unaware of some fields won't accidentally remove other fields). |
| 1043 | # Make a <code>get()</code> request to the cluster to get the current |
| 1044 | # resource version and include it with requests to set the policy. |
| 1045 | }, |
| 1046 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 1047 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 1048 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 1049 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 1050 | }, |
| 1051 | "nodePools": [ # The node pools associated with this cluster. |
| 1052 | # This field should not be set if "node_config" or "initial_node_count" are |
| 1053 | # specified. |
| 1054 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 1055 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| 1056 | # specification, under the control of the cluster master. They may have a set |
| 1057 | # of Kubernetes labels applied to them, which may be used to reference them |
| 1058 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 1059 | # the workload. |
| 1060 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 1061 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 1062 | # disruption caused by an upgrade. |
| 1063 | # |
| 1064 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1065 | # unavailable. |
| 1066 | # |
| 1067 | # maxSurge controls the number of additional nodes that can be added to the |
| 1068 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1069 | # available nodes. |
| 1070 | # |
| 1071 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1072 | # nodes are being upgraded at the same time). |
| 1073 | # |
| 1074 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1075 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1076 | # this holds true. (Disruption stays within the limits of |
| 1077 | # PodDisruptionBudget, if it is configured.) |
| 1078 | # |
| 1079 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1080 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1081 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1082 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1083 | # there are always at least 4 nodes available. |
| 1084 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 1085 | # the upgrade process. A node is considered available if its status is |
| 1086 | # Ready. |
| 1087 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1088 | # of the node pool during the upgrade process. |
| 1089 | }, |
| 1090 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 1091 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 1092 | # associated with this node pool. |
| 1093 | "A String", |
| 1094 | ], |
| 1095 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 1096 | # only if a valid configuration is present. |
| 1097 | # adjust the size of the node pool to the current cluster usage. |
| 1098 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 1099 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 1100 | # max_node_count. |
| 1101 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 1102 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 1103 | # has to enough quota to scale up the cluster. |
| 1104 | }, |
| 1105 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 1106 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 1107 | # is sufficient for this number of instances. You must also have available |
| 1108 | # firewall and routes quota. |
| 1109 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 1110 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1111 | # node VMs under the "default" service account. |
| 1112 | # |
| 1113 | # The following scopes are recommended, but not required, and by default are |
| 1114 | # not included: |
| 1115 | # |
| 1116 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1117 | # persistent storage on your nodes. |
| 1118 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1119 | # communicating with **gcr.io** |
| 1120 | # (the [Google Container |
| 1121 | # Registry](https://cloud.google.com/container-registry/)). |
| 1122 | # |
| 1123 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1124 | # Monitoring are enabled, in which case their required scopes will be added. |
| 1125 | "A String", |
| 1126 | ], |
| 1127 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1128 | # |
| 1129 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1130 | # in length. These are reflected as part of a URL in the metadata server. |
| 1131 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1132 | # metadata keys for the project or be one of the reserved keys: |
| 1133 | # "cluster-location" |
| 1134 | # "cluster-name" |
| 1135 | # "cluster-uid" |
| 1136 | # "configure-sh" |
| 1137 | # "containerd-configure-sh" |
| 1138 | # "enable-oslogin" |
| 1139 | # "gci-ensure-gke-docker" |
| 1140 | # "gci-metrics-enabled" |
| 1141 | # "gci-update-strategy" |
| 1142 | # "instance-template" |
| 1143 | # "kube-env" |
| 1144 | # "startup-script" |
| 1145 | # "user-data" |
| 1146 | # "disable-address-manager" |
| 1147 | # "windows-startup-script-ps1" |
| 1148 | # "common-psm1" |
| 1149 | # "k8s-node-setup-psm1" |
| 1150 | # "install-ssh-psm1" |
| 1151 | # "user-profile-psm1" |
| 1152 | # "serial-port-logging-enable" |
| 1153 | # Values are free-form strings, and only have meaning as interpreted by |
| 1154 | # the image running in the instance. The only restriction placed on them is |
| 1155 | # that each value's size must be less than or equal to 32 KB. |
| 1156 | # |
| 1157 | # The total size of all keys and values must be less than 512 KB. |
| 1158 | "a_key": "A String", |
| 1159 | }, |
| 1160 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1161 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1162 | # `n1-standard-1`). |
| 1163 | # |
| 1164 | # If unspecified, the default machine type is |
| 1165 | # `n1-standard-1`. |
| 1166 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 1167 | # pool to run on the specified node group. This is useful for running |
| 1168 | # workloads on [sole tenant |
| 1169 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 1170 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 1171 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1172 | # |
| 1173 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1174 | # verifying the digital signature of all boot components, and halting the |
| 1175 | # boot process if signature verification fails. |
| 1176 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1177 | # |
| 1178 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1179 | # The attestation is performed against the integrity policy baseline. This |
| 1180 | # baseline is initially derived from the implicitly trusted boot image when |
| 1181 | # the instance is created. |
| 1182 | }, |
| 1183 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 1184 | # Specify the email address of the Service Account; otherwise, if no Service |
| 1185 | # Account is specified, the "default" service account is used. |
| 1186 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 1187 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 1188 | # on the nodes. |
| 1189 | # |
| 1190 | # The following parameters are supported. |
| 1191 | # |
| 1192 | # net.core.netdev_max_backlog |
| 1193 | # net.core.rmem_max |
| 1194 | # net.core.wmem_default |
| 1195 | # net.core.wmem_max |
| 1196 | # net.core.optmem_max |
| 1197 | # net.core.somaxconn |
| 1198 | # net.ipv4.tcp_rmem |
| 1199 | # net.ipv4.tcp_wmem |
| 1200 | # net.ipv4.tcp_tw_reuse |
| 1201 | "a_key": "A String", |
| 1202 | }, |
| 1203 | }, |
| 1204 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1205 | "type": "A String", # Type of the sandbox to use for the node. |
| 1206 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 1207 | }, |
| 1208 | "taints": [ # List of kubernetes taints to be applied to each node. |
| 1209 | # |
| 1210 | # For more information, including usage and the valid values, see: |
| 1211 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1212 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1213 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1214 | # |
| 1215 | # See |
| 1216 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1217 | # for more information, including usage and the valid values. |
| 1218 | "effect": "A String", # Effect for taint. |
| 1219 | "key": "A String", # Key for taint. |
| 1220 | "value": "A String", # Value for taint. |
| 1221 | }, |
| 1222 | ], |
| 1223 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 1224 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 1225 | # |
| 1226 | # The string must be a sequence of decimal numbers, each with optional |
| 1227 | # fraction and a unit suffix, such as "300ms". |
| 1228 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 1229 | # The value must be a positive duration. |
| 1230 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 1231 | # |
| 1232 | # If this option is enabled, kubelet uses CFS quota |
| 1233 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 1234 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 1235 | # all. |
| 1236 | # |
| 1237 | # Disable this option to mitigate CPU throttling problems while still having |
| 1238 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 1239 | # |
| 1240 | # The default value is 'true' if unspecified. |
| 1241 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 1242 | # See |
| 1243 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 1244 | # |
| 1245 | # The following values are allowed. |
| 1246 | # - "none": the default, which represents the existing scheduling behavior. |
| 1247 | # - "static": allows pods with certain resource characteristics to be |
| 1248 | # granted increased CPU affinity and exclusivity on the node. |
| 1249 | }, |
| 1250 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1251 | # These will added in addition to any default label(s) that |
| 1252 | # Kubernetes may apply to the node. |
| 1253 | # In case of conflict in label keys, the applied set may differ depending on |
| 1254 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1255 | # and conflicts should be avoided. |
| 1256 | # For more information, including usage and the valid values, see: |
| 1257 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1258 | "a_key": "A String", |
| 1259 | }, |
| 1260 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1261 | # |
| 1262 | # If unspecified, the default disk type is 'pd-standard' |
| 1263 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1264 | # workloads on the node pool. |
| 1265 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 1266 | # workloads running on the node. |
| 1267 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1268 | # on the node pool. |
| 1269 | }, |
| 1270 | "bootDiskKmsKey": "A String", # |
| 1271 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 1272 | # to each node in the node pool. This should be of the form |
| 1273 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 1274 | # For more information about protecting resources with Cloud KMS Keys please |
| 1275 | # see: |
| 1276 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 1277 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1278 | # The smallest allowed disk size is 10GB. |
| 1279 | # |
| 1280 | # If unspecified, the default disk size is 100GB. |
| 1281 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1282 | # the specified [Zonal Compute |
| 1283 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1284 | # to this node pool. |
| 1285 | # is the configuration of desired reservation which instances could take |
| 1286 | # capacity from. |
| 1287 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 1288 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1289 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1290 | # the key and specify the name of your reservation as its value. |
| 1291 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1292 | "A String", |
| 1293 | ], |
| 1294 | }, |
| 1295 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1296 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1297 | # inforamtion about preemptible VM instances. |
| 1298 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1299 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1300 | # friendly names of CPU platforms, such as |
| 1301 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1302 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1303 | # information, read [how to specify min CPU |
| 1304 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1305 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 1306 | # valid sources or targets for network firewalls and are specified by |
| 1307 | # the client during cluster or node pool creation. Each tag within the list |
| 1308 | # must comply with RFC1035. |
| 1309 | "A String", |
| 1310 | ], |
| 1311 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1312 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1313 | # support for GPUs. |
| 1314 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 1315 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 1316 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1317 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 1318 | }, |
| 1319 | ], |
| 1320 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 1321 | # |
| 1322 | # The limit for this value is dependent upon the maximum number of |
| 1323 | # disks available on a machine per zone. See: |
| 1324 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 1325 | # for more information. |
| 1326 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1327 | # the latest version of it will be used. |
| 1328 | }, |
| 1329 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1330 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 1331 | # node pool. |
| 1332 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 1333 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 1334 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1335 | # the Auto Upgrades will proceed. |
| 1336 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1337 | # with the description of the upgrade. |
| 1338 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1339 | # with the approximate start time for the upgrades, in |
| 1340 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1341 | }, |
| 1342 | }, |
| 1343 | "name": "A String", # The name of the node pool. |
| 1344 | "version": "A String", # The version of the Kubernetes of this node. |
| 1345 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 1346 | # simultaneously on a node in the node pool. |
| 1347 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1348 | }, |
| 1349 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1350 | # node pool instance, if available. |
| 1351 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 1352 | "conditions": [ # Which conditions caused the current node pool state. |
| 1353 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1354 | # (e.g., ERROR or DEGRADED). |
| 1355 | "code": "A String", # Machine-friendly representation of the condition |
| 1356 | "message": "A String", # Human-friendly representation of the condition |
| 1357 | }, |
| 1358 | ], |
| 1359 | "locations": [ # The list of Google Compute Engine |
| 1360 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1361 | # NodePool's nodes should be located. |
| 1362 | "A String", |
| 1363 | ], |
| 1364 | }, |
| 1365 | ], |
| 1366 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1367 | # cluster, if available. |
| 1368 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 1369 | # subscribed to. Release channels are arranged in order of risk. |
| 1370 | # |
| 1371 | # When a cluster is subscribed to a release channel, Google maintains |
| 1372 | # both the master version and the node version. Node auto-upgrade |
| 1373 | # defaults to true and cannot be disabled. |
| 1374 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 1375 | }, |
| 1376 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1377 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 1378 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 1379 | # if cluster created with IP Alias support. |
| 1380 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1381 | }, |
| 1382 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 1383 | "type": "A String", # Type of the integration. |
| 1384 | }, |
| 1385 | "status": "A String", # [Output only] The current status of this cluster. |
| 1386 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 1387 | # Google Compute Engine resources. |
| 1388 | "a_key": "A String", |
| 1389 | }, |
| 1390 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 1391 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1392 | # notation (e.g. `1.2.3.4/29`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1393 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1394 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1395 | # is sufficient for this number of instances. You must also have available |
| 1396 | # firewall and routes quota. |
| 1397 | # 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] | 1398 | # "node_pool" object, since this configuration (along with the |
| 1399 | # "node_config") will be used to create a "NodePool" object with an |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1400 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1401 | # |
| 1402 | # This field is deprecated, use node_pool.initial_node_count instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1403 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 1404 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 1405 | # must be valid under a PodSecurityPolicy to be created. |
| 1406 | }, |
| 1407 | "description": "A String", # An optional description of this cluster. |
| 1408 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 1409 | "state": "A String", # Denotes the state of etcd encryption. |
| 1410 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 1411 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 1412 | }, |
| 1413 | "network": "A String", # The name of the Google Compute Engine |
| 1414 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1415 | # to which the cluster is connected. If left unspecified, the `default` |
| 1416 | # network will be used. On output this shows the network ID instead of the |
| 1417 | # name. |
| 1418 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 1419 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1420 | # cluster resides. This field is deprecated, use location instead. |
| 1421 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 1422 | # required by Vertical Pod Autoscaler to automatically adjust |
| 1423 | # the resources of pods controlled by it. |
| 1424 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 1425 | }, |
| 1426 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 1427 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1428 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| 1429 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 1430 | # range. This field will only be set when cluster is in route-based network |
| 1431 | # mode. |
| 1432 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1433 | }, |
| 1434 | } |
| 1435 | |
| 1436 | x__xgafv: string, V1 error format. |
| 1437 | Allowed values |
| 1438 | 1 - v1 error format |
| 1439 | 2 - v2 error format |
| 1440 | |
| 1441 | Returns: |
| 1442 | An object of the form: |
| 1443 | |
| 1444 | { # This operation resource represents operations that may have happened or are |
| 1445 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1446 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1447 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1448 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1449 | "stages": [ # Substages of an operation or a stage. |
| 1450 | # Object with schema name: OperationProgress |
| 1451 | ], |
| 1452 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1453 | # Unset for single-stage operations. |
| 1454 | "status": "A String", # Status of an operation stage. |
| 1455 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1456 | "metrics": [ # Progress metric bundle, for example: |
| 1457 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1458 | # {name: "nodes total", int_value: 32}] |
| 1459 | # or |
| 1460 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1461 | # {name: "progress scale", double_value: 1.0}] |
| 1462 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1463 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1464 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1465 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1466 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1467 | }, |
| 1468 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1469 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1470 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1471 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1472 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1473 | # or |
| 1474 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1475 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1476 | "zone": "A String", # The name of the Google Compute Engine |
| 1477 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1478 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1479 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1480 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1481 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1482 | "name": "A String", # The server-assigned ID for the operation. |
| 1483 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1484 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1485 | # (e.g., ERROR or DEGRADED). |
| 1486 | "code": "A String", # Machine-friendly representation of the condition |
| 1487 | "message": "A String", # Human-friendly representation of the condition |
| 1488 | }, |
| 1489 | ], |
| 1490 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1491 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1492 | "detail": "A String", # Detailed operation progress, if available. |
| 1493 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1494 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1495 | # (e.g., ERROR or DEGRADED). |
| 1496 | "code": "A String", # Machine-friendly representation of the condition |
| 1497 | "message": "A String", # Human-friendly representation of the condition |
| 1498 | }, |
| 1499 | ], |
| 1500 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1501 | }</pre> |
| 1502 | </div> |
| 1503 | |
| 1504 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1505 | <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] | 1506 | <pre>Deletes the cluster, including the Kubernetes endpoint and all worker |
| 1507 | nodes. |
| 1508 | |
| 1509 | Firewalls and routes that were configured during cluster creation |
| 1510 | are also deleted. |
| 1511 | |
| 1512 | 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] | 1513 | 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] | 1514 | when the cluster was initially created. |
| 1515 | |
| 1516 | Args: |
| 1517 | 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] | 1518 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1519 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1520 | number](https://support.google.com/cloud/answer/6158840). |
| 1521 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1522 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1523 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1524 | cluster resides. This field has been deprecated and replaced by the name |
| 1525 | field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1526 | clusterId: string, Required. Deprecated. The name of the cluster to delete. |
| 1527 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1528 | x__xgafv: string, V1 error format. |
| 1529 | Allowed values |
| 1530 | 1 - v1 error format |
| 1531 | 2 - v2 error format |
| 1532 | |
| 1533 | Returns: |
| 1534 | An object of the form: |
| 1535 | |
| 1536 | { # This operation resource represents operations that may have happened or are |
| 1537 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1538 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1539 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1540 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1541 | "stages": [ # Substages of an operation or a stage. |
| 1542 | # Object with schema name: OperationProgress |
| 1543 | ], |
| 1544 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1545 | # Unset for single-stage operations. |
| 1546 | "status": "A String", # Status of an operation stage. |
| 1547 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1548 | "metrics": [ # Progress metric bundle, for example: |
| 1549 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1550 | # {name: "nodes total", int_value: 32}] |
| 1551 | # or |
| 1552 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1553 | # {name: "progress scale", double_value: 1.0}] |
| 1554 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1555 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1556 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1557 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1558 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1559 | }, |
| 1560 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1561 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1562 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1563 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1564 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1565 | # or |
| 1566 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1567 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1568 | "zone": "A String", # The name of the Google Compute Engine |
| 1569 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1570 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1571 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1572 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1573 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1574 | "name": "A String", # The server-assigned ID for the operation. |
| 1575 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1576 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1577 | # (e.g., ERROR or DEGRADED). |
| 1578 | "code": "A String", # Machine-friendly representation of the condition |
| 1579 | "message": "A String", # Human-friendly representation of the condition |
| 1580 | }, |
| 1581 | ], |
| 1582 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1583 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1584 | "detail": "A String", # Detailed operation progress, if available. |
| 1585 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1586 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1587 | # (e.g., ERROR or DEGRADED). |
| 1588 | "code": "A String", # Machine-friendly representation of the condition |
| 1589 | "message": "A String", # Human-friendly representation of the condition |
| 1590 | }, |
| 1591 | ], |
| 1592 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1593 | }</pre> |
| 1594 | </div> |
| 1595 | |
| 1596 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1597 | <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] | 1598 | <pre>Gets the details for a specific cluster. |
| 1599 | |
| 1600 | Args: |
| 1601 | 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] | 1602 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1603 | clusterId: string, Required. Deprecated. The name of the cluster to retrieve. |
| 1604 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1605 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1606 | number](https://support.google.com/cloud/answer/6158840). |
| 1607 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1608 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1609 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1610 | cluster resides. This field has been deprecated and replaced by the name |
| 1611 | field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1612 | x__xgafv: string, V1 error format. |
| 1613 | Allowed values |
| 1614 | 1 - v1 error format |
| 1615 | 2 - v2 error format |
| 1616 | |
| 1617 | Returns: |
| 1618 | An object of the form: |
| 1619 | |
| 1620 | { # A Google Kubernetes Engine cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1621 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 1622 | # cluster, enabling additional functionality. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1623 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 1624 | # extension to manage hosted GCP services through the Kubernetes API |
| 1625 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1626 | }, |
| 1627 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 1628 | # enabled at cluster creation time. |
| 1629 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 1630 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1631 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 1632 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1633 | }, |
| 1634 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 1635 | # is enabled or not on the Master, it does not track whether network policy |
| 1636 | # is enabled for the nodes. |
| 1637 | # is enabled or not on the Master, it does not track whether network policy |
| 1638 | # is enabled for the nodes. |
| 1639 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 1640 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1641 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 1642 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 1643 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 1644 | # workloads and applications. For more information, see: |
| 1645 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 1646 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1647 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1648 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 1649 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 1650 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 1651 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 1652 | # When enabled, it runs a small pod in the cluster that manages the load |
| 1653 | # balancers. |
| 1654 | }, |
| 1655 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 1656 | # microservices. |
| 1657 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 1658 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1659 | }, |
| 1660 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 1661 | # increases or decreases the number of replica pods a replication controller |
| 1662 | # has based on the resource usage of the existing pods. |
| 1663 | # increases or decreases the number of replica pods a replication controller |
| 1664 | # has based on the resource usage of the existing pods. |
| 1665 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 1666 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 1667 | # Monitoring. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1668 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1669 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 1670 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 1671 | # at cluster creation time. |
| 1672 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 1673 | }, |
| 1674 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 1675 | # applications. |
| 1676 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 1677 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1678 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1679 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 1680 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1681 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 1682 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1683 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 1684 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 1685 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 1686 | # mode. |
| 1687 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 1688 | # identities in the system, including service accounts, nodes, and |
| 1689 | # controllers, will have statically granted permissions beyond those |
| 1690 | # provided by the RBAC configuration or IAM. |
| 1691 | }, |
| 1692 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 1693 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 1694 | # images will be validated by Google Binauthz. |
| 1695 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1696 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 1697 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 1698 | # instead. The current version of the node software components. |
| 1699 | # If they are currently at multiple versions because they're in the process |
| 1700 | # of being upgraded, this reflects the minimum version of all nodes. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1701 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 1702 | # Call Kubernetes API directly to retrieve node information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1703 | "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] | 1704 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1705 | # will be automatically chosen with the default size. |
| 1706 | # |
| 1707 | # This field is only applicable when `use_ip_aliases` is true. |
| 1708 | # |
| 1709 | # Set to blank to have a range chosen with the default size. |
| 1710 | # |
| 1711 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1712 | # netmask. |
| 1713 | # |
| 1714 | # Set to a |
| 1715 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1716 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1717 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1718 | # to use. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1719 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1720 | "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] | 1721 | # range will be automatically chosen with the default size. |
| 1722 | # |
| 1723 | # This field is only applicable when `use_ip_aliases` is true. |
| 1724 | # |
| 1725 | # If unspecified, the range will use the default size. |
| 1726 | # |
| 1727 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1728 | # netmask. |
| 1729 | # |
| 1730 | # Set to a |
| 1731 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1732 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1733 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1734 | # to use. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1735 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1736 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 1737 | # This is used in conjunction with use_routes. It cannot |
| 1738 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 1739 | # false, then the server picks the default IP allocation mode |
| 1740 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 1741 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 1742 | # |
| 1743 | # This field is only applicable when `use_ip_aliases` is true. |
| 1744 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 1745 | # block. The secondary range will be used for pod IP |
| 1746 | # addresses. This must be an existing secondary range associated |
| 1747 | # with the cluster subnetwork. |
| 1748 | # |
| 1749 | # This field is only applicable with use_ip_aliases and |
| 1750 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1751 | "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] | 1752 | # CIDR block. The secondary range will be used for service |
| 1753 | # ClusterIPs. This must be an existing secondary range associated |
| 1754 | # with the cluster subnetwork. |
| 1755 | # |
| 1756 | # This field is only applicable with use_ip_aliases and |
| 1757 | # create_subnetwork is false. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1758 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 1759 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 1760 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 1761 | # then the server picks the default IP allocation mode |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1762 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 1763 | # this field is empty, then an automatic name will be chosen for the new |
| 1764 | # subnetwork. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1765 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 1766 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 1767 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 1768 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 1769 | # range. |
| 1770 | # |
| 1771 | # If this field is set to true, then cluster and services CIDRs must be |
| 1772 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 1773 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 1774 | # `services_ipv4_cidr_block` must be fully-specified. |
| 1775 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 1776 | # fully-specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1777 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1778 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| 1779 | # |
| 1780 | # This is applicable only if `create_subnetwork` is true. |
| 1781 | # |
| 1782 | # Set to blank to have a range chosen with the default size. |
| 1783 | # |
| 1784 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1785 | # netmask. |
| 1786 | # |
| 1787 | # Set to a |
| 1788 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1789 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1790 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1791 | # to use. |
| 1792 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 1793 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| 1794 | # |
| 1795 | # This field is only applicable when `use_ip_aliases` is true. |
| 1796 | # |
| 1797 | # Set to blank to have a range chosen with the default size. |
| 1798 | # |
| 1799 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1800 | # netmask. |
| 1801 | # |
| 1802 | # Set to a |
| 1803 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1804 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1805 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1806 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1807 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1808 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 1809 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 1810 | "provider": "A String", # The selected network policy provider. |
| 1811 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 1812 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1813 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 1814 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 1815 | # given only RFC 1918 private addresses and communicate with the master via |
| 1816 | # private networking. |
| 1817 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 1818 | # range will be used for assigning internal IP addresses to the master or |
| 1819 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 1820 | # any other ranges in use within the cluster's network. |
| 1821 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 1822 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 1823 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 1824 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 1825 | "enabled": True or False, # Whenever master is accessible globally or not. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1826 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1827 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 1828 | }, |
| 1829 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 1830 | # This field is deprecated, use tpu_config.enabled instead. |
| 1831 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 1832 | # policies. |
| 1833 | # policies. |
| 1834 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 1835 | "identityProvider": "A String", # identity provider is the third party identity provider. |
| 1836 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 1837 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1838 | "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] | 1839 | # Currently available options: |
| 1840 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1841 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1842 | # service with a Kubernetes-native resource model |
| 1843 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 1844 | # longer available as of GKE 1.15). |
| 1845 | # * `none` - No metrics will be exported from the cluster. |
| 1846 | # |
| 1847 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 1848 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1849 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 1850 | "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules |
| 1851 | # will be disabled when default_snat_status is disabled. When disabled is set |
| 1852 | # to false, default IP masquerade rules will be applied to the nodes to |
| 1853 | # prevent sNAT on cluster internal traffic. |
| 1854 | # be disabled on the cluster. |
| 1855 | "disabled": True or False, # Disables cluster default sNAT rules. |
| 1856 | }, |
| 1857 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 1858 | # This makes same node pod to pod traffic visible for VPC network. |
| 1859 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 1860 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 1861 | # cluster is connected. Example: |
| 1862 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 1863 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 1864 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1865 | # to which the cluster is connected. Example: |
| 1866 | # projects/my-project/global/networks/my-network |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1867 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1868 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 1869 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1870 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1871 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 1872 | # If unspecified, the defaults are used: |
| 1873 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 1874 | # be set to "admin", a random password will be generated, and a client |
| 1875 | # certificate will be issued. |
| 1876 | # Authentication can be done using HTTP basic auth or using client |
| 1877 | # certificates. |
| 1878 | "clusterCaCertificate": "A String", |
| 1879 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 1880 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 1881 | # leaving username unspecified (or setting it to the empty string). |
| 1882 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 1883 | # authenticate to the cluster endpoint. |
| 1884 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 1885 | # Because the master endpoint is open to the Internet, you should create a |
| 1886 | # strong password. If a password is provided for cluster creation, username |
| 1887 | # must be non-empty. |
| 1888 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 1889 | # clusters before v1.12, if no configuration is specified, a client |
| 1890 | # certificate is issued. |
| 1891 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 1892 | }, |
| 1893 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 1894 | # to the cluster endpoint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1895 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1896 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 1897 | # found in validMasterVersions returned by getServerConfig. The version can |
| 1898 | # be upgraded over time; such upgrades are reflected in |
| 1899 | # currentMasterVersion and currentNodeVersion. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1900 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1901 | # Users may specify either explicit versions offered by |
| 1902 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1903 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1904 | # - "latest": picks the highest valid Kubernetes version |
| 1905 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 1906 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 1907 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 1908 | # - "","-": picks the default Kubernetes version |
| 1909 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 1910 | # default have no external IP addresses on the nodes and where nodes and the |
| 1911 | # master communicate over private IP addresses. |
| 1912 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 1913 | # instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1914 | "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] | 1915 | # 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] | 1916 | # "node_pool" object, since this configuration (along with the |
| 1917 | # "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] | 1918 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1919 | # For responses, this field will be populated with the node configuration of |
| 1920 | # the first node pool. (For configuration of each node pool, see |
| 1921 | # `node_pool.config`) |
| 1922 | # |
| 1923 | # If unspecified, the defaults are used. |
| 1924 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1925 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1926 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1927 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1928 | # The following scopes are recommended, but not required, and by default are |
| 1929 | # not included: |
| 1930 | # |
| 1931 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1932 | # persistent storage on your nodes. |
| 1933 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1934 | # communicating with **gcr.io** |
| 1935 | # (the [Google Container |
| 1936 | # Registry](https://cloud.google.com/container-registry/)). |
| 1937 | # |
| 1938 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1939 | # Monitoring are enabled, in which case their required scopes will be added. |
| 1940 | "A String", |
| 1941 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1942 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1943 | # |
| 1944 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1945 | # in length. These are reflected as part of a URL in the metadata server. |
| 1946 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1947 | # metadata keys for the project or be one of the reserved keys: |
| 1948 | # "cluster-location" |
| 1949 | # "cluster-name" |
| 1950 | # "cluster-uid" |
| 1951 | # "configure-sh" |
| 1952 | # "containerd-configure-sh" |
| 1953 | # "enable-oslogin" |
| 1954 | # "gci-ensure-gke-docker" |
| 1955 | # "gci-metrics-enabled" |
| 1956 | # "gci-update-strategy" |
| 1957 | # "instance-template" |
| 1958 | # "kube-env" |
| 1959 | # "startup-script" |
| 1960 | # "user-data" |
| 1961 | # "disable-address-manager" |
| 1962 | # "windows-startup-script-ps1" |
| 1963 | # "common-psm1" |
| 1964 | # "k8s-node-setup-psm1" |
| 1965 | # "install-ssh-psm1" |
| 1966 | # "user-profile-psm1" |
| 1967 | # "serial-port-logging-enable" |
| 1968 | # Values are free-form strings, and only have meaning as interpreted by |
| 1969 | # the image running in the instance. The only restriction placed on them is |
| 1970 | # that each value's size must be less than or equal to 32 KB. |
| 1971 | # |
| 1972 | # The total size of all keys and values must be less than 512 KB. |
| 1973 | "a_key": "A String", |
| 1974 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1975 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1976 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1977 | # `n1-standard-1`). |
| 1978 | # |
| 1979 | # If unspecified, the default machine type is |
| 1980 | # `n1-standard-1`. |
| 1981 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 1982 | # pool to run on the specified node group. This is useful for running |
| 1983 | # workloads on [sole tenant |
| 1984 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 1985 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 1986 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1987 | # |
| 1988 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1989 | # verifying the digital signature of all boot components, and halting the |
| 1990 | # boot process if signature verification fails. |
| 1991 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1992 | # |
| 1993 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1994 | # The attestation is performed against the integrity policy baseline. This |
| 1995 | # baseline is initially derived from the implicitly trusted boot image when |
| 1996 | # the instance is created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1997 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1998 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1999 | # Specify the email address of the Service Account; otherwise, if no Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2000 | # Account is specified, the "default" service account is used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2001 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 2002 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 2003 | # on the nodes. |
| 2004 | # |
| 2005 | # The following parameters are supported. |
| 2006 | # |
| 2007 | # net.core.netdev_max_backlog |
| 2008 | # net.core.rmem_max |
| 2009 | # net.core.wmem_default |
| 2010 | # net.core.wmem_max |
| 2011 | # net.core.optmem_max |
| 2012 | # net.core.somaxconn |
| 2013 | # net.ipv4.tcp_rmem |
| 2014 | # net.ipv4.tcp_wmem |
| 2015 | # net.ipv4.tcp_tw_reuse |
| 2016 | "a_key": "A String", |
| 2017 | }, |
| 2018 | }, |
| 2019 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2020 | "type": "A String", # Type of the sandbox to use for the node. |
| 2021 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 2022 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2023 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2024 | # |
| 2025 | # For more information, including usage and the valid values, see: |
| 2026 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2027 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2028 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2029 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2030 | # See |
| 2031 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2032 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2033 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2034 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2035 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2036 | }, |
| 2037 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2038 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 2039 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 2040 | # |
| 2041 | # The string must be a sequence of decimal numbers, each with optional |
| 2042 | # fraction and a unit suffix, such as "300ms". |
| 2043 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 2044 | # The value must be a positive duration. |
| 2045 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 2046 | # |
| 2047 | # If this option is enabled, kubelet uses CFS quota |
| 2048 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 2049 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 2050 | # all. |
| 2051 | # |
| 2052 | # Disable this option to mitigate CPU throttling problems while still having |
| 2053 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 2054 | # |
| 2055 | # The default value is 'true' if unspecified. |
| 2056 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 2057 | # See |
| 2058 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 2059 | # |
| 2060 | # The following values are allowed. |
| 2061 | # - "none": the default, which represents the existing scheduling behavior. |
| 2062 | # - "static": allows pods with certain resource characteristics to be |
| 2063 | # granted increased CPU affinity and exclusivity on the node. |
| 2064 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2065 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2066 | # These will added in addition to any default label(s) that |
| 2067 | # Kubernetes may apply to the node. |
| 2068 | # In case of conflict in label keys, the applied set may differ depending on |
| 2069 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2070 | # and conflicts should be avoided. |
| 2071 | # For more information, including usage and the valid values, see: |
| 2072 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2073 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2074 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2075 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2076 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2077 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2078 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2079 | # workloads on the node pool. |
| 2080 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 2081 | # workloads running on the node. |
| 2082 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2083 | # on the node pool. |
| 2084 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2085 | "bootDiskKmsKey": "A String", # |
| 2086 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 2087 | # to each node in the node pool. This should be of the form |
| 2088 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 2089 | # For more information about protecting resources with Cloud KMS Keys please |
| 2090 | # see: |
| 2091 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2092 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2093 | # The smallest allowed disk size is 10GB. |
| 2094 | # |
| 2095 | # If unspecified, the default disk size is 100GB. |
| 2096 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2097 | # the specified [Zonal Compute |
| 2098 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2099 | # to this node pool. |
| 2100 | # is the configuration of desired reservation which instances could take |
| 2101 | # capacity from. |
| 2102 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 2103 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2104 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2105 | # the key and specify the name of your reservation as its value. |
| 2106 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2107 | "A String", |
| 2108 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2109 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2110 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2111 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2112 | # inforamtion about preemptible VM instances. |
| 2113 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2114 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2115 | # friendly names of CPU platforms, such as |
| 2116 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2117 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2118 | # information, read [how to specify min CPU |
| 2119 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2120 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 2121 | # valid sources or targets for network firewalls and are specified by |
| 2122 | # the client during cluster or node pool creation. Each tag within the list |
| 2123 | # must comply with RFC1035. |
| 2124 | "A String", |
| 2125 | ], |
| 2126 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2127 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2128 | # support for GPUs. |
| 2129 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 2130 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 2131 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2132 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 2133 | }, |
| 2134 | ], |
| 2135 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 2136 | # |
| 2137 | # The limit for this value is dependent upon the maximum number of |
| 2138 | # disks available on a machine per zone. See: |
| 2139 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 2140 | # for more information. |
| 2141 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2142 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2143 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2144 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 2145 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 2146 | # master authorized networks will disallow all external traffic to access |
| 2147 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 2148 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 2149 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 2150 | # Kubernetes master through HTTPS. |
| 2151 | { # CidrBlock contains an optional name and one CIDR block. |
| 2152 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 2153 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 2154 | }, |
| 2155 | ], |
| 2156 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 2157 | }, |
| 2158 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 2159 | # this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2160 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2161 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 2162 | # typically put in the last `/16` from the container CIDR. |
| 2163 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 2164 | # This prefix will be used for assigning private IP addresses to the |
| 2165 | # master or set of masters, as well as the ILB VIP. |
| 2166 | # This field is deprecated, use |
| 2167 | # private_cluster_config.master_ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2168 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 2169 | # required by Cluster Autoscaler to automatically adjust |
| 2170 | # the size of the cluster and create/delete |
| 2171 | # node pools based on the current needs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2172 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 2173 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 2174 | # created by NAP. |
| 2175 | # by NAP. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2176 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2177 | # disruption caused by an upgrade. |
| 2178 | # |
| 2179 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2180 | # unavailable. |
| 2181 | # |
| 2182 | # maxSurge controls the number of additional nodes that can be added to the |
| 2183 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2184 | # available nodes. |
| 2185 | # |
| 2186 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2187 | # nodes are being upgraded at the same time). |
| 2188 | # |
| 2189 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2190 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2191 | # this holds true. (Disruption stays within the limits of |
| 2192 | # PodDisruptionBudget, if it is configured.) |
| 2193 | # |
| 2194 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2195 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2196 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2197 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2198 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2199 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 2200 | # the upgrade process. A node is considered available if its status is |
| 2201 | # Ready. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2202 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2203 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2204 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2205 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2206 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2207 | # Account is specified, the "default" service account is used. |
| 2208 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2209 | # node VMs under the "default" service account. |
| 2210 | # |
| 2211 | # The following scopes are recommended, but not required, and by default are |
| 2212 | # not included: |
| 2213 | # |
| 2214 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2215 | # persistent storage on your nodes. |
| 2216 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2217 | # communicating with **gcr.io** |
| 2218 | # (the [Google Container |
| 2219 | # Registry](https://cloud.google.com/container-registry/)). |
| 2220 | # |
| 2221 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2222 | # Monitoring are enabled, in which case their required scopes will be added. |
| 2223 | "A String", |
| 2224 | ], |
| 2225 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2226 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2227 | # friendly names of CPU platforms, such as |
| 2228 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2229 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2230 | # information, read [how to specify min CPU |
| 2231 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2232 | # To unset the min cpu platform field pass "automatic" |
| 2233 | # as field value. |
| 2234 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 2235 | # node pool. |
| 2236 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 2237 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 2238 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2239 | # the Auto Upgrades will proceed. |
| 2240 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2241 | # with the description of the upgrade. |
| 2242 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2243 | # with the approximate start time for the upgrades, in |
| 2244 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2245 | }, |
| 2246 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2247 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2248 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 2249 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 2250 | # amount of resources in the cluster. |
| 2251 | { # Contains information about amount of some resource in the cluster. |
| 2252 | # For memory, value should be in GB. |
| 2253 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 2254 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 2255 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 2256 | }, |
| 2257 | ], |
| 2258 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 2259 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2260 | # NodePool's nodes can be created by NAP. |
| 2261 | "A String", |
| 2262 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2263 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2264 | "locations": [ # The list of Google Compute Engine |
| 2265 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2266 | # cluster's nodes should be located. |
| 2267 | "A String", |
| 2268 | ], |
| 2269 | "conditions": [ # Which conditions caused the current cluster state. |
| 2270 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2271 | # (e.g., ERROR or DEGRADED). |
| 2272 | "code": "A String", # Machine-friendly representation of the condition |
| 2273 | "message": "A String", # Human-friendly representation of the condition |
| 2274 | }, |
| 2275 | ], |
| 2276 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 2277 | # Currently available options: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2278 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2279 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 2280 | # service with a Kubernetes-native resource model |
| 2281 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 2282 | # available as of GKE 1.15). |
| 2283 | # * `none` - no logs will be exported from the cluster. |
| 2284 | # |
| 2285 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 2286 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 2287 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 2288 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 2289 | # the kubernetes version of the master and nodes. |
| 2290 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 2291 | # Alpha enabled clusters are automatically deleted thirty days after |
| 2292 | # creation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2293 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 2294 | "A String", |
| 2295 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2296 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 2297 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 2298 | # the following restrictions: |
| 2299 | # |
| 2300 | # * Lowercase letters, numbers, and hyphens only. |
| 2301 | # * Must start with a letter. |
| 2302 | # * Must end with a number or a letter. |
| 2303 | "master": { # Master is the configuration for components on master. # Configuration for master components. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2304 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2305 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 2306 | # The endpoint can be accessed from the internet at |
| 2307 | # `https://username:password@endpoint/`. |
| 2308 | # |
| 2309 | # See the `masterAuth` property of this resource for username and |
| 2310 | # password information. |
| 2311 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 2312 | # disabled when this config unspecified. |
| 2313 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 2314 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 2315 | # second BigQuery table will be created to hold resource consumption |
| 2316 | # records. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2317 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2318 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 2319 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 2320 | }, |
| 2321 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 2322 | # daemonset will be created in the cluster to meter network egress traffic. |
| 2323 | }, |
| 2324 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 2325 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2326 | # or |
| 2327 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2328 | # in which the cluster resides. |
| 2329 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 2330 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 2331 | # if enabled = true. |
| 2332 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 2333 | # during authentication using a group of security groups. |
| 2334 | }, |
| 2335 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 2336 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 2337 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 2338 | # the name. |
| 2339 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 2340 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 2341 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| 2342 | # maintenance to occur. The time windows may be overlapping. If no |
| 2343 | # maintenance windows are set, maintenance can occur at any time. |
| 2344 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| 2345 | # this window reccurs. They go on for the span of time between the start and |
| 2346 | # end time. |
| 2347 | # |
| 2348 | # For example, to have something repeat every weekday, you'd use: |
| 2349 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 2350 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 2351 | # <code>FREQ=DAILY</code> |
| 2352 | # For the first weekend of every month: |
| 2353 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 2354 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| 2355 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| 2356 | # <code> |
| 2357 | # start time = 2019-01-01T09:00:00-0400 |
| 2358 | # end time = 2019-01-01T17:00:00-0400 |
| 2359 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 2360 | # </code> |
| 2361 | # Windows can span multiple days. Eg, to make the window encompass every |
| 2362 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 2363 | # <code> |
| 2364 | # start time = 2019-01-05T00:00:00Z |
| 2365 | # end time = 2019-01-07T23:59:00Z |
| 2366 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 2367 | # </code> |
| 2368 | # Note the start and end time's specific dates are largely arbitrary except |
| 2369 | # to specify duration of the window and when it first starts. |
| 2370 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| 2371 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 2372 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2373 | # start time. |
| 2374 | "startTime": "A String", # The time that the window first starts. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2375 | }, |
| 2376 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2377 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 2378 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 2379 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 2380 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 2381 | # smallest possible in the given scenario. |
| 2382 | }, |
| 2383 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 2384 | # occur in these windows. |
| 2385 | "a_key": { # Represents an arbitrary window of time. |
| 2386 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2387 | # start time. |
| 2388 | "startTime": "A String", # The time that the window first starts. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2389 | }, |
| 2390 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2391 | }, |
| 2392 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 2393 | # the policy won't accidentally undo intermediate changes (and so that users |
| 2394 | # of the API unaware of some fields won't accidentally remove other fields). |
| 2395 | # Make a <code>get()</code> request to the cluster to get the current |
| 2396 | # resource version and include it with requests to set the policy. |
| 2397 | }, |
| 2398 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 2399 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 2400 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 2401 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 2402 | }, |
| 2403 | "nodePools": [ # The node pools associated with this cluster. |
| 2404 | # This field should not be set if "node_config" or "initial_node_count" are |
| 2405 | # specified. |
| 2406 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 2407 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| 2408 | # specification, under the control of the cluster master. They may have a set |
| 2409 | # of Kubernetes labels applied to them, which may be used to reference them |
| 2410 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 2411 | # the workload. |
| 2412 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 2413 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 2414 | # disruption caused by an upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2415 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2416 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2417 | # unavailable. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2418 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2419 | # maxSurge controls the number of additional nodes that can be added to the |
| 2420 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2421 | # available nodes. |
| 2422 | # |
| 2423 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2424 | # nodes are being upgraded at the same time). |
| 2425 | # |
| 2426 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2427 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2428 | # this holds true. (Disruption stays within the limits of |
| 2429 | # PodDisruptionBudget, if it is configured.) |
| 2430 | # |
| 2431 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2432 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2433 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2434 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2435 | # there are always at least 4 nodes available. |
| 2436 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 2437 | # the upgrade process. A node is considered available if its status is |
| 2438 | # Ready. |
| 2439 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2440 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2441 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2442 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 2443 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 2444 | # associated with this node pool. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2445 | "A String", |
| 2446 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2447 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 2448 | # only if a valid configuration is present. |
| 2449 | # adjust the size of the node pool to the current cluster usage. |
| 2450 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 2451 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 2452 | # max_node_count. |
| 2453 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 2454 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 2455 | # has to enough quota to scale up the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2456 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2457 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 2458 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 2459 | # is sufficient for this number of instances. You must also have available |
| 2460 | # firewall and routes quota. |
| 2461 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 2462 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2463 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2464 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2465 | # The following scopes are recommended, but not required, and by default are |
| 2466 | # not included: |
| 2467 | # |
| 2468 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2469 | # persistent storage on your nodes. |
| 2470 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2471 | # communicating with **gcr.io** |
| 2472 | # (the [Google Container |
| 2473 | # Registry](https://cloud.google.com/container-registry/)). |
| 2474 | # |
| 2475 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2476 | # Monitoring are enabled, in which case their required scopes will be added. |
| 2477 | "A String", |
| 2478 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2479 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 2480 | # |
| 2481 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2482 | # in length. These are reflected as part of a URL in the metadata server. |
| 2483 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2484 | # metadata keys for the project or be one of the reserved keys: |
| 2485 | # "cluster-location" |
| 2486 | # "cluster-name" |
| 2487 | # "cluster-uid" |
| 2488 | # "configure-sh" |
| 2489 | # "containerd-configure-sh" |
| 2490 | # "enable-oslogin" |
| 2491 | # "gci-ensure-gke-docker" |
| 2492 | # "gci-metrics-enabled" |
| 2493 | # "gci-update-strategy" |
| 2494 | # "instance-template" |
| 2495 | # "kube-env" |
| 2496 | # "startup-script" |
| 2497 | # "user-data" |
| 2498 | # "disable-address-manager" |
| 2499 | # "windows-startup-script-ps1" |
| 2500 | # "common-psm1" |
| 2501 | # "k8s-node-setup-psm1" |
| 2502 | # "install-ssh-psm1" |
| 2503 | # "user-profile-psm1" |
| 2504 | # "serial-port-logging-enable" |
| 2505 | # Values are free-form strings, and only have meaning as interpreted by |
| 2506 | # the image running in the instance. The only restriction placed on them is |
| 2507 | # that each value's size must be less than or equal to 32 KB. |
| 2508 | # |
| 2509 | # The total size of all keys and values must be less than 512 KB. |
| 2510 | "a_key": "A String", |
| 2511 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2512 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 2513 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 2514 | # `n1-standard-1`). |
| 2515 | # |
| 2516 | # If unspecified, the default machine type is |
| 2517 | # `n1-standard-1`. |
| 2518 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 2519 | # pool to run on the specified node group. This is useful for running |
| 2520 | # workloads on [sole tenant |
| 2521 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 2522 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 2523 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2524 | # |
| 2525 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2526 | # verifying the digital signature of all boot components, and halting the |
| 2527 | # boot process if signature verification fails. |
| 2528 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 2529 | # |
| 2530 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2531 | # The attestation is performed against the integrity policy baseline. This |
| 2532 | # baseline is initially derived from the implicitly trusted boot image when |
| 2533 | # the instance is created. |
| 2534 | }, |
| 2535 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2536 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2537 | # Account is specified, the "default" service account is used. |
| 2538 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 2539 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 2540 | # on the nodes. |
| 2541 | # |
| 2542 | # The following parameters are supported. |
| 2543 | # |
| 2544 | # net.core.netdev_max_backlog |
| 2545 | # net.core.rmem_max |
| 2546 | # net.core.wmem_default |
| 2547 | # net.core.wmem_max |
| 2548 | # net.core.optmem_max |
| 2549 | # net.core.somaxconn |
| 2550 | # net.ipv4.tcp_rmem |
| 2551 | # net.ipv4.tcp_wmem |
| 2552 | # net.ipv4.tcp_tw_reuse |
| 2553 | "a_key": "A String", |
| 2554 | }, |
| 2555 | }, |
| 2556 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2557 | "type": "A String", # Type of the sandbox to use for the node. |
| 2558 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 2559 | }, |
| 2560 | "taints": [ # List of kubernetes taints to be applied to each node. |
| 2561 | # |
| 2562 | # For more information, including usage and the valid values, see: |
| 2563 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2564 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2565 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2566 | # |
| 2567 | # See |
| 2568 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2569 | # for more information, including usage and the valid values. |
| 2570 | "effect": "A String", # Effect for taint. |
| 2571 | "key": "A String", # Key for taint. |
| 2572 | "value": "A String", # Value for taint. |
| 2573 | }, |
| 2574 | ], |
| 2575 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 2576 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 2577 | # |
| 2578 | # The string must be a sequence of decimal numbers, each with optional |
| 2579 | # fraction and a unit suffix, such as "300ms". |
| 2580 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 2581 | # The value must be a positive duration. |
| 2582 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 2583 | # |
| 2584 | # If this option is enabled, kubelet uses CFS quota |
| 2585 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 2586 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 2587 | # all. |
| 2588 | # |
| 2589 | # Disable this option to mitigate CPU throttling problems while still having |
| 2590 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 2591 | # |
| 2592 | # The default value is 'true' if unspecified. |
| 2593 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 2594 | # See |
| 2595 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 2596 | # |
| 2597 | # The following values are allowed. |
| 2598 | # - "none": the default, which represents the existing scheduling behavior. |
| 2599 | # - "static": allows pods with certain resource characteristics to be |
| 2600 | # granted increased CPU affinity and exclusivity on the node. |
| 2601 | }, |
| 2602 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2603 | # These will added in addition to any default label(s) that |
| 2604 | # Kubernetes may apply to the node. |
| 2605 | # In case of conflict in label keys, the applied set may differ depending on |
| 2606 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2607 | # and conflicts should be avoided. |
| 2608 | # For more information, including usage and the valid values, see: |
| 2609 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2610 | "a_key": "A String", |
| 2611 | }, |
| 2612 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2613 | # |
| 2614 | # If unspecified, the default disk type is 'pd-standard' |
| 2615 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2616 | # workloads on the node pool. |
| 2617 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 2618 | # workloads running on the node. |
| 2619 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2620 | # on the node pool. |
| 2621 | }, |
| 2622 | "bootDiskKmsKey": "A String", # |
| 2623 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 2624 | # to each node in the node pool. This should be of the form |
| 2625 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 2626 | # For more information about protecting resources with Cloud KMS Keys please |
| 2627 | # see: |
| 2628 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 2629 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2630 | # The smallest allowed disk size is 10GB. |
| 2631 | # |
| 2632 | # If unspecified, the default disk size is 100GB. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2633 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2634 | # the specified [Zonal Compute |
| 2635 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2636 | # to this node pool. |
| 2637 | # is the configuration of desired reservation which instances could take |
| 2638 | # capacity from. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2639 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2640 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2641 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2642 | # the key and specify the name of your reservation as its value. |
| 2643 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2644 | "A String", |
| 2645 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2646 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2647 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2648 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2649 | # inforamtion about preemptible VM instances. |
| 2650 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2651 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2652 | # friendly names of CPU platforms, such as |
| 2653 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2654 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2655 | # information, read [how to specify min CPU |
| 2656 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2657 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2658 | # valid sources or targets for network firewalls and are specified by |
| 2659 | # the client during cluster or node pool creation. Each tag within the list |
| 2660 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2661 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2662 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2663 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2664 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2665 | # support for GPUs. |
| 2666 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 2667 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 2668 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2669 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 2670 | }, |
| 2671 | ], |
| 2672 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 2673 | # |
| 2674 | # The limit for this value is dependent upon the maximum number of |
| 2675 | # disks available on a machine per zone. See: |
| 2676 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 2677 | # for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2678 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2679 | # the latest version of it will be used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2680 | }, |
| 2681 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2682 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 2683 | # node pool. |
| 2684 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 2685 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 2686 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2687 | # the Auto Upgrades will proceed. |
| 2688 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2689 | # with the description of the upgrade. |
| 2690 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2691 | # with the approximate start time for the upgrades, in |
| 2692 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2693 | }, |
| 2694 | }, |
| 2695 | "name": "A String", # The name of the node pool. |
| 2696 | "version": "A String", # The version of the Kubernetes of this node. |
| 2697 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 2698 | # simultaneously on a node in the node pool. |
| 2699 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2700 | }, |
| 2701 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2702 | # node pool instance, if available. |
| 2703 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 2704 | "conditions": [ # Which conditions caused the current node pool state. |
| 2705 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2706 | # (e.g., ERROR or DEGRADED). |
| 2707 | "code": "A String", # Machine-friendly representation of the condition |
| 2708 | "message": "A String", # Human-friendly representation of the condition |
| 2709 | }, |
| 2710 | ], |
| 2711 | "locations": [ # The list of Google Compute Engine |
| 2712 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2713 | # NodePool's nodes should be located. |
| 2714 | "A String", |
| 2715 | ], |
| 2716 | }, |
| 2717 | ], |
| 2718 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2719 | # cluster, if available. |
| 2720 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 2721 | # subscribed to. Release channels are arranged in order of risk. |
| 2722 | # |
| 2723 | # When a cluster is subscribed to a release channel, Google maintains |
| 2724 | # both the master version and the node version. Node auto-upgrade |
| 2725 | # defaults to true and cannot be disabled. |
| 2726 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 2727 | }, |
| 2728 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2729 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 2730 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 2731 | # if cluster created with IP Alias support. |
| 2732 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2733 | }, |
| 2734 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 2735 | "type": "A String", # Type of the integration. |
| 2736 | }, |
| 2737 | "status": "A String", # [Output only] The current status of this cluster. |
| 2738 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 2739 | # Google Compute Engine resources. |
| 2740 | "a_key": "A String", |
| 2741 | }, |
| 2742 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 2743 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2744 | # notation (e.g. `1.2.3.4/29`). |
| 2745 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 2746 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 2747 | # is sufficient for this number of instances. You must also have available |
| 2748 | # firewall and routes quota. |
| 2749 | # For requests, this field should only be used in lieu of a |
| 2750 | # "node_pool" object, since this configuration (along with the |
| 2751 | # "node_config") will be used to create a "NodePool" object with an |
| 2752 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2753 | # |
| 2754 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 2755 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 2756 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 2757 | # must be valid under a PodSecurityPolicy to be created. |
| 2758 | }, |
| 2759 | "description": "A String", # An optional description of this cluster. |
| 2760 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 2761 | "state": "A String", # Denotes the state of etcd encryption. |
| 2762 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 2763 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 2764 | }, |
| 2765 | "network": "A String", # The name of the Google Compute Engine |
| 2766 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2767 | # to which the cluster is connected. If left unspecified, the `default` |
| 2768 | # network will be used. On output this shows the network ID instead of the |
| 2769 | # name. |
| 2770 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 2771 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2772 | # cluster resides. This field is deprecated, use location instead. |
| 2773 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 2774 | # required by Vertical Pod Autoscaler to automatically adjust |
| 2775 | # the resources of pods controlled by it. |
| 2776 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 2777 | }, |
| 2778 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 2779 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2780 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| 2781 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 2782 | # range. This field will only be set when cluster is in route-based network |
| 2783 | # mode. |
| 2784 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 2785 | }</pre> |
| 2786 | </div> |
| 2787 | |
| 2788 | <div class="method"> |
| 2789 | <code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code> |
| 2790 | <pre>Gets the public component of the cluster signing keys in |
| 2791 | JSON Web Key format. |
| 2792 | This API is not yet intended for general use, and is not available for all |
| 2793 | clusters. |
| 2794 | |
| 2795 | Args: |
| 2796 | parent: string, The cluster (project, location, cluster id) to get keys for. Specified in |
| 2797 | the format `projects/*/locations/*/clusters/*`. (required) |
| 2798 | x__xgafv: string, V1 error format. |
| 2799 | Allowed values |
| 2800 | 1 - v1 error format |
| 2801 | 2 - v2 error format |
| 2802 | |
| 2803 | Returns: |
| 2804 | An object of the form: |
| 2805 | |
| 2806 | { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 |
| 2807 | "cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP |
| 2808 | # Cache-Control header. |
| 2809 | "directive": "A String", # 14.9 request and response directives |
| 2810 | "expires": "A String", # 14.21 response cache expires, in RFC 1123 date format |
| 2811 | "age": "A String", # 14.6 response cache age, in seconds since the response is generated |
| 2812 | }, |
| 2813 | "keys": [ # The public component of the keys used by the cluster to sign token |
| 2814 | # requests. |
| 2815 | { # Jwk is a JSON Web Key as specified in RFC 7517 |
| 2816 | "n": "A String", # Used for RSA keys. |
| 2817 | "use": "A String", # Permitted uses for the public keys. |
| 2818 | "e": "A String", # Used for RSA keys. |
| 2819 | "y": "A String", # Used for ECDSA keys. |
| 2820 | "x": "A String", # Used for ECDSA keys. |
| 2821 | "crv": "A String", # Used for ECDSA keys. |
| 2822 | "alg": "A String", # Algorithm. |
| 2823 | "kty": "A String", # Key Type. |
| 2824 | "kid": "A String", # Key ID. |
| 2825 | }, |
| 2826 | ], |
| 2827 | }</pre> |
| 2828 | </div> |
| 2829 | |
| 2830 | <div class="method"> |
| 2831 | <code class="details" id="list">list(parent, zone=None, projectId=None, x__xgafv=None)</code> |
| 2832 | <pre>Lists all clusters owned by a project in either the specified zone or all |
| 2833 | zones. |
| 2834 | |
| 2835 | Args: |
| 2836 | parent: string, The parent (project and location) where the clusters will be listed. |
| 2837 | Specified in the format `projects/*/locations/*`. |
| 2838 | Location "-" matches all zones and all regions. (required) |
| 2839 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 2840 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2841 | cluster resides, or "-" for all zones. This field has been deprecated and |
| 2842 | replaced by the parent field. |
| 2843 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| 2844 | number](https://support.google.com/cloud/answer/6158840). |
| 2845 | This field has been deprecated and replaced by the parent field. |
| 2846 | x__xgafv: string, V1 error format. |
| 2847 | Allowed values |
| 2848 | 1 - v1 error format |
| 2849 | 2 - v2 error format |
| 2850 | |
| 2851 | Returns: |
| 2852 | An object of the form: |
| 2853 | |
| 2854 | { # ListClustersResponse is the result of ListClustersRequest. |
| 2855 | "missingZones": [ # If any zones are listed here, the list of clusters returned |
| 2856 | # may be missing those zones. |
| 2857 | "A String", |
| 2858 | ], |
| 2859 | "clusters": [ # A list of clusters in the project in the specified zone, or |
| 2860 | # across all ones. |
| 2861 | { # A Google Kubernetes Engine cluster. |
| 2862 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 2863 | # cluster, enabling additional functionality. |
| 2864 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 2865 | # extension to manage hosted GCP services through the Kubernetes API |
| 2866 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 2867 | }, |
| 2868 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 2869 | # enabled at cluster creation time. |
| 2870 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 2871 | }, |
| 2872 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 2873 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 2874 | }, |
| 2875 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 2876 | # is enabled or not on the Master, it does not track whether network policy |
| 2877 | # is enabled for the nodes. |
| 2878 | # is enabled or not on the Master, it does not track whether network policy |
| 2879 | # is enabled for the nodes. |
| 2880 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 2881 | }, |
| 2882 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 2883 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 2884 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 2885 | # workloads and applications. For more information, see: |
| 2886 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 2887 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 2888 | }, |
| 2889 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 2890 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 2891 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 2892 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 2893 | # When enabled, it runs a small pod in the cluster that manages the load |
| 2894 | # balancers. |
| 2895 | }, |
| 2896 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 2897 | # microservices. |
| 2898 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 2899 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 2900 | }, |
| 2901 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 2902 | # increases or decreases the number of replica pods a replication controller |
| 2903 | # has based on the resource usage of the existing pods. |
| 2904 | # increases or decreases the number of replica pods a replication controller |
| 2905 | # has based on the resource usage of the existing pods. |
| 2906 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 2907 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 2908 | # Monitoring. |
| 2909 | }, |
| 2910 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 2911 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 2912 | # at cluster creation time. |
| 2913 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 2914 | }, |
| 2915 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 2916 | # applications. |
| 2917 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 2918 | }, |
| 2919 | }, |
| 2920 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 2921 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2922 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 2923 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2924 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 2925 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 2926 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 2927 | # mode. |
| 2928 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 2929 | # identities in the system, including service accounts, nodes, and |
| 2930 | # controllers, will have statically granted permissions beyond those |
| 2931 | # provided by the RBAC configuration or IAM. |
| 2932 | }, |
| 2933 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 2934 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 2935 | # images will be validated by Google Binauthz. |
| 2936 | }, |
| 2937 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 2938 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 2939 | # instead. The current version of the node software components. |
| 2940 | # If they are currently at multiple versions because they're in the process |
| 2941 | # of being upgraded, this reflects the minimum version of all nodes. |
| 2942 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 2943 | # Call Kubernetes API directly to retrieve node information. |
| 2944 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| 2945 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 2946 | # will be automatically chosen with the default size. |
| 2947 | # |
| 2948 | # This field is only applicable when `use_ip_aliases` is true. |
| 2949 | # |
| 2950 | # Set to blank to have a range chosen with the default size. |
| 2951 | # |
| 2952 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2953 | # netmask. |
| 2954 | # |
| 2955 | # Set to a |
| 2956 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2957 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2958 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2959 | # to use. |
| 2960 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 2961 | "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a |
| 2962 | # range will be automatically chosen with the default size. |
| 2963 | # |
| 2964 | # This field is only applicable when `use_ip_aliases` is true. |
| 2965 | # |
| 2966 | # If unspecified, the range will use the default size. |
| 2967 | # |
| 2968 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2969 | # netmask. |
| 2970 | # |
| 2971 | # Set to a |
| 2972 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2973 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2974 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2975 | # to use. |
| 2976 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| 2977 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 2978 | # This is used in conjunction with use_routes. It cannot |
| 2979 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 2980 | # false, then the server picks the default IP allocation mode |
| 2981 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 2982 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 2983 | # |
| 2984 | # This field is only applicable when `use_ip_aliases` is true. |
| 2985 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 2986 | # block. The secondary range will be used for pod IP |
| 2987 | # addresses. This must be an existing secondary range associated |
| 2988 | # with the cluster subnetwork. |
| 2989 | # |
| 2990 | # This field is only applicable with use_ip_aliases and |
| 2991 | # create_subnetwork is false. |
| 2992 | "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services |
| 2993 | # CIDR block. The secondary range will be used for service |
| 2994 | # ClusterIPs. This must be an existing secondary range associated |
| 2995 | # with the cluster subnetwork. |
| 2996 | # |
| 2997 | # This field is only applicable with use_ip_aliases and |
| 2998 | # create_subnetwork is false. |
| 2999 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 3000 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 3001 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 3002 | # then the server picks the default IP allocation mode |
| 3003 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 3004 | # this field is empty, then an automatic name will be chosen for the new |
| 3005 | # subnetwork. |
| 3006 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 3007 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 3008 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 3009 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 3010 | # range. |
| 3011 | # |
| 3012 | # If this field is set to true, then cluster and services CIDRs must be |
| 3013 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 3014 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 3015 | # `services_ipv4_cidr_block` must be fully-specified. |
| 3016 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 3017 | # fully-specified. |
| 3018 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 3019 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| 3020 | # |
| 3021 | # This is applicable only if `create_subnetwork` is true. |
| 3022 | # |
| 3023 | # Set to blank to have a range chosen with the default size. |
| 3024 | # |
| 3025 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 3026 | # netmask. |
| 3027 | # |
| 3028 | # Set to a |
| 3029 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3030 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 3031 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 3032 | # to use. |
| 3033 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 3034 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| 3035 | # |
| 3036 | # This field is only applicable when `use_ip_aliases` is true. |
| 3037 | # |
| 3038 | # Set to blank to have a range chosen with the default size. |
| 3039 | # |
| 3040 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 3041 | # netmask. |
| 3042 | # |
| 3043 | # Set to a |
| 3044 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3045 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 3046 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 3047 | # to use. |
| 3048 | }, |
| 3049 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 3050 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 3051 | "provider": "A String", # The selected network policy provider. |
| 3052 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 3053 | }, |
| 3054 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 3055 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 3056 | # given only RFC 1918 private addresses and communicate with the master via |
| 3057 | # private networking. |
| 3058 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 3059 | # range will be used for assigning internal IP addresses to the master or |
| 3060 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 3061 | # any other ranges in use within the cluster's network. |
| 3062 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 3063 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 3064 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 3065 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 3066 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 3067 | }, |
| 3068 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 3069 | }, |
| 3070 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 3071 | # This field is deprecated, use tpu_config.enabled instead. |
| 3072 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 3073 | # policies. |
| 3074 | # policies. |
| 3075 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 3076 | "identityProvider": "A String", # identity provider is the third party identity provider. |
| 3077 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 3078 | }, |
| 3079 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| 3080 | # Currently available options: |
| 3081 | # |
| 3082 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| 3083 | # service with a Kubernetes-native resource model |
| 3084 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 3085 | # longer available as of GKE 1.15). |
| 3086 | # * `none` - No metrics will be exported from the cluster. |
| 3087 | # |
| 3088 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 3089 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| 3090 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 3091 | "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules |
| 3092 | # will be disabled when default_snat_status is disabled. When disabled is set |
| 3093 | # to false, default IP masquerade rules will be applied to the nodes to |
| 3094 | # prevent sNAT on cluster internal traffic. |
| 3095 | # be disabled on the cluster. |
| 3096 | "disabled": True or False, # Disables cluster default sNAT rules. |
| 3097 | }, |
| 3098 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 3099 | # This makes same node pod to pod traffic visible for VPC network. |
| 3100 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 3101 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 3102 | # cluster is connected. Example: |
| 3103 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 3104 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 3105 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 3106 | # to which the cluster is connected. Example: |
| 3107 | # projects/my-project/global/networks/my-network |
| 3108 | }, |
| 3109 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 3110 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 3111 | }, |
| 3112 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 3113 | # If unspecified, the defaults are used: |
| 3114 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 3115 | # be set to "admin", a random password will be generated, and a client |
| 3116 | # certificate will be issued. |
| 3117 | # Authentication can be done using HTTP basic auth or using client |
| 3118 | # certificates. |
| 3119 | "clusterCaCertificate": "A String", |
| 3120 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 3121 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 3122 | # leaving username unspecified (or setting it to the empty string). |
| 3123 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 3124 | # authenticate to the cluster endpoint. |
| 3125 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 3126 | # Because the master endpoint is open to the Internet, you should create a |
| 3127 | # strong password. If a password is provided for cluster creation, username |
| 3128 | # must be non-empty. |
| 3129 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 3130 | # clusters before v1.12, if no configuration is specified, a client |
| 3131 | # certificate is issued. |
| 3132 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 3133 | }, |
| 3134 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 3135 | # to the cluster endpoint. |
| 3136 | }, |
| 3137 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 3138 | # found in validMasterVersions returned by getServerConfig. The version can |
| 3139 | # be upgraded over time; such upgrades are reflected in |
| 3140 | # currentMasterVersion and currentNodeVersion. |
| 3141 | # |
| 3142 | # Users may specify either explicit versions offered by |
| 3143 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 3144 | # |
| 3145 | # - "latest": picks the highest valid Kubernetes version |
| 3146 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 3147 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 3148 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 3149 | # - "","-": picks the default Kubernetes version |
| 3150 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 3151 | # default have no external IP addresses on the nodes and where nodes and the |
| 3152 | # master communicate over private IP addresses. |
| 3153 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 3154 | # instead. |
| 3155 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
| 3156 | # For requests, this field should only be used in lieu of a |
| 3157 | # "node_pool" object, since this configuration (along with the |
| 3158 | # "initial_node_count") will be used to create a "NodePool" object with an |
| 3159 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3160 | # For responses, this field will be populated with the node configuration of |
| 3161 | # the first node pool. (For configuration of each node pool, see |
| 3162 | # `node_pool.config`) |
| 3163 | # |
| 3164 | # If unspecified, the defaults are used. |
| 3165 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3166 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3167 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3168 | # |
| 3169 | # The following scopes are recommended, but not required, and by default are |
| 3170 | # not included: |
| 3171 | # |
| 3172 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3173 | # persistent storage on your nodes. |
| 3174 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3175 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3176 | # (the [Google Container |
| 3177 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3178 | # |
| 3179 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3180 | # 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] | 3181 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3182 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3183 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3184 | # |
| 3185 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3186 | # in length. These are reflected as part of a URL in the metadata server. |
| 3187 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3188 | # metadata keys for the project or be one of the reserved keys: |
| 3189 | # "cluster-location" |
| 3190 | # "cluster-name" |
| 3191 | # "cluster-uid" |
| 3192 | # "configure-sh" |
| 3193 | # "containerd-configure-sh" |
| 3194 | # "enable-oslogin" |
| 3195 | # "gci-ensure-gke-docker" |
| 3196 | # "gci-metrics-enabled" |
| 3197 | # "gci-update-strategy" |
| 3198 | # "instance-template" |
| 3199 | # "kube-env" |
| 3200 | # "startup-script" |
| 3201 | # "user-data" |
| 3202 | # "disable-address-manager" |
| 3203 | # "windows-startup-script-ps1" |
| 3204 | # "common-psm1" |
| 3205 | # "k8s-node-setup-psm1" |
| 3206 | # "install-ssh-psm1" |
| 3207 | # "user-profile-psm1" |
| 3208 | # "serial-port-logging-enable" |
| 3209 | # Values are free-form strings, and only have meaning as interpreted by |
| 3210 | # the image running in the instance. The only restriction placed on them is |
| 3211 | # that each value's size must be less than or equal to 32 KB. |
| 3212 | # |
| 3213 | # The total size of all keys and values must be less than 512 KB. |
| 3214 | "a_key": "A String", |
| 3215 | }, |
| 3216 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 3217 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 3218 | # `n1-standard-1`). |
| 3219 | # |
| 3220 | # If unspecified, the default machine type is |
| 3221 | # `n1-standard-1`. |
| 3222 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 3223 | # pool to run on the specified node group. This is useful for running |
| 3224 | # workloads on [sole tenant |
| 3225 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 3226 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 3227 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3228 | # |
| 3229 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3230 | # verifying the digital signature of all boot components, and halting the |
| 3231 | # boot process if signature verification fails. |
| 3232 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 3233 | # |
| 3234 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3235 | # The attestation is performed against the integrity policy baseline. This |
| 3236 | # baseline is initially derived from the implicitly trusted boot image when |
| 3237 | # the instance is created. |
| 3238 | }, |
| 3239 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3240 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3241 | # Account is specified, the "default" service account is used. |
| 3242 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 3243 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 3244 | # on the nodes. |
| 3245 | # |
| 3246 | # The following parameters are supported. |
| 3247 | # |
| 3248 | # net.core.netdev_max_backlog |
| 3249 | # net.core.rmem_max |
| 3250 | # net.core.wmem_default |
| 3251 | # net.core.wmem_max |
| 3252 | # net.core.optmem_max |
| 3253 | # net.core.somaxconn |
| 3254 | # net.ipv4.tcp_rmem |
| 3255 | # net.ipv4.tcp_wmem |
| 3256 | # net.ipv4.tcp_tw_reuse |
| 3257 | "a_key": "A String", |
| 3258 | }, |
| 3259 | }, |
| 3260 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3261 | "type": "A String", # Type of the sandbox to use for the node. |
| 3262 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 3263 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3264 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3265 | # |
| 3266 | # For more information, including usage and the valid values, see: |
| 3267 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3268 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3269 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3270 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3271 | # See |
| 3272 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3273 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3274 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3275 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3276 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3277 | }, |
| 3278 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3279 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 3280 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 3281 | # |
| 3282 | # The string must be a sequence of decimal numbers, each with optional |
| 3283 | # fraction and a unit suffix, such as "300ms". |
| 3284 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 3285 | # The value must be a positive duration. |
| 3286 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 3287 | # |
| 3288 | # If this option is enabled, kubelet uses CFS quota |
| 3289 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 3290 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 3291 | # all. |
| 3292 | # |
| 3293 | # Disable this option to mitigate CPU throttling problems while still having |
| 3294 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 3295 | # |
| 3296 | # The default value is 'true' if unspecified. |
| 3297 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 3298 | # See |
| 3299 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 3300 | # |
| 3301 | # The following values are allowed. |
| 3302 | # - "none": the default, which represents the existing scheduling behavior. |
| 3303 | # - "static": allows pods with certain resource characteristics to be |
| 3304 | # granted increased CPU affinity and exclusivity on the node. |
| 3305 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3306 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3307 | # These will added in addition to any default label(s) that |
| 3308 | # Kubernetes may apply to the node. |
| 3309 | # In case of conflict in label keys, the applied set may differ depending on |
| 3310 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3311 | # and conflicts should be avoided. |
| 3312 | # For more information, including usage and the valid values, see: |
| 3313 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3314 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3315 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3316 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3317 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3318 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3319 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3320 | # workloads on the node pool. |
| 3321 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 3322 | # workloads running on the node. |
| 3323 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3324 | # on the node pool. |
| 3325 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3326 | "bootDiskKmsKey": "A String", # |
| 3327 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 3328 | # to each node in the node pool. This should be of the form |
| 3329 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 3330 | # For more information about protecting resources with Cloud KMS Keys please |
| 3331 | # see: |
| 3332 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3333 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3334 | # The smallest allowed disk size is 10GB. |
| 3335 | # |
| 3336 | # If unspecified, the default disk size is 100GB. |
| 3337 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3338 | # the specified [Zonal Compute |
| 3339 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3340 | # to this node pool. |
| 3341 | # is the configuration of desired reservation which instances could take |
| 3342 | # capacity from. |
| 3343 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 3344 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3345 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3346 | # the key and specify the name of your reservation as its value. |
| 3347 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3348 | "A String", |
| 3349 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3350 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3351 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3352 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3353 | # inforamtion about preemptible VM instances. |
| 3354 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3355 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3356 | # friendly names of CPU platforms, such as |
| 3357 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3358 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3359 | # information, read [how to specify min CPU |
| 3360 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3361 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3362 | # valid sources or targets for network firewalls and are specified by |
| 3363 | # the client during cluster or node pool creation. Each tag within the list |
| 3364 | # must comply with RFC1035. |
| 3365 | "A String", |
| 3366 | ], |
| 3367 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3368 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3369 | # support for GPUs. |
| 3370 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 3371 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 3372 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3373 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 3374 | }, |
| 3375 | ], |
| 3376 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 3377 | # |
| 3378 | # The limit for this value is dependent upon the maximum number of |
| 3379 | # disks available on a machine per zone. See: |
| 3380 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 3381 | # for more information. |
| 3382 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3383 | # the latest version of it will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3384 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3385 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 3386 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 3387 | # master authorized networks will disallow all external traffic to access |
| 3388 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 3389 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 3390 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 3391 | # Kubernetes master through HTTPS. |
| 3392 | { # CidrBlock contains an optional name and one CIDR block. |
| 3393 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 3394 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 3395 | }, |
| 3396 | ], |
| 3397 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 3398 | }, |
| 3399 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 3400 | # this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3401 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3402 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 3403 | # typically put in the last `/16` from the container CIDR. |
| 3404 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 3405 | # This prefix will be used for assigning private IP addresses to the |
| 3406 | # master or set of masters, as well as the ILB VIP. |
| 3407 | # This field is deprecated, use |
| 3408 | # private_cluster_config.master_ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3409 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 3410 | # required by Cluster Autoscaler to automatically adjust |
| 3411 | # the size of the cluster and create/delete |
| 3412 | # node pools based on the current needs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3413 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 3414 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 3415 | # created by NAP. |
| 3416 | # by NAP. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3417 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3418 | # disruption caused by an upgrade. |
| 3419 | # |
| 3420 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 3421 | # unavailable. |
| 3422 | # |
| 3423 | # maxSurge controls the number of additional nodes that can be added to the |
| 3424 | # node pool temporarily for the time of the upgrade to increase the number of |
| 3425 | # available nodes. |
| 3426 | # |
| 3427 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 3428 | # nodes are being upgraded at the same time). |
| 3429 | # |
| 3430 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 3431 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 3432 | # this holds true. (Disruption stays within the limits of |
| 3433 | # PodDisruptionBudget, if it is configured.) |
| 3434 | # |
| 3435 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 3436 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 3437 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 3438 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 3439 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3440 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 3441 | # the upgrade process. A node is considered available if its status is |
| 3442 | # Ready. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3443 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 3444 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3445 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3446 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3447 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3448 | # Account is specified, the "default" service account is used. |
| 3449 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3450 | # node VMs under the "default" service account. |
| 3451 | # |
| 3452 | # The following scopes are recommended, but not required, and by default are |
| 3453 | # not included: |
| 3454 | # |
| 3455 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3456 | # persistent storage on your nodes. |
| 3457 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3458 | # communicating with **gcr.io** |
| 3459 | # (the [Google Container |
| 3460 | # Registry](https://cloud.google.com/container-registry/)). |
| 3461 | # |
| 3462 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3463 | # Monitoring are enabled, in which case their required scopes will be added. |
| 3464 | "A String", |
| 3465 | ], |
| 3466 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3467 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3468 | # friendly names of CPU platforms, such as |
| 3469 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3470 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3471 | # information, read [how to specify min CPU |
| 3472 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3473 | # To unset the min cpu platform field pass "automatic" |
| 3474 | # as field value. |
| 3475 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 3476 | # node pool. |
| 3477 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 3478 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 3479 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3480 | # the Auto Upgrades will proceed. |
| 3481 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3482 | # with the description of the upgrade. |
| 3483 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3484 | # with the approximate start time for the upgrades, in |
| 3485 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3486 | }, |
| 3487 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3488 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3489 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 3490 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 3491 | # amount of resources in the cluster. |
| 3492 | { # Contains information about amount of some resource in the cluster. |
| 3493 | # For memory, value should be in GB. |
| 3494 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 3495 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 3496 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 3497 | }, |
| 3498 | ], |
| 3499 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 3500 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3501 | # NodePool's nodes can be created by NAP. |
| 3502 | "A String", |
| 3503 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3504 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3505 | "locations": [ # The list of Google Compute Engine |
| 3506 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3507 | # cluster's nodes should be located. |
| 3508 | "A String", |
| 3509 | ], |
| 3510 | "conditions": [ # Which conditions caused the current cluster state. |
| 3511 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3512 | # (e.g., ERROR or DEGRADED). |
| 3513 | "code": "A String", # Machine-friendly representation of the condition |
| 3514 | "message": "A String", # Human-friendly representation of the condition |
| 3515 | }, |
| 3516 | ], |
| 3517 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 3518 | # Currently available options: |
| 3519 | # |
| 3520 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3521 | # service with a Kubernetes-native resource model |
| 3522 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3523 | # available as of GKE 1.15). |
| 3524 | # * `none` - no logs will be exported from the cluster. |
| 3525 | # |
| 3526 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3527 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 3528 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 3529 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 3530 | # the kubernetes version of the master and nodes. |
| 3531 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 3532 | # Alpha enabled clusters are automatically deleted thirty days after |
| 3533 | # creation. |
| 3534 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 3535 | "A String", |
| 3536 | ], |
| 3537 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 3538 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 3539 | # the following restrictions: |
| 3540 | # |
| 3541 | # * Lowercase letters, numbers, and hyphens only. |
| 3542 | # * Must start with a letter. |
| 3543 | # * Must end with a number or a letter. |
| 3544 | "master": { # Master is the configuration for components on master. # Configuration for master components. |
| 3545 | }, |
| 3546 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 3547 | # The endpoint can be accessed from the internet at |
| 3548 | # `https://username:password@endpoint/`. |
| 3549 | # |
| 3550 | # See the `masterAuth` property of this resource for username and |
| 3551 | # password information. |
| 3552 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 3553 | # disabled when this config unspecified. |
| 3554 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 3555 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 3556 | # second BigQuery table will be created to hold resource consumption |
| 3557 | # records. |
| 3558 | }, |
| 3559 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 3560 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 3561 | }, |
| 3562 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 3563 | # daemonset will be created in the cluster to meter network egress traffic. |
| 3564 | }, |
| 3565 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 3566 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3567 | # or |
| 3568 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3569 | # in which the cluster resides. |
| 3570 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 3571 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 3572 | # if enabled = true. |
| 3573 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 3574 | # during authentication using a group of security groups. |
| 3575 | }, |
| 3576 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 3577 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 3578 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 3579 | # the name. |
| 3580 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 3581 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 3582 | "recurringWindow": { # Represents an arbitrary window of time that recurs. # RecurringWindow specifies some number of recurring time periods for |
| 3583 | # maintenance to occur. The time windows may be overlapping. If no |
| 3584 | # maintenance windows are set, maintenance can occur at any time. |
| 3585 | "recurrence": "A String", # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
| 3586 | # this window reccurs. They go on for the span of time between the start and |
| 3587 | # end time. |
| 3588 | # |
| 3589 | # For example, to have something repeat every weekday, you'd use: |
| 3590 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 3591 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 3592 | # <code>FREQ=DAILY</code> |
| 3593 | # For the first weekend of every month: |
| 3594 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 3595 | # This specifies how frequently the window starts. Eg, if you wanted to have |
| 3596 | # a 9-5 UTC-4 window every weekday, you'd use something like: |
| 3597 | # <code> |
| 3598 | # start time = 2019-01-01T09:00:00-0400 |
| 3599 | # end time = 2019-01-01T17:00:00-0400 |
| 3600 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 3601 | # </code> |
| 3602 | # Windows can span multiple days. Eg, to make the window encompass every |
| 3603 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 3604 | # <code> |
| 3605 | # start time = 2019-01-05T00:00:00Z |
| 3606 | # end time = 2019-01-07T23:59:00Z |
| 3607 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 3608 | # </code> |
| 3609 | # Note the start and end time's specific dates are largely arbitrary except |
| 3610 | # to specify duration of the window and when it first starts. |
| 3611 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| 3612 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 3613 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 3614 | # start time. |
| 3615 | "startTime": "A String", # The time that the window first starts. |
| 3616 | }, |
| 3617 | }, |
| 3618 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 3619 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 3620 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 3621 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 3622 | # smallest possible in the given scenario. |
| 3623 | }, |
| 3624 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 3625 | # occur in these windows. |
| 3626 | "a_key": { # Represents an arbitrary window of time. |
| 3627 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 3628 | # start time. |
| 3629 | "startTime": "A String", # The time that the window first starts. |
| 3630 | }, |
| 3631 | }, |
| 3632 | }, |
| 3633 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 3634 | # the policy won't accidentally undo intermediate changes (and so that users |
| 3635 | # of the API unaware of some fields won't accidentally remove other fields). |
| 3636 | # Make a <code>get()</code> request to the cluster to get the current |
| 3637 | # resource version and include it with requests to set the policy. |
| 3638 | }, |
| 3639 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 3640 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 3641 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 3642 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 3643 | }, |
| 3644 | "nodePools": [ # The node pools associated with this cluster. |
| 3645 | # This field should not be set if "node_config" or "initial_node_count" are |
| 3646 | # specified. |
| 3647 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 3648 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| 3649 | # specification, under the control of the cluster master. They may have a set |
| 3650 | # of Kubernetes labels applied to them, which may be used to reference them |
| 3651 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 3652 | # the workload. |
| 3653 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 3654 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 3655 | # disruption caused by an upgrade. |
| 3656 | # |
| 3657 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 3658 | # unavailable. |
| 3659 | # |
| 3660 | # maxSurge controls the number of additional nodes that can be added to the |
| 3661 | # node pool temporarily for the time of the upgrade to increase the number of |
| 3662 | # available nodes. |
| 3663 | # |
| 3664 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 3665 | # nodes are being upgraded at the same time). |
| 3666 | # |
| 3667 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 3668 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 3669 | # this holds true. (Disruption stays within the limits of |
| 3670 | # PodDisruptionBudget, if it is configured.) |
| 3671 | # |
| 3672 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 3673 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 3674 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 3675 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 3676 | # there are always at least 4 nodes available. |
| 3677 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 3678 | # the upgrade process. A node is considered available if its status is |
| 3679 | # Ready. |
| 3680 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 3681 | # of the node pool during the upgrade process. |
| 3682 | }, |
| 3683 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 3684 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 3685 | # associated with this node pool. |
| 3686 | "A String", |
| 3687 | ], |
| 3688 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 3689 | # only if a valid configuration is present. |
| 3690 | # adjust the size of the node pool to the current cluster usage. |
| 3691 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 3692 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 3693 | # max_node_count. |
| 3694 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 3695 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 3696 | # has to enough quota to scale up the cluster. |
| 3697 | }, |
| 3698 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 3699 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 3700 | # is sufficient for this number of instances. You must also have available |
| 3701 | # firewall and routes quota. |
| 3702 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 3703 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3704 | # node VMs under the "default" service account. |
| 3705 | # |
| 3706 | # The following scopes are recommended, but not required, and by default are |
| 3707 | # not included: |
| 3708 | # |
| 3709 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3710 | # persistent storage on your nodes. |
| 3711 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3712 | # communicating with **gcr.io** |
| 3713 | # (the [Google Container |
| 3714 | # Registry](https://cloud.google.com/container-registry/)). |
| 3715 | # |
| 3716 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3717 | # Monitoring are enabled, in which case their required scopes will be added. |
| 3718 | "A String", |
| 3719 | ], |
| 3720 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3721 | # |
| 3722 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3723 | # in length. These are reflected as part of a URL in the metadata server. |
| 3724 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3725 | # metadata keys for the project or be one of the reserved keys: |
| 3726 | # "cluster-location" |
| 3727 | # "cluster-name" |
| 3728 | # "cluster-uid" |
| 3729 | # "configure-sh" |
| 3730 | # "containerd-configure-sh" |
| 3731 | # "enable-oslogin" |
| 3732 | # "gci-ensure-gke-docker" |
| 3733 | # "gci-metrics-enabled" |
| 3734 | # "gci-update-strategy" |
| 3735 | # "instance-template" |
| 3736 | # "kube-env" |
| 3737 | # "startup-script" |
| 3738 | # "user-data" |
| 3739 | # "disable-address-manager" |
| 3740 | # "windows-startup-script-ps1" |
| 3741 | # "common-psm1" |
| 3742 | # "k8s-node-setup-psm1" |
| 3743 | # "install-ssh-psm1" |
| 3744 | # "user-profile-psm1" |
| 3745 | # "serial-port-logging-enable" |
| 3746 | # Values are free-form strings, and only have meaning as interpreted by |
| 3747 | # the image running in the instance. The only restriction placed on them is |
| 3748 | # that each value's size must be less than or equal to 32 KB. |
| 3749 | # |
| 3750 | # The total size of all keys and values must be less than 512 KB. |
| 3751 | "a_key": "A String", |
| 3752 | }, |
| 3753 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 3754 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 3755 | # `n1-standard-1`). |
| 3756 | # |
| 3757 | # If unspecified, the default machine type is |
| 3758 | # `n1-standard-1`. |
| 3759 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 3760 | # pool to run on the specified node group. This is useful for running |
| 3761 | # workloads on [sole tenant |
| 3762 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 3763 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 3764 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3765 | # |
| 3766 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3767 | # verifying the digital signature of all boot components, and halting the |
| 3768 | # boot process if signature verification fails. |
| 3769 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 3770 | # |
| 3771 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3772 | # The attestation is performed against the integrity policy baseline. This |
| 3773 | # baseline is initially derived from the implicitly trusted boot image when |
| 3774 | # the instance is created. |
| 3775 | }, |
| 3776 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3777 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3778 | # Account is specified, the "default" service account is used. |
| 3779 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 3780 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 3781 | # on the nodes. |
| 3782 | # |
| 3783 | # The following parameters are supported. |
| 3784 | # |
| 3785 | # net.core.netdev_max_backlog |
| 3786 | # net.core.rmem_max |
| 3787 | # net.core.wmem_default |
| 3788 | # net.core.wmem_max |
| 3789 | # net.core.optmem_max |
| 3790 | # net.core.somaxconn |
| 3791 | # net.ipv4.tcp_rmem |
| 3792 | # net.ipv4.tcp_wmem |
| 3793 | # net.ipv4.tcp_tw_reuse |
| 3794 | "a_key": "A String", |
| 3795 | }, |
| 3796 | }, |
| 3797 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3798 | "type": "A String", # Type of the sandbox to use for the node. |
| 3799 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 3800 | }, |
| 3801 | "taints": [ # List of kubernetes taints to be applied to each node. |
| 3802 | # |
| 3803 | # For more information, including usage and the valid values, see: |
| 3804 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3805 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3806 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3807 | # |
| 3808 | # See |
| 3809 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3810 | # for more information, including usage and the valid values. |
| 3811 | "effect": "A String", # Effect for taint. |
| 3812 | "key": "A String", # Key for taint. |
| 3813 | "value": "A String", # Value for taint. |
| 3814 | }, |
| 3815 | ], |
| 3816 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 3817 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 3818 | # |
| 3819 | # The string must be a sequence of decimal numbers, each with optional |
| 3820 | # fraction and a unit suffix, such as "300ms". |
| 3821 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 3822 | # The value must be a positive duration. |
| 3823 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 3824 | # |
| 3825 | # If this option is enabled, kubelet uses CFS quota |
| 3826 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 3827 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 3828 | # all. |
| 3829 | # |
| 3830 | # Disable this option to mitigate CPU throttling problems while still having |
| 3831 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 3832 | # |
| 3833 | # The default value is 'true' if unspecified. |
| 3834 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 3835 | # See |
| 3836 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 3837 | # |
| 3838 | # The following values are allowed. |
| 3839 | # - "none": the default, which represents the existing scheduling behavior. |
| 3840 | # - "static": allows pods with certain resource characteristics to be |
| 3841 | # granted increased CPU affinity and exclusivity on the node. |
| 3842 | }, |
| 3843 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3844 | # These will added in addition to any default label(s) that |
| 3845 | # Kubernetes may apply to the node. |
| 3846 | # In case of conflict in label keys, the applied set may differ depending on |
| 3847 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3848 | # and conflicts should be avoided. |
| 3849 | # For more information, including usage and the valid values, see: |
| 3850 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3851 | "a_key": "A String", |
| 3852 | }, |
| 3853 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3854 | # |
| 3855 | # If unspecified, the default disk type is 'pd-standard' |
| 3856 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3857 | # workloads on the node pool. |
| 3858 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 3859 | # workloads running on the node. |
| 3860 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3861 | # on the node pool. |
| 3862 | }, |
| 3863 | "bootDiskKmsKey": "A String", # |
| 3864 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 3865 | # to each node in the node pool. This should be of the form |
| 3866 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 3867 | # For more information about protecting resources with Cloud KMS Keys please |
| 3868 | # see: |
| 3869 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 3870 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3871 | # The smallest allowed disk size is 10GB. |
| 3872 | # |
| 3873 | # If unspecified, the default disk size is 100GB. |
| 3874 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3875 | # the specified [Zonal Compute |
| 3876 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3877 | # to this node pool. |
| 3878 | # is the configuration of desired reservation which instances could take |
| 3879 | # capacity from. |
| 3880 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 3881 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3882 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3883 | # the key and specify the name of your reservation as its value. |
| 3884 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3885 | "A String", |
| 3886 | ], |
| 3887 | }, |
| 3888 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3889 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3890 | # inforamtion about preemptible VM instances. |
| 3891 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3892 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3893 | # friendly names of CPU platforms, such as |
| 3894 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3895 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3896 | # information, read [how to specify min CPU |
| 3897 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3898 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3899 | # valid sources or targets for network firewalls and are specified by |
| 3900 | # the client during cluster or node pool creation. Each tag within the list |
| 3901 | # must comply with RFC1035. |
| 3902 | "A String", |
| 3903 | ], |
| 3904 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3905 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3906 | # support for GPUs. |
| 3907 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 3908 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 3909 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3910 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 3911 | }, |
| 3912 | ], |
| 3913 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 3914 | # |
| 3915 | # The limit for this value is dependent upon the maximum number of |
| 3916 | # disks available on a machine per zone. See: |
| 3917 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 3918 | # for more information. |
| 3919 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3920 | # the latest version of it will be used. |
| 3921 | }, |
| 3922 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3923 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 3924 | # node pool. |
| 3925 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 3926 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 3927 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3928 | # the Auto Upgrades will proceed. |
| 3929 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3930 | # with the description of the upgrade. |
| 3931 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3932 | # with the approximate start time for the upgrades, in |
| 3933 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3934 | }, |
| 3935 | }, |
| 3936 | "name": "A String", # The name of the node pool. |
| 3937 | "version": "A String", # The version of the Kubernetes of this node. |
| 3938 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 3939 | # simultaneously on a node in the node pool. |
| 3940 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 3941 | }, |
| 3942 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 3943 | # node pool instance, if available. |
| 3944 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 3945 | "conditions": [ # Which conditions caused the current node pool state. |
| 3946 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3947 | # (e.g., ERROR or DEGRADED). |
| 3948 | "code": "A String", # Machine-friendly representation of the condition |
| 3949 | "message": "A String", # Human-friendly representation of the condition |
| 3950 | }, |
| 3951 | ], |
| 3952 | "locations": [ # The list of Google Compute Engine |
| 3953 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3954 | # NodePool's nodes should be located. |
| 3955 | "A String", |
| 3956 | ], |
| 3957 | }, |
| 3958 | ], |
| 3959 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 3960 | # cluster, if available. |
| 3961 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 3962 | # subscribed to. Release channels are arranged in order of risk. |
| 3963 | # |
| 3964 | # When a cluster is subscribed to a release channel, Google maintains |
| 3965 | # both the master version and the node version. Node auto-upgrade |
| 3966 | # defaults to true and cannot be disabled. |
| 3967 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 3968 | }, |
| 3969 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3970 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 3971 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 3972 | # if cluster created with IP Alias support. |
| 3973 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 3974 | }, |
| 3975 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 3976 | "type": "A String", # Type of the integration. |
| 3977 | }, |
| 3978 | "status": "A String", # [Output only] The current status of this cluster. |
| 3979 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 3980 | # Google Compute Engine resources. |
| 3981 | "a_key": "A String", |
| 3982 | }, |
| 3983 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 3984 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3985 | # notation (e.g. `1.2.3.4/29`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3986 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3987 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3988 | # is sufficient for this number of instances. You must also have available |
| 3989 | # firewall and routes quota. |
| 3990 | # 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] | 3991 | # "node_pool" object, since this configuration (along with the |
| 3992 | # "node_config") will be used to create a "NodePool" object with an |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3993 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3994 | # |
| 3995 | # This field is deprecated, use node_pool.initial_node_count instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3996 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 3997 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 3998 | # must be valid under a PodSecurityPolicy to be created. |
| 3999 | }, |
| 4000 | "description": "A String", # An optional description of this cluster. |
| 4001 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 4002 | "state": "A String", # Denotes the state of etcd encryption. |
| 4003 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 4004 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 4005 | }, |
| 4006 | "network": "A String", # The name of the Google Compute Engine |
| 4007 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 4008 | # to which the cluster is connected. If left unspecified, the `default` |
| 4009 | # network will be used. On output this shows the network ID instead of the |
| 4010 | # name. |
| 4011 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 4012 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4013 | # cluster resides. This field is deprecated, use location instead. |
| 4014 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 4015 | # required by Vertical Pod Autoscaler to automatically adjust |
| 4016 | # the resources of pods controlled by it. |
| 4017 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 4018 | }, |
| 4019 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 4020 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4021 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| 4022 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 4023 | # range. This field will only be set when cluster is in route-based network |
| 4024 | # mode. |
| 4025 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4026 | }, |
| 4027 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4028 | }</pre> |
| 4029 | </div> |
| 4030 | |
| 4031 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4032 | <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] | 4033 | <pre>Sets the addons for a specific cluster. |
| 4034 | |
| 4035 | Args: |
| 4036 | 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] | 4037 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4038 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4039 | The object takes the form of: |
| 4040 | |
| 4041 | { # SetAddonsRequest sets the addons associated with the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4042 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4043 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4044 | "name": "A String", # The name (project, location, cluster) of the cluster to set addons. |
| 4045 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4046 | "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] | 4047 | # cluster. |
| 4048 | # cluster, enabling additional functionality. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4049 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 4050 | # extension to manage hosted GCP services through the Kubernetes API |
| 4051 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4052 | }, |
| 4053 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 4054 | # enabled at cluster creation time. |
| 4055 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 4056 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4057 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 4058 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4059 | }, |
| 4060 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 4061 | # is enabled or not on the Master, it does not track whether network policy |
| 4062 | # is enabled for the nodes. |
| 4063 | # is enabled or not on the Master, it does not track whether network policy |
| 4064 | # is enabled for the nodes. |
| 4065 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 4066 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4067 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 4068 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 4069 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 4070 | # workloads and applications. For more information, see: |
| 4071 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 4072 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4073 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4074 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 4075 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 4076 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 4077 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 4078 | # When enabled, it runs a small pod in the cluster that manages the load |
| 4079 | # balancers. |
| 4080 | }, |
| 4081 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 4082 | # microservices. |
| 4083 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 4084 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4085 | }, |
| 4086 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 4087 | # increases or decreases the number of replica pods a replication controller |
| 4088 | # has based on the resource usage of the existing pods. |
| 4089 | # increases or decreases the number of replica pods a replication controller |
| 4090 | # has based on the resource usage of the existing pods. |
| 4091 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 4092 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 4093 | # Monitoring. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4094 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4095 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 4096 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 4097 | # at cluster creation time. |
| 4098 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 4099 | }, |
| 4100 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 4101 | # applications. |
| 4102 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 4103 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4104 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4105 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4106 | # number](https://support.google.com/cloud/answer/6158840). |
| 4107 | # This field has been deprecated and replaced by the name field. |
| 4108 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4109 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4110 | # cluster resides. This field has been deprecated and replaced by the name |
| 4111 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4112 | } |
| 4113 | |
| 4114 | x__xgafv: string, V1 error format. |
| 4115 | Allowed values |
| 4116 | 1 - v1 error format |
| 4117 | 2 - v2 error format |
| 4118 | |
| 4119 | Returns: |
| 4120 | An object of the form: |
| 4121 | |
| 4122 | { # This operation resource represents operations that may have happened or are |
| 4123 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4124 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4125 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4126 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4127 | "stages": [ # Substages of an operation or a stage. |
| 4128 | # Object with schema name: OperationProgress |
| 4129 | ], |
| 4130 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4131 | # Unset for single-stage operations. |
| 4132 | "status": "A String", # Status of an operation stage. |
| 4133 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4134 | "metrics": [ # Progress metric bundle, for example: |
| 4135 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4136 | # {name: "nodes total", int_value: 32}] |
| 4137 | # or |
| 4138 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4139 | # {name: "progress scale", double_value: 1.0}] |
| 4140 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4141 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4142 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4143 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4144 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4145 | }, |
| 4146 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4147 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4148 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4149 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4150 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4151 | # or |
| 4152 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4153 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4154 | "zone": "A String", # The name of the Google Compute Engine |
| 4155 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4156 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4157 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4158 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4159 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4160 | "name": "A String", # The server-assigned ID for the operation. |
| 4161 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4162 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4163 | # (e.g., ERROR or DEGRADED). |
| 4164 | "code": "A String", # Machine-friendly representation of the condition |
| 4165 | "message": "A String", # Human-friendly representation of the condition |
| 4166 | }, |
| 4167 | ], |
| 4168 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4169 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4170 | "detail": "A String", # Detailed operation progress, if available. |
| 4171 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4172 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4173 | # (e.g., ERROR or DEGRADED). |
| 4174 | "code": "A String", # Machine-friendly representation of the condition |
| 4175 | "message": "A String", # Human-friendly representation of the condition |
| 4176 | }, |
| 4177 | ], |
| 4178 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4179 | }</pre> |
| 4180 | </div> |
| 4181 | |
| 4182 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4183 | <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] | 4184 | <pre>Enables or disables the ABAC authorization mechanism on a cluster. |
| 4185 | |
| 4186 | Args: |
| 4187 | 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] | 4188 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4189 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4190 | The object takes the form of: |
| 4191 | |
| 4192 | { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for |
| 4193 | # a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4194 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4195 | # number](https://support.google.com/cloud/answer/6158840). |
| 4196 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4197 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4198 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4199 | # cluster resides. This field has been deprecated and replaced by the name |
| 4200 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4201 | "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. |
| 4202 | "name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. |
| 4203 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4204 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. |
| 4205 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4206 | } |
| 4207 | |
| 4208 | x__xgafv: string, V1 error format. |
| 4209 | Allowed values |
| 4210 | 1 - v1 error format |
| 4211 | 2 - v2 error format |
| 4212 | |
| 4213 | Returns: |
| 4214 | An object of the form: |
| 4215 | |
| 4216 | { # This operation resource represents operations that may have happened or are |
| 4217 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4218 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4219 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4220 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4221 | "stages": [ # Substages of an operation or a stage. |
| 4222 | # Object with schema name: OperationProgress |
| 4223 | ], |
| 4224 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4225 | # Unset for single-stage operations. |
| 4226 | "status": "A String", # Status of an operation stage. |
| 4227 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4228 | "metrics": [ # Progress metric bundle, for example: |
| 4229 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4230 | # {name: "nodes total", int_value: 32}] |
| 4231 | # or |
| 4232 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4233 | # {name: "progress scale", double_value: 1.0}] |
| 4234 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4235 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4236 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4237 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4238 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4239 | }, |
| 4240 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4241 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4242 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4243 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4244 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4245 | # or |
| 4246 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4247 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4248 | "zone": "A String", # The name of the Google Compute Engine |
| 4249 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4250 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4251 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4252 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4253 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4254 | "name": "A String", # The server-assigned ID for the operation. |
| 4255 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4256 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4257 | # (e.g., ERROR or DEGRADED). |
| 4258 | "code": "A String", # Machine-friendly representation of the condition |
| 4259 | "message": "A String", # Human-friendly representation of the condition |
| 4260 | }, |
| 4261 | ], |
| 4262 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4263 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4264 | "detail": "A String", # Detailed operation progress, if available. |
| 4265 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4266 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4267 | # (e.g., ERROR or DEGRADED). |
| 4268 | "code": "A String", # Machine-friendly representation of the condition |
| 4269 | "message": "A String", # Human-friendly representation of the condition |
| 4270 | }, |
| 4271 | ], |
| 4272 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4273 | }</pre> |
| 4274 | </div> |
| 4275 | |
| 4276 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4277 | <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] | 4278 | <pre>Sets the locations for a specific cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4279 | Deprecated. Use |
| 4280 | [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) |
| 4281 | instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4282 | |
| 4283 | Args: |
| 4284 | 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] | 4285 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4286 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4287 | The object takes the form of: |
| 4288 | |
| 4289 | { # SetLocationsRequest sets the locations of the cluster. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4290 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4291 | # number](https://support.google.com/cloud/answer/6158840). |
| 4292 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4293 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4294 | # This field has been deprecated and replaced by the name field. |
| 4295 | "name": "A String", # The name (project, location, cluster) of the cluster to set locations. |
| 4296 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4297 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4298 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4299 | # cluster resides. This field has been deprecated and replaced by the name |
| 4300 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4301 | "locations": [ # Required. The desired list of Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4302 | # [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] | 4303 | # 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] | 4304 | # will result in nodes being either created or removed from the cluster, |
| 4305 | # depending on whether locations are being added or removed. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4306 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4307 | # This list must always include the cluster's primary zone. |
| 4308 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4309 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4310 | } |
| 4311 | |
| 4312 | x__xgafv: string, V1 error format. |
| 4313 | Allowed values |
| 4314 | 1 - v1 error format |
| 4315 | 2 - v2 error format |
| 4316 | |
| 4317 | Returns: |
| 4318 | An object of the form: |
| 4319 | |
| 4320 | { # This operation resource represents operations that may have happened or are |
| 4321 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4322 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4323 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4324 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4325 | "stages": [ # Substages of an operation or a stage. |
| 4326 | # Object with schema name: OperationProgress |
| 4327 | ], |
| 4328 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4329 | # Unset for single-stage operations. |
| 4330 | "status": "A String", # Status of an operation stage. |
| 4331 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4332 | "metrics": [ # Progress metric bundle, for example: |
| 4333 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4334 | # {name: "nodes total", int_value: 32}] |
| 4335 | # or |
| 4336 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4337 | # {name: "progress scale", double_value: 1.0}] |
| 4338 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4339 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4340 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4341 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4342 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4343 | }, |
| 4344 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4345 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4346 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4347 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4348 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4349 | # or |
| 4350 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4351 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4352 | "zone": "A String", # The name of the Google Compute Engine |
| 4353 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4354 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4355 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4356 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4357 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4358 | "name": "A String", # The server-assigned ID for the operation. |
| 4359 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4360 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4361 | # (e.g., ERROR or DEGRADED). |
| 4362 | "code": "A String", # Machine-friendly representation of the condition |
| 4363 | "message": "A String", # Human-friendly representation of the condition |
| 4364 | }, |
| 4365 | ], |
| 4366 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4367 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4368 | "detail": "A String", # Detailed operation progress, if available. |
| 4369 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4370 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4371 | # (e.g., ERROR or DEGRADED). |
| 4372 | "code": "A String", # Machine-friendly representation of the condition |
| 4373 | "message": "A String", # Human-friendly representation of the condition |
| 4374 | }, |
| 4375 | ], |
| 4376 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4377 | }</pre> |
| 4378 | </div> |
| 4379 | |
| 4380 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4381 | <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] | 4382 | <pre>Sets the logging service for a specific cluster. |
| 4383 | |
| 4384 | Args: |
| 4385 | 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] | 4386 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4387 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4388 | The object takes the form of: |
| 4389 | |
| 4390 | { # SetLoggingServiceRequest sets the logging service of a cluster. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4391 | "name": "A String", # The name (project, location, cluster) of the cluster to set logging. |
| 4392 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4393 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4394 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4395 | "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] | 4396 | # Currently available options: |
| 4397 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4398 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 4399 | # service with a Kubernetes-native resource model |
| 4400 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 4401 | # available as of GKE 1.15). |
| 4402 | # * `none` - no logs will be exported from the cluster. |
| 4403 | # |
| 4404 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 4405 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4406 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4407 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4408 | # cluster resides. This field has been deprecated and replaced by the name |
| 4409 | # field. |
| 4410 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4411 | # number](https://support.google.com/cloud/answer/6158840). |
| 4412 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4413 | } |
| 4414 | |
| 4415 | x__xgafv: string, V1 error format. |
| 4416 | Allowed values |
| 4417 | 1 - v1 error format |
| 4418 | 2 - v2 error format |
| 4419 | |
| 4420 | Returns: |
| 4421 | An object of the form: |
| 4422 | |
| 4423 | { # This operation resource represents operations that may have happened or are |
| 4424 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4425 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4426 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4427 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4428 | "stages": [ # Substages of an operation or a stage. |
| 4429 | # Object with schema name: OperationProgress |
| 4430 | ], |
| 4431 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4432 | # Unset for single-stage operations. |
| 4433 | "status": "A String", # Status of an operation stage. |
| 4434 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4435 | "metrics": [ # Progress metric bundle, for example: |
| 4436 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4437 | # {name: "nodes total", int_value: 32}] |
| 4438 | # or |
| 4439 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4440 | # {name: "progress scale", double_value: 1.0}] |
| 4441 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4442 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4443 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4444 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4445 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4446 | }, |
| 4447 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4448 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4449 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4450 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4451 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4452 | # or |
| 4453 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4454 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4455 | "zone": "A String", # The name of the Google Compute Engine |
| 4456 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4457 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4458 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4459 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4460 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4461 | "name": "A String", # The server-assigned ID for the operation. |
| 4462 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4463 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4464 | # (e.g., ERROR or DEGRADED). |
| 4465 | "code": "A String", # Machine-friendly representation of the condition |
| 4466 | "message": "A String", # Human-friendly representation of the condition |
| 4467 | }, |
| 4468 | ], |
| 4469 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4470 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4471 | "detail": "A String", # Detailed operation progress, if available. |
| 4472 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4473 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4474 | # (e.g., ERROR or DEGRADED). |
| 4475 | "code": "A String", # Machine-friendly representation of the condition |
| 4476 | "message": "A String", # Human-friendly representation of the condition |
| 4477 | }, |
| 4478 | ], |
| 4479 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4480 | }</pre> |
| 4481 | </div> |
| 4482 | |
| 4483 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4484 | <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] | 4485 | <pre>Sets the maintenance policy for a cluster. |
| 4486 | |
| 4487 | Args: |
| 4488 | name: string, The name (project, location, cluster id) of the cluster to set maintenance |
| 4489 | policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4490 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4491 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4492 | The object takes the form of: |
| 4493 | |
| 4494 | { # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4495 | "clusterId": "A String", # Required. The name of the cluster to update. |
| 4496 | "zone": "A String", # Required. The name of the Google Compute Engine |
| 4497 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4498 | # cluster resides. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4499 | "name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance |
| 4500 | # policy. |
| 4501 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4502 | "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] | 4503 | # clears the existing maintenance policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4504 | "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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4505 | "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] | 4506 | # maintenance to occur. The time windows may be overlapping. If no |
| 4507 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4508 | "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] | 4509 | # this window reccurs. They go on for the span of time between the start and |
| 4510 | # end time. |
| 4511 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4512 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4513 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 4514 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 4515 | # <code>FREQ=DAILY</code> |
| 4516 | # For the first weekend of every month: |
| 4517 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 4518 | # 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] | 4519 | # 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] | 4520 | # <code> |
| 4521 | # start time = 2019-01-01T09:00:00-0400 |
| 4522 | # end time = 2019-01-01T17:00:00-0400 |
| 4523 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 4524 | # </code> |
| 4525 | # Windows can span multiple days. Eg, to make the window encompass every |
| 4526 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 4527 | # <code> |
| 4528 | # start time = 2019-01-05T00:00:00Z |
| 4529 | # end time = 2019-01-07T23:59:00Z |
| 4530 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 4531 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4532 | # 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] | 4533 | # to specify duration of the window and when it first starts. |
| 4534 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4535 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 4536 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4537 | # start time. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4538 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4539 | }, |
| 4540 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4541 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4542 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 4543 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4544 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 4545 | # smallest possible in the given scenario. |
| 4546 | }, |
| 4547 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 4548 | # occur in these windows. |
| 4549 | "a_key": { # Represents an arbitrary window of time. |
| 4550 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 4551 | # start time. |
| 4552 | "startTime": "A String", # The time that the window first starts. |
| 4553 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4554 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4555 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4556 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 4557 | # the policy won't accidentally undo intermediate changes (and so that users |
| 4558 | # of the API unaware of some fields won't accidentally remove other fields). |
| 4559 | # Make a <code>get()</code> request to the cluster to get the current |
| 4560 | # resource version and include it with requests to set the policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4561 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4562 | "projectId": "A String", # Required. The Google Developers Console [project ID or project |
| 4563 | # number](https://support.google.com/cloud/answer/6158840). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4564 | } |
| 4565 | |
| 4566 | x__xgafv: string, V1 error format. |
| 4567 | Allowed values |
| 4568 | 1 - v1 error format |
| 4569 | 2 - v2 error format |
| 4570 | |
| 4571 | Returns: |
| 4572 | An object of the form: |
| 4573 | |
| 4574 | { # This operation resource represents operations that may have happened or are |
| 4575 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4576 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4577 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4578 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4579 | "stages": [ # Substages of an operation or a stage. |
| 4580 | # Object with schema name: OperationProgress |
| 4581 | ], |
| 4582 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4583 | # Unset for single-stage operations. |
| 4584 | "status": "A String", # Status of an operation stage. |
| 4585 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4586 | "metrics": [ # Progress metric bundle, for example: |
| 4587 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4588 | # {name: "nodes total", int_value: 32}] |
| 4589 | # or |
| 4590 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4591 | # {name: "progress scale", double_value: 1.0}] |
| 4592 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4593 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4594 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4595 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4596 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4597 | }, |
| 4598 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4599 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4600 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4601 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4602 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4603 | # or |
| 4604 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4605 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4606 | "zone": "A String", # The name of the Google Compute Engine |
| 4607 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4608 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4609 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4610 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4611 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4612 | "name": "A String", # The server-assigned ID for the operation. |
| 4613 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4614 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4615 | # (e.g., ERROR or DEGRADED). |
| 4616 | "code": "A String", # Machine-friendly representation of the condition |
| 4617 | "message": "A String", # Human-friendly representation of the condition |
| 4618 | }, |
| 4619 | ], |
| 4620 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4621 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4622 | "detail": "A String", # Detailed operation progress, if available. |
| 4623 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4624 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4625 | # (e.g., ERROR or DEGRADED). |
| 4626 | "code": "A String", # Machine-friendly representation of the condition |
| 4627 | "message": "A String", # Human-friendly representation of the condition |
| 4628 | }, |
| 4629 | ], |
| 4630 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4631 | }</pre> |
| 4632 | </div> |
| 4633 | |
| 4634 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4635 | <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] | 4636 | <pre>Sets master auth materials. Currently supports changing the admin password |
| 4637 | or a specific cluster, either via password generation or explicitly setting |
| 4638 | the password. |
| 4639 | |
| 4640 | Args: |
| 4641 | 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] | 4642 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4643 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4644 | The object takes the form of: |
| 4645 | |
| 4646 | { # SetMasterAuthRequest updates the admin password of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4647 | "name": "A String", # The name (project, location, cluster) of the cluster to set auth. |
| 4648 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4649 | "action": "A String", # Required. The exact form of action to be taken on the master auth. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4650 | "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] | 4651 | # Authentication can be done using HTTP basic auth or using client |
| 4652 | # certificates. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4653 | "clusterCaCertificate": "A String", |
| 4654 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 4655 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 4656 | # leaving username unspecified (or setting it to the empty string). |
| 4657 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 4658 | # authenticate to the cluster endpoint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4659 | "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] | 4660 | # Because the master endpoint is open to the Internet, you should create a |
| 4661 | # strong password. If a password is provided for cluster creation, username |
| 4662 | # must be non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4663 | "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] | 4664 | # clusters before v1.12, if no configuration is specified, a client |
| 4665 | # certificate is issued. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4666 | "issueClientCertificate": True or False, # Issue a client certificate. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4667 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4668 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 4669 | # to the cluster endpoint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4670 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4671 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4672 | # number](https://support.google.com/cloud/answer/6158840). |
| 4673 | # This field has been deprecated and replaced by the name field. |
| 4674 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4675 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4676 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4677 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4678 | # cluster resides. This field has been deprecated and replaced by the name |
| 4679 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4680 | } |
| 4681 | |
| 4682 | x__xgafv: string, V1 error format. |
| 4683 | Allowed values |
| 4684 | 1 - v1 error format |
| 4685 | 2 - v2 error format |
| 4686 | |
| 4687 | Returns: |
| 4688 | An object of the form: |
| 4689 | |
| 4690 | { # This operation resource represents operations that may have happened or are |
| 4691 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4692 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4693 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4694 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4695 | "stages": [ # Substages of an operation or a stage. |
| 4696 | # Object with schema name: OperationProgress |
| 4697 | ], |
| 4698 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4699 | # Unset for single-stage operations. |
| 4700 | "status": "A String", # Status of an operation stage. |
| 4701 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4702 | "metrics": [ # Progress metric bundle, for example: |
| 4703 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4704 | # {name: "nodes total", int_value: 32}] |
| 4705 | # or |
| 4706 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4707 | # {name: "progress scale", double_value: 1.0}] |
| 4708 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4709 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4710 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4711 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4712 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4713 | }, |
| 4714 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4715 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4716 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4717 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4718 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4719 | # or |
| 4720 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4721 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4722 | "zone": "A String", # The name of the Google Compute Engine |
| 4723 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4724 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4725 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4726 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4727 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4728 | "name": "A String", # The server-assigned ID for the operation. |
| 4729 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4730 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4731 | # (e.g., ERROR or DEGRADED). |
| 4732 | "code": "A String", # Machine-friendly representation of the condition |
| 4733 | "message": "A String", # Human-friendly representation of the condition |
| 4734 | }, |
| 4735 | ], |
| 4736 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4737 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4738 | "detail": "A String", # Detailed operation progress, if available. |
| 4739 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4740 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4741 | # (e.g., ERROR or DEGRADED). |
| 4742 | "code": "A String", # Machine-friendly representation of the condition |
| 4743 | "message": "A String", # Human-friendly representation of the condition |
| 4744 | }, |
| 4745 | ], |
| 4746 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4747 | }</pre> |
| 4748 | </div> |
| 4749 | |
| 4750 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4751 | <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] | 4752 | <pre>Sets the monitoring service for a specific cluster. |
| 4753 | |
| 4754 | Args: |
| 4755 | 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] | 4756 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4757 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4758 | The object takes the form of: |
| 4759 | |
| 4760 | { # SetMonitoringServiceRequest sets the monitoring service of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4761 | "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] | 4762 | # Currently available options: |
| 4763 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4764 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4765 | # service with a Kubernetes-native resource model |
| 4766 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 4767 | # longer available as of GKE 1.15). |
| 4768 | # * `none` - No metrics will be exported from the cluster. |
| 4769 | # |
| 4770 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 4771 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4772 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4773 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4774 | # cluster resides. This field has been deprecated and replaced by the name |
| 4775 | # field. |
| 4776 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4777 | # number](https://support.google.com/cloud/answer/6158840). |
| 4778 | # This field has been deprecated and replaced by the name field. |
| 4779 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4780 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4781 | "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. |
| 4782 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4783 | } |
| 4784 | |
| 4785 | x__xgafv: string, V1 error format. |
| 4786 | Allowed values |
| 4787 | 1 - v1 error format |
| 4788 | 2 - v2 error format |
| 4789 | |
| 4790 | Returns: |
| 4791 | An object of the form: |
| 4792 | |
| 4793 | { # This operation resource represents operations that may have happened or are |
| 4794 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4795 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4796 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4797 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4798 | "stages": [ # Substages of an operation or a stage. |
| 4799 | # Object with schema name: OperationProgress |
| 4800 | ], |
| 4801 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4802 | # Unset for single-stage operations. |
| 4803 | "status": "A String", # Status of an operation stage. |
| 4804 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4805 | "metrics": [ # Progress metric bundle, for example: |
| 4806 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4807 | # {name: "nodes total", int_value: 32}] |
| 4808 | # or |
| 4809 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4810 | # {name: "progress scale", double_value: 1.0}] |
| 4811 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4812 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4813 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4814 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4815 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4816 | }, |
| 4817 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4818 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4819 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4820 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4821 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4822 | # or |
| 4823 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4824 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4825 | "zone": "A String", # The name of the Google Compute Engine |
| 4826 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4827 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4828 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4829 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4830 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4831 | "name": "A String", # The server-assigned ID for the operation. |
| 4832 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4833 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4834 | # (e.g., ERROR or DEGRADED). |
| 4835 | "code": "A String", # Machine-friendly representation of the condition |
| 4836 | "message": "A String", # Human-friendly representation of the condition |
| 4837 | }, |
| 4838 | ], |
| 4839 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4840 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4841 | "detail": "A String", # Detailed operation progress, if available. |
| 4842 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4843 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4844 | # (e.g., ERROR or DEGRADED). |
| 4845 | "code": "A String", # Machine-friendly representation of the condition |
| 4846 | "message": "A String", # Human-friendly representation of the condition |
| 4847 | }, |
| 4848 | ], |
| 4849 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4850 | }</pre> |
| 4851 | </div> |
| 4852 | |
| 4853 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4854 | <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] | 4855 | <pre>Enables or disables Network Policy for a cluster. |
| 4856 | |
| 4857 | Args: |
| 4858 | 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] | 4859 | policy. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4860 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4861 | The object takes the form of: |
| 4862 | |
| 4863 | { # SetNetworkPolicyRequest enables/disables network policy for a cluster. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4864 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 4865 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4866 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4867 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4868 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4869 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4870 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4871 | # cluster resides. This field has been deprecated and replaced by the name |
| 4872 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4873 | "name": "A String", # The name (project, location, cluster id) of the cluster to set networking |
| 4874 | # policy. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4875 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature. |
| 4876 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4877 | "provider": "A String", # The selected network policy provider. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4878 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4879 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4880 | } |
| 4881 | |
| 4882 | x__xgafv: string, V1 error format. |
| 4883 | Allowed values |
| 4884 | 1 - v1 error format |
| 4885 | 2 - v2 error format |
| 4886 | |
| 4887 | Returns: |
| 4888 | An object of the form: |
| 4889 | |
| 4890 | { # This operation resource represents operations that may have happened or are |
| 4891 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4892 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4893 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4894 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4895 | "stages": [ # Substages of an operation or a stage. |
| 4896 | # Object with schema name: OperationProgress |
| 4897 | ], |
| 4898 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4899 | # Unset for single-stage operations. |
| 4900 | "status": "A String", # Status of an operation stage. |
| 4901 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4902 | "metrics": [ # Progress metric bundle, for example: |
| 4903 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4904 | # {name: "nodes total", int_value: 32}] |
| 4905 | # or |
| 4906 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4907 | # {name: "progress scale", double_value: 1.0}] |
| 4908 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4909 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4910 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4911 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4912 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4913 | }, |
| 4914 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4915 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4916 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4917 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 4918 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4919 | # or |
| 4920 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4921 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4922 | "zone": "A String", # The name of the Google Compute Engine |
| 4923 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4924 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4925 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4926 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4927 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4928 | "name": "A String", # The server-assigned ID for the operation. |
| 4929 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4930 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4931 | # (e.g., ERROR or DEGRADED). |
| 4932 | "code": "A String", # Machine-friendly representation of the condition |
| 4933 | "message": "A String", # Human-friendly representation of the condition |
| 4934 | }, |
| 4935 | ], |
| 4936 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4937 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4938 | "detail": "A String", # Detailed operation progress, if available. |
| 4939 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 4940 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4941 | # (e.g., ERROR or DEGRADED). |
| 4942 | "code": "A String", # Machine-friendly representation of the condition |
| 4943 | "message": "A String", # Human-friendly representation of the condition |
| 4944 | }, |
| 4945 | ], |
| 4946 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4947 | }</pre> |
| 4948 | </div> |
| 4949 | |
| 4950 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4951 | <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] | 4952 | <pre>Sets labels on a cluster. |
| 4953 | |
| 4954 | Args: |
| 4955 | 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] | 4956 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4957 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4958 | The object takes the form of: |
| 4959 | |
| 4960 | { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container |
| 4961 | # Engine cluster, which will in turn set them for Google Compute Engine |
| 4962 | # resources used by that cluster |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4963 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4964 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4965 | # cluster resides. This field has been deprecated and replaced by the name |
| 4966 | # field. |
| 4967 | "name": "A String", # The name (project, location, cluster id) of the cluster to set labels. |
| 4968 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4969 | "resourceLabels": { # Required. The labels to set for that cluster. |
| 4970 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4971 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4972 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4973 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4974 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4975 | "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, |
| 4976 | # used to detect conflicts. The fingerprint is initially generated by |
| 4977 | # Kubernetes Engine and changes after every request to modify or update |
| 4978 | # labels. You must always provide an up-to-date fingerprint hash when |
| 4979 | # updating or changing labels. Make a <code>get()</code> request to the |
| 4980 | # resource to get the latest fingerprint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4981 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 4982 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4983 | } |
| 4984 | |
| 4985 | x__xgafv: string, V1 error format. |
| 4986 | Allowed values |
| 4987 | 1 - v1 error format |
| 4988 | 2 - v2 error format |
| 4989 | |
| 4990 | Returns: |
| 4991 | An object of the form: |
| 4992 | |
| 4993 | { # This operation resource represents operations that may have happened or are |
| 4994 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4995 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4996 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4997 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 4998 | "stages": [ # Substages of an operation or a stage. |
| 4999 | # Object with schema name: OperationProgress |
| 5000 | ], |
| 5001 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5002 | # Unset for single-stage operations. |
| 5003 | "status": "A String", # Status of an operation stage. |
| 5004 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5005 | "metrics": [ # Progress metric bundle, for example: |
| 5006 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5007 | # {name: "nodes total", int_value: 32}] |
| 5008 | # or |
| 5009 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5010 | # {name: "progress scale", double_value: 1.0}] |
| 5011 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5012 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5013 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5014 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5015 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5016 | }, |
| 5017 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5018 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5019 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5020 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 5021 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5022 | # or |
| 5023 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5024 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5025 | "zone": "A String", # The name of the Google Compute Engine |
| 5026 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5027 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5028 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5029 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5030 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5031 | "name": "A String", # The server-assigned ID for the operation. |
| 5032 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5033 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5034 | # (e.g., ERROR or DEGRADED). |
| 5035 | "code": "A String", # Machine-friendly representation of the condition |
| 5036 | "message": "A String", # Human-friendly representation of the condition |
| 5037 | }, |
| 5038 | ], |
| 5039 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5040 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5041 | "detail": "A String", # Detailed operation progress, if available. |
| 5042 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 5043 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5044 | # (e.g., ERROR or DEGRADED). |
| 5045 | "code": "A String", # Machine-friendly representation of the condition |
| 5046 | "message": "A String", # Human-friendly representation of the condition |
| 5047 | }, |
| 5048 | ], |
| 5049 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5050 | }</pre> |
| 5051 | </div> |
| 5052 | |
| 5053 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5054 | <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] | 5055 | <pre>Starts master IP rotation. |
| 5056 | |
| 5057 | Args: |
| 5058 | 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] | 5059 | rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5060 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5061 | The object takes the form of: |
| 5062 | |
| 5063 | { # StartIPRotationRequest creates a new IP for the cluster and then performs |
| 5064 | # a node upgrade on each node pool to point to the new IP. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5065 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 5066 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5067 | "name": "A String", # The name (project, location, cluster id) of the cluster to start IP |
| 5068 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5069 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5070 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5071 | # cluster resides. This field has been deprecated and replaced by the name |
| 5072 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5073 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 5074 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5075 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5076 | "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5077 | } |
| 5078 | |
| 5079 | x__xgafv: string, V1 error format. |
| 5080 | Allowed values |
| 5081 | 1 - v1 error format |
| 5082 | 2 - v2 error format |
| 5083 | |
| 5084 | Returns: |
| 5085 | An object of the form: |
| 5086 | |
| 5087 | { # This operation resource represents operations that may have happened or are |
| 5088 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5089 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5090 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5091 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5092 | "stages": [ # Substages of an operation or a stage. |
| 5093 | # Object with schema name: OperationProgress |
| 5094 | ], |
| 5095 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5096 | # Unset for single-stage operations. |
| 5097 | "status": "A String", # Status of an operation stage. |
| 5098 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5099 | "metrics": [ # Progress metric bundle, for example: |
| 5100 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5101 | # {name: "nodes total", int_value: 32}] |
| 5102 | # or |
| 5103 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5104 | # {name: "progress scale", double_value: 1.0}] |
| 5105 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5106 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5107 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5108 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5109 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5110 | }, |
| 5111 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5112 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5113 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5114 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 5115 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5116 | # or |
| 5117 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5118 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5119 | "zone": "A String", # The name of the Google Compute Engine |
| 5120 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5121 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5122 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5123 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5124 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5125 | "name": "A String", # The server-assigned ID for the operation. |
| 5126 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5127 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5128 | # (e.g., ERROR or DEGRADED). |
| 5129 | "code": "A String", # Machine-friendly representation of the condition |
| 5130 | "message": "A String", # Human-friendly representation of the condition |
| 5131 | }, |
| 5132 | ], |
| 5133 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5134 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5135 | "detail": "A String", # Detailed operation progress, if available. |
| 5136 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 5137 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5138 | # (e.g., ERROR or DEGRADED). |
| 5139 | "code": "A String", # Machine-friendly representation of the condition |
| 5140 | "message": "A String", # Human-friendly representation of the condition |
| 5141 | }, |
| 5142 | ], |
| 5143 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5144 | }</pre> |
| 5145 | </div> |
| 5146 | |
| 5147 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5148 | <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] | 5149 | <pre>Updates the settings for a specific cluster. |
| 5150 | |
| 5151 | Args: |
| 5152 | 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] | 5153 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5154 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5155 | The object takes the form of: |
| 5156 | |
| 5157 | { # UpdateClusterRequest updates the settings of a cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5158 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 5159 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5160 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5161 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5162 | "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] | 5163 | # be applied to a cluster with each request, so at most one field can be |
| 5164 | # provided. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5165 | "desiredLoggingService": "A String", # The logging service the cluster should use to write logs. |
| 5166 | # Currently available options: |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5167 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5168 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 5169 | # service with a Kubernetes-native resource model |
| 5170 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 5171 | # available as of GKE 1.15). |
| 5172 | # * `none` - no logs will be exported from the cluster. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5173 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5174 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 5175 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 5176 | "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. |
| 5177 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 5178 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5179 | "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 5180 | # required by Cluster Autoscaler to automatically adjust |
| 5181 | # the size of the cluster and create/delete |
| 5182 | # node pools based on the current needs. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5183 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 5184 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 5185 | # created by NAP. |
| 5186 | # by NAP. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5187 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5188 | # disruption caused by an upgrade. |
| 5189 | # |
| 5190 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 5191 | # unavailable. |
| 5192 | # |
| 5193 | # maxSurge controls the number of additional nodes that can be added to the |
| 5194 | # node pool temporarily for the time of the upgrade to increase the number of |
| 5195 | # available nodes. |
| 5196 | # |
| 5197 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 5198 | # nodes are being upgraded at the same time). |
| 5199 | # |
| 5200 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 5201 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 5202 | # this holds true. (Disruption stays within the limits of |
| 5203 | # PodDisruptionBudget, if it is configured.) |
| 5204 | # |
| 5205 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 5206 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 5207 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 5208 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 5209 | # there are always at least 4 nodes available. |
| 5210 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 5211 | # the upgrade process. A node is considered available if its status is |
| 5212 | # Ready. |
| 5213 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 5214 | # of the node pool during the upgrade process. |
| 5215 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5216 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 5217 | # Specify the email address of the Service Account; otherwise, if no Service |
| 5218 | # Account is specified, the "default" service account is used. |
| 5219 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 5220 | # node VMs under the "default" service account. |
| 5221 | # |
| 5222 | # The following scopes are recommended, but not required, and by default are |
| 5223 | # not included: |
| 5224 | # |
| 5225 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 5226 | # persistent storage on your nodes. |
| 5227 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 5228 | # communicating with **gcr.io** |
| 5229 | # (the [Google Container |
| 5230 | # Registry](https://cloud.google.com/container-registry/)). |
| 5231 | # |
| 5232 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 5233 | # Monitoring are enabled, in which case their required scopes will be added. |
| 5234 | "A String", |
| 5235 | ], |
| 5236 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 5237 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 5238 | # friendly names of CPU platforms, such as |
| 5239 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 5240 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 5241 | # information, read [how to specify min CPU |
| 5242 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 5243 | # To unset the min cpu platform field pass "automatic" |
| 5244 | # as field value. |
| 5245 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 5246 | # node pool. |
| 5247 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 5248 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 5249 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 5250 | # the Auto Upgrades will proceed. |
| 5251 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 5252 | # with the description of the upgrade. |
| 5253 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 5254 | # with the approximate start time for the upgrades, in |
| 5255 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5256 | }, |
| 5257 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5258 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5259 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 5260 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 5261 | # amount of resources in the cluster. |
| 5262 | { # Contains information about amount of some resource in the cluster. |
| 5263 | # For memory, value should be in GB. |
| 5264 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 5265 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 5266 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5267 | }, |
| 5268 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5269 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 5270 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5271 | # NodePool's nodes can be created by NAP. |
| 5272 | "A String", |
| 5273 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5274 | }, |
| 5275 | "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| 5276 | # Currently available options: |
| 5277 | # |
| 5278 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| 5279 | # service with a Kubernetes-native resource model |
| 5280 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 5281 | # longer available as of GKE 1.15). |
| 5282 | # * `none` - No metrics will be exported from the cluster. |
| 5283 | # |
| 5284 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 5285 | # 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] | 5286 | "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 5287 | # required by Vertical Pod Autoscaler to automatically adjust |
| 5288 | # the resources of pods controlled by it. |
| 5289 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 5290 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5291 | "desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster. |
| 5292 | "type": "A String", # Type of the integration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5293 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5294 | "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration. |
| 5295 | # subscribed to. Release channels are arranged in order of risk. |
| 5296 | # |
| 5297 | # When a cluster is subscribed to a release channel, Google maintains |
| 5298 | # both the master version and the node version. Node auto-upgrade |
| 5299 | # defaults to true and cannot be disabled. |
| 5300 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5301 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5302 | "desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration. |
| 5303 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 5304 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 5305 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 5306 | }, |
| 5307 | "desiredMaster": { # Master is the configuration for components on master. # Configuration for master components. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5308 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5309 | "desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should # The desired status of whether to disable default sNAT for this cluster. |
| 5310 | # be disabled on the cluster. |
| 5311 | "disabled": True or False, # Disables cluster default sNAT rules. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5312 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5313 | "desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature. |
| 5314 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 5315 | # must be valid under a PodSecurityPolicy to be created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5316 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5317 | "desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in |
| 5318 | # desired_node_pool_id. If there is only one pool in the |
| 5319 | # cluster and desired_node_pool_id is not provided then |
| 5320 | # the change applies to that single node pool. |
| 5321 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5322 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 5323 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 5324 | # max_node_count. |
| 5325 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5326 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 5327 | # has to enough quota to scale up the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5328 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5329 | "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the |
| 5330 | # latest supported version. |
| 5331 | # |
| 5332 | # Users may specify either explicit versions offered by |
| 5333 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 5334 | # |
| 5335 | # - "latest": picks the highest valid Kubernetes version |
| 5336 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 5337 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 5338 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 5339 | # - "-": picks the default Kubernetes version |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5340 | "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an |
| 5341 | # upgrade). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5342 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5343 | # Users may specify either explicit versions offered by |
| 5344 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5345 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5346 | # - "latest": picks the highest valid Kubernetes version |
| 5347 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 5348 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 5349 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 5350 | # - "-": picks the Kubernetes master version |
| 5351 | "desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature. |
| 5352 | # master authorized networks will disallow all external traffic to access |
| 5353 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 5354 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 5355 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 5356 | # Kubernetes master through HTTPS. |
| 5357 | { # CidrBlock contains an optional name and one CIDR block. |
| 5358 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 5359 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 5360 | }, |
| 5361 | ], |
| 5362 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 5363 | }, |
| 5364 | "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 5365 | "state": "A String", # Denotes the state of etcd encryption. |
| 5366 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 5367 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 5368 | }, |
| 5369 | "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility. |
| 5370 | # visibility on this cluster. |
| 5371 | "enabled": True or False, # Enables intra node visibility for this cluster. |
| 5372 | }, |
| 5373 | "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 5374 | # cluster, enabling additional functionality. |
| 5375 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 5376 | # extension to manage hosted GCP services through the Kubernetes API |
| 5377 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 5378 | }, |
| 5379 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 5380 | # enabled at cluster creation time. |
| 5381 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 5382 | }, |
| 5383 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 5384 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 5385 | }, |
| 5386 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 5387 | # is enabled or not on the Master, it does not track whether network policy |
| 5388 | # is enabled for the nodes. |
| 5389 | # is enabled or not on the Master, it does not track whether network policy |
| 5390 | # is enabled for the nodes. |
| 5391 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 5392 | }, |
| 5393 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 5394 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 5395 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 5396 | # workloads and applications. For more information, see: |
| 5397 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 5398 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 5399 | }, |
| 5400 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 5401 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 5402 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 5403 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 5404 | # When enabled, it runs a small pod in the cluster that manages the load |
| 5405 | # balancers. |
| 5406 | }, |
| 5407 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 5408 | # microservices. |
| 5409 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 5410 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 5411 | }, |
| 5412 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 5413 | # increases or decreases the number of replica pods a replication controller |
| 5414 | # has based on the resource usage of the existing pods. |
| 5415 | # increases or decreases the number of replica pods a replication controller |
| 5416 | # has based on the resource usage of the existing pods. |
| 5417 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 5418 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 5419 | # Monitoring. |
| 5420 | }, |
| 5421 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 5422 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 5423 | # at cluster creation time. |
| 5424 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 5425 | }, |
| 5426 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 5427 | # applications. |
| 5428 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 5429 | }, |
| 5430 | }, |
| 5431 | "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity. |
| 5432 | # policies. |
| 5433 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 5434 | "identityProvider": "A String", # identity provider is the third party identity provider. |
| 5435 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 5436 | }, |
| 5437 | "desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage. |
| 5438 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 5439 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 5440 | # second BigQuery table will be created to hold resource consumption |
| 5441 | # records. |
| 5442 | }, |
| 5443 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 5444 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 5445 | }, |
| 5446 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 5447 | # daemonset will be created in the cluster to meter network egress traffic. |
| 5448 | }, |
| 5449 | "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. |
| 5450 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 5451 | # images will be validated by Google Binauthz. |
| 5452 | }, |
| 5453 | "desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. |
| 5454 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 5455 | # given only RFC 1918 private addresses and communicate with the master via |
| 5456 | # private networking. |
| 5457 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 5458 | # range will be used for assigning internal IP addresses to the master or |
| 5459 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 5460 | # any other ranges in use within the cluster's network. |
| 5461 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 5462 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 5463 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 5464 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 5465 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 5466 | }, |
| 5467 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 5468 | }, |
| 5469 | "desiredLocations": [ # The desired list of Google Compute Engine |
| 5470 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5471 | # cluster's nodes should be located. Changing the locations a cluster is in |
| 5472 | # will result in nodes being either created or removed from the cluster, |
| 5473 | # depending on whether locations are being added or removed. |
| 5474 | # |
| 5475 | # This list must always include the cluster's primary zone. |
| 5476 | "A String", |
| 5477 | ], |
| 5478 | "desiredImageType": "A String", # The desired image type for the node pool. |
| 5479 | # NOTE: Set the "desired_node_pool" field as well. |
| 5480 | "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if |
| 5481 | # "desired_node_version", "desired_image_family", |
| 5482 | # "desired_node_pool_autoscaling", or "desired_workload_metadata_config" |
| 5483 | # is specified and there is more than one node pool on the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5484 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5485 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 5486 | # number](https://support.google.com/cloud/answer/6158840). |
| 5487 | # This field has been deprecated and replaced by the name field. |
| 5488 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 5489 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5490 | # cluster resides. This field has been deprecated and replaced by the name |
| 5491 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5492 | } |
| 5493 | |
| 5494 | x__xgafv: string, V1 error format. |
| 5495 | Allowed values |
| 5496 | 1 - v1 error format |
| 5497 | 2 - v2 error format |
| 5498 | |
| 5499 | Returns: |
| 5500 | An object of the form: |
| 5501 | |
| 5502 | { # This operation resource represents operations that may have happened or are |
| 5503 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5504 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5505 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5506 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5507 | "stages": [ # Substages of an operation or a stage. |
| 5508 | # Object with schema name: OperationProgress |
| 5509 | ], |
| 5510 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5511 | # Unset for single-stage operations. |
| 5512 | "status": "A String", # Status of an operation stage. |
| 5513 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5514 | "metrics": [ # Progress metric bundle, for example: |
| 5515 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5516 | # {name: "nodes total", int_value: 32}] |
| 5517 | # or |
| 5518 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5519 | # {name: "progress scale", double_value: 1.0}] |
| 5520 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5521 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5522 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5523 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5524 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5525 | }, |
| 5526 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5527 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5528 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5529 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 5530 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5531 | # or |
| 5532 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5533 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5534 | "zone": "A String", # The name of the Google Compute Engine |
| 5535 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5536 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5537 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5538 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5539 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5540 | "name": "A String", # The server-assigned ID for the operation. |
| 5541 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5542 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5543 | # (e.g., ERROR or DEGRADED). |
| 5544 | "code": "A String", # Machine-friendly representation of the condition |
| 5545 | "message": "A String", # Human-friendly representation of the condition |
| 5546 | }, |
| 5547 | ], |
| 5548 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5549 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5550 | "detail": "A String", # Detailed operation progress, if available. |
| 5551 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 5552 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5553 | # (e.g., ERROR or DEGRADED). |
| 5554 | "code": "A String", # Machine-friendly representation of the condition |
| 5555 | "message": "A String", # Human-friendly representation of the condition |
| 5556 | }, |
| 5557 | ], |
| 5558 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5559 | }</pre> |
| 5560 | </div> |
| 5561 | |
| 5562 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5563 | <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] | 5564 | <pre>Updates the master for a specific cluster. |
| 5565 | |
| 5566 | Args: |
| 5567 | 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] | 5568 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5569 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5570 | The object takes the form of: |
| 5571 | |
| 5572 | { # UpdateMasterRequest updates the master of the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5573 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5574 | # number](https://support.google.com/cloud/answer/6158840). |
| 5575 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5576 | "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] | 5577 | # |
| 5578 | # Users may specify either explicit versions offered by |
| 5579 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 5580 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5581 | # - "latest": picks the highest valid Kubernetes version |
| 5582 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 5583 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 5584 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 5585 | # - "-": picks the default Kubernetes version |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5586 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 5587 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5588 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 5589 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5590 | # cluster resides. This field has been deprecated and replaced by the name |
| 5591 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5592 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 5593 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5594 | } |
| 5595 | |
| 5596 | x__xgafv: string, V1 error format. |
| 5597 | Allowed values |
| 5598 | 1 - v1 error format |
| 5599 | 2 - v2 error format |
| 5600 | |
| 5601 | Returns: |
| 5602 | An object of the form: |
| 5603 | |
| 5604 | { # This operation resource represents operations that may have happened or are |
| 5605 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5606 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 5607 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5608 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5609 | "stages": [ # Substages of an operation or a stage. |
| 5610 | # Object with schema name: OperationProgress |
| 5611 | ], |
| 5612 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5613 | # Unset for single-stage operations. |
| 5614 | "status": "A String", # Status of an operation stage. |
| 5615 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5616 | "metrics": [ # Progress metric bundle, for example: |
| 5617 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5618 | # {name: "nodes total", int_value: 32}] |
| 5619 | # or |
| 5620 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5621 | # {name: "progress scale", double_value: 1.0}] |
| 5622 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5623 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5624 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5625 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5626 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5627 | }, |
| 5628 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5629 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5630 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5631 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 5632 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5633 | # or |
| 5634 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5635 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5636 | "zone": "A String", # The name of the Google Compute Engine |
| 5637 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5638 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5639 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5640 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5641 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 5642 | "name": "A String", # The server-assigned ID for the operation. |
| 5643 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5644 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5645 | # (e.g., ERROR or DEGRADED). |
| 5646 | "code": "A String", # Machine-friendly representation of the condition |
| 5647 | "message": "A String", # Human-friendly representation of the condition |
| 5648 | }, |
| 5649 | ], |
| 5650 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5651 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5652 | "detail": "A String", # Detailed operation progress, if available. |
| 5653 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 5654 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5655 | # (e.g., ERROR or DEGRADED). |
| 5656 | "code": "A String", # Machine-friendly representation of the condition |
| 5657 | "message": "A String", # Human-friendly representation of the condition |
| 5658 | }, |
| 5659 | ], |
| 5660 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5661 | }</pre> |
| 5662 | </div> |
| 5663 | |
| 5664 | </body></html> |