| 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | <code><a href="#delete">delete(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] | 95 | <p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker</p> |
| 96 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 97 | <code><a href="#get">get(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] | 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | <code><a href="#list">list(parent, projectId=None, zone=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | <p class="firstline">Lists all clusters owned by a project in either the specified zone or all</p> |
| 105 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 106 | <code><a href="#setAddons">setAddons(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | <p class="firstline">Sets the addons for a specific cluster.</p> |
| 108 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 109 | <code><a href="#setLegacyAbac">setLegacyAbac(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | <p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p> |
| 111 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | <code><a href="#setLocations">setLocations(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <p class="firstline">Sets the locations for a specific cluster.</p> |
| 114 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | <code><a href="#setLogging">setLogging(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | <p class="firstline">Sets the logging service for a specific cluster.</p> |
| 117 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | <code><a href="#setMaintenancePolicy">setMaintenancePolicy(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | <p class="firstline">Sets the maintenance policy for a cluster.</p> |
| 120 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | <code><a href="#setMasterAuth">setMasterAuth(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | <p class="firstline">Sets master auth materials. Currently supports changing the admin password</p> |
| 123 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 124 | <code><a href="#setMonitoring">setMonitoring(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | <p class="firstline">Sets the monitoring service for a specific cluster.</p> |
| 126 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | <code><a href="#setNetworkPolicy">setNetworkPolicy(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 128 | <p class="firstline">Enables or disables Network Policy for a cluster.</p> |
| 129 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 130 | <code><a href="#setResourceLabels">setResourceLabels(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | <p class="firstline">Sets labels on a cluster.</p> |
| 132 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | <code><a href="#startIpRotation">startIpRotation(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | <p class="firstline">Starts master IP rotation.</p> |
| 135 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 136 | <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 137 | <p class="firstline">Updates the settings 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 | "name": "A String", # The name (project, location, cluster id) of the cluster to complete IP |
| 154 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| 155 | "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] | 156 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 157 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "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] | 159 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 160 | # cluster resides. This field has been deprecated and replaced by the name |
| 161 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 177 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 178 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | "code": "A String", # Machine-friendly representation of the condition |
| 180 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 181 | }, |
| 182 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 183 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 184 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 185 | # or |
| 186 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 187 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 188 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 189 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 190 | "startTime": "A String", # [Output only] The time the operation started, in |
| 191 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 192 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 193 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 194 | # (e.g., ERROR or DEGRADED). |
| 195 | "code": "A String", # Machine-friendly representation of the condition |
| 196 | "message": "A String", # Human-friendly representation of the condition |
| 197 | }, |
| 198 | ], |
| 199 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 200 | "stages": [ # Substages of an operation or a stage. |
| 201 | # Object with schema name: OperationProgress |
| 202 | ], |
| 203 | "status": "A String", # Status of an operation stage. |
| 204 | # Unset for single-stage operations. |
| 205 | "metrics": [ # Progress metric bundle, for example: |
| 206 | # metrics: [{name: "nodes done", int_value: 15}, |
| 207 | # {name: "nodes total", int_value: 32}] |
| 208 | # or |
| 209 | # metrics: [{name: "progress", double_value: 0.56}, |
| 210 | # {name: "progress scale", double_value: 1.0}] |
| 211 | { # Progress metric is (string, int|float|string) pair. |
| 212 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 213 | "doubleValue": 3.14, # For metrics with floating point value. |
| 214 | "intValue": "A String", # For metrics with integer value. |
| 215 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 216 | }, |
| 217 | ], |
| 218 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 219 | # Unset for single-stage operations. |
| 220 | }, |
| 221 | "zone": "A String", # The name of the Google Compute Engine |
| 222 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 223 | # operation is taking place. This field is deprecated, use location instead. |
| 224 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 225 | "selfLink": "A String", # Server-defined URL for the resource. |
| 226 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 227 | "detail": "A String", # Detailed operation progress, if available. |
| 228 | "operationType": "A String", # The operation type. |
| 229 | "status": "A String", # The current status of the operation. |
| 230 | "name": "A String", # The server-assigned ID for 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | "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] | 259 | # number](https://support.google.com/cloud/answer/6158840). |
| 260 | # This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 262 | # resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.zones.clusters) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 264 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 265 | # if cluster created with IP Alias support. |
| 266 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 267 | }, |
| 268 | "network": "A String", # The name of the Google Compute Engine |
| 269 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 270 | # to which the cluster is connected. If left unspecified, the `default` |
| 271 | # network will be used. On output this shows the network ID instead of the |
| 272 | # name. |
| 273 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 274 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 275 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 276 | # range. This field will only be set when cluster is in route-based network |
| 277 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 278 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 279 | # master authorized networks will disallow all external traffic to access |
| 280 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 281 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 282 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 283 | # Kubernetes master through HTTPS. |
| 284 | { # CidrBlock contains an optional name and one CIDR block. |
| 285 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 286 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 287 | }, |
| 288 | ], |
| 289 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 290 | }, |
| 291 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 292 | # cluster, if available. |
| 293 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 294 | # If unspecified, the defaults are used: |
| 295 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 296 | # be set to "admin", a random password will be generated, and a client |
| 297 | # certificate will be issued. |
| 298 | # Authentication can be done using HTTP basic auth or using client |
| 299 | # certificates. |
| 300 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 301 | # Because the master endpoint is open to the Internet, you should create a |
| 302 | # strong password. If a password is provided for cluster creation, username |
| 303 | # must be non-empty. |
| 304 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 305 | # clusters before v1.12, if no configuration is specified, a client |
| 306 | # certificate is issued. |
| 307 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 308 | }, |
| 309 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 310 | # to the cluster endpoint. |
| 311 | "clusterCaCertificate": "A String", |
| 312 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 313 | # authenticate to the cluster endpoint. |
| 314 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 315 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 316 | # leaving username unspecified (or setting it to the empty string). |
| 317 | }, |
| 318 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 319 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 320 | # during authentication using a group of security groups. |
| 321 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 322 | # if enabled = true. |
| 323 | }, |
| 324 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 325 | # This prefix will be used for assigning private IP addresses to the |
| 326 | # master or set of masters, as well as the ILB VIP. |
| 327 | # This field is deprecated, use |
| 328 | # private_cluster_config.master_ipv4_cidr_block instead. |
| 329 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 330 | "type": "A String", # Type of the integration. |
| 331 | }, |
| 332 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 333 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 334 | # cluster, enabling additional functionality. |
| 335 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 336 | # is enabled or not on the Master, it does not track whether network policy |
| 337 | # is enabled for the nodes. |
| 338 | # is enabled or not on the Master, it does not track whether network policy |
| 339 | # is enabled for the nodes. |
| 340 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 341 | }, |
| 342 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 343 | # extension to manage hosted GCP services through the Kubernetes API |
| 344 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 345 | }, |
| 346 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 347 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 348 | # at cluster creation time. |
| 349 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 350 | }, |
| 351 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 352 | # increases or decreases the number of replica pods a replication controller |
| 353 | # has based on the resource usage of the existing pods. |
| 354 | # increases or decreases the number of replica pods a replication controller |
| 355 | # has based on the resource usage of the existing pods. |
| 356 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 357 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 358 | # Monitoring. |
| 359 | }, |
| 360 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 361 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 362 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 363 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 364 | # When enabled, it runs a small pod in the cluster that manages the load |
| 365 | # balancers. |
| 366 | }, |
| 367 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 368 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 369 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 370 | # workloads and applications. For more information, see: |
| 371 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 372 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 373 | }, |
| 374 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 375 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 376 | }, |
| 377 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 378 | # applications. |
| 379 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 380 | }, |
| 381 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 382 | # enabled at cluster creation time. |
| 383 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 384 | }, |
| 385 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 386 | # microservices. |
| 387 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 388 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 389 | }, |
| 390 | }, |
| 391 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 392 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 393 | # must be valid under a PodSecurityPolicy to be created. |
| 394 | }, |
| 395 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 396 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 397 | # instead. The current version of the node software components. |
| 398 | # If they are currently at multiple versions because they're in the process |
| 399 | # of being upgraded, this reflects the minimum version of all nodes. |
| 400 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 401 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 402 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 403 | # the name. |
| 404 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 405 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 406 | # the policy won't accidentally undo intermediate changes (and so that users |
| 407 | # of the API unaware of some fields won't accidentally remove other fields). |
| 408 | # Make a <code>get()</code> request to the cluster to get the current |
| 409 | # resource version and include it with requests to set the policy. |
| 410 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 411 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 412 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 413 | # smallest possible in the given scenario. |
| 414 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 415 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 416 | }, |
| 417 | "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] | 418 | # maintenance to occur. The time windows may be overlapping. If no |
| 419 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | "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] | 421 | # this window reccurs. They go on for the span of time between the start and |
| 422 | # end time. |
| 423 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 424 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 425 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 426 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 427 | # <code>FREQ=DAILY</code> |
| 428 | # For the first weekend of every month: |
| 429 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 430 | # 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] | 431 | # 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] | 432 | # <code> |
| 433 | # start time = 2019-01-01T09:00:00-0400 |
| 434 | # end time = 2019-01-01T17:00:00-0400 |
| 435 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 436 | # </code> |
| 437 | # Windows can span multiple days. Eg, to make the window encompass every |
| 438 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 439 | # <code> |
| 440 | # start time = 2019-01-05T00:00:00Z |
| 441 | # end time = 2019-01-07T23:59:00Z |
| 442 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 443 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 444 | # 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] | 445 | # to specify duration of the window and when it first starts. |
| 446 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 447 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 448 | "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] | 449 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 450 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 451 | }, |
| 452 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 453 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 454 | # occur in these windows. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | "a_key": { # Represents an arbitrary window of time. |
| 456 | "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] | 457 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 458 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 459 | }, |
| 460 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 461 | }, |
| 462 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 463 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 464 | # Google Compute Engine resources. |
| 465 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 466 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 468 | # found in validMasterVersions returned by getServerConfig. The version can |
| 469 | # be upgraded over time; such upgrades are reflected in |
| 470 | # currentMasterVersion and currentNodeVersion. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 471 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 472 | # Users may specify either explicit versions offered by |
| 473 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 474 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 475 | # - "latest": picks the highest valid Kubernetes version |
| 476 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 477 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 478 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 479 | # - "","-": picks the default Kubernetes version |
| 480 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| 481 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 482 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 483 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 484 | # then the server picks the default IP allocation mode |
| 485 | "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] | 486 | # will be automatically chosen with the default size. |
| 487 | # |
| 488 | # This field is only applicable when `use_ip_aliases` is true. |
| 489 | # |
| 490 | # Set to blank to have a range chosen with the default size. |
| 491 | # |
| 492 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 493 | # netmask. |
| 494 | # |
| 495 | # Set to a |
| 496 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 497 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 498 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 499 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 500 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 501 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 502 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 503 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 504 | # range. |
| 505 | # |
| 506 | # If this field is set to true, then cluster and services CIDRs must be |
| 507 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 508 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 509 | # `services_ipv4_cidr_block` must be fully-specified. |
| 510 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 511 | # fully-specified. |
| 512 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 513 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 514 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 515 | # |
| 516 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 517 | # |
| 518 | # Set to blank to have a range chosen with the default size. |
| 519 | # |
| 520 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 521 | # netmask. |
| 522 | # |
| 523 | # Set to a |
| 524 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 525 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 526 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 527 | # to use. |
| 528 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 529 | # block. The secondary range will be used for pod IP |
| 530 | # addresses. This must be an existing secondary range associated |
| 531 | # with the cluster subnetwork. |
| 532 | # |
| 533 | # This field is only applicable with use_ip_aliases and |
| 534 | # create_subnetwork is false. |
| 535 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 536 | # |
| 537 | # This is applicable only if `create_subnetwork` is true. |
| 538 | # |
| 539 | # Set to blank to have a range chosen with the default size. |
| 540 | # |
| 541 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 542 | # netmask. |
| 543 | # |
| 544 | # Set to a |
| 545 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 546 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 547 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 548 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 549 | "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] | 550 | # range will be automatically chosen with the default size. |
| 551 | # |
| 552 | # This field is only applicable when `use_ip_aliases` is true. |
| 553 | # |
| 554 | # If unspecified, the range will use the default size. |
| 555 | # |
| 556 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 557 | # netmask. |
| 558 | # |
| 559 | # Set to a |
| 560 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 561 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 562 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 563 | # to use. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 564 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 565 | "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] | 566 | # CIDR block. The secondary range will be used for service |
| 567 | # ClusterIPs. This must be an existing secondary range associated |
| 568 | # with the cluster subnetwork. |
| 569 | # |
| 570 | # This field is only applicable with use_ip_aliases and |
| 571 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 572 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 573 | # This is used in conjunction with use_routes. It cannot |
| 574 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 575 | # false, then the server picks the default IP allocation mode |
| 576 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 577 | # |
| 578 | # This field is only applicable when `use_ip_aliases` is true. |
| 579 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 580 | # this field is empty, then an automatic name will be chosen for the new |
| 581 | # subnetwork. |
| 582 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 583 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 584 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 585 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 586 | # mode. |
| 587 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 588 | # identities in the system, including service accounts, nodes, and |
| 589 | # controllers, will have statically granted permissions beyond those |
| 590 | # provided by the RBAC configuration or IAM. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 591 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 593 | # This field is deprecated, use tpu_config.enabled instead. |
| 594 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 595 | # disabled when this config unspecified. |
| 596 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 597 | # daemonset will be created in the cluster to meter network egress traffic. |
| 598 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 599 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 600 | # second BigQuery table will be created to hold resource consumption |
| 601 | # records. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 602 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 603 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 604 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 605 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 606 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 607 | "locations": [ # The list of Google Compute Engine |
| 608 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 609 | # cluster's nodes should be located. |
| 610 | "A String", |
| 611 | ], |
| 612 | "nodePools": [ # The node pools associated with this cluster. |
| 613 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 614 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 615 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 616 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 617 | # specification, under the control of the cluster master. They may have a set |
| 618 | # of Kubernetes labels applied to them, which may be used to reference them |
| 619 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 620 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 621 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 622 | # node pool instance, if available. |
| 623 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 624 | # only if a valid configuration is present. |
| 625 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 626 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 627 | # max_node_count. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 628 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 629 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 630 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 631 | # has to enough quota to scale up the cluster. |
| 632 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 633 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 634 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 635 | # is sufficient for this number of instances. You must also have available |
| 636 | # firewall and routes quota. |
| 637 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 638 | # disruption caused by an upgrade. |
| 639 | # |
| 640 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 641 | # unavailable. |
| 642 | # |
| 643 | # maxSurge controls the number of additional nodes that can be added to the |
| 644 | # node pool temporarily for the time of the upgrade to increase the number of |
| 645 | # available nodes. |
| 646 | # |
| 647 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 648 | # nodes are being upgraded at the same time). |
| 649 | # |
| 650 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 651 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 652 | # this holds true. (Disruption stays within the limits of |
| 653 | # PodDisruptionBudget, if it is configured.) |
| 654 | # |
| 655 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 656 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 657 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 658 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 659 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 660 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 661 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 662 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 663 | # the upgrade process. A node is considered available if its status is |
| 664 | # Ready. |
| 665 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 666 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 667 | "locations": [ # The list of Google Compute Engine |
| 668 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 669 | # NodePool's nodes should be located. |
| 670 | "A String", |
| 671 | ], |
| 672 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 673 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 674 | # associated with this node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 675 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 676 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 677 | "version": "A String", # The version of the Kubernetes of this node. |
| 678 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 679 | "conditions": [ # Which conditions caused the current node pool state. |
| 680 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 681 | # (e.g., ERROR or DEGRADED). |
| 682 | "code": "A String", # Machine-friendly representation of the condition |
| 683 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 684 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 685 | ], |
| 686 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 687 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 688 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 689 | # The smallest allowed disk size is 10GB. |
| 690 | # |
| 691 | # If unspecified, the default disk size is 100GB. |
| 692 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 693 | # workloads on the node pool. |
| 694 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 695 | # workloads running on the node. |
| 696 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 697 | # on the node pool. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 698 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 699 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 700 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 701 | # support for GPUs. |
| 702 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 703 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 704 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 705 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 706 | }, |
| 707 | ], |
| 708 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 709 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 710 | # `n1-standard-1`). |
| 711 | # |
| 712 | # If unspecified, the default machine type is |
| 713 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 714 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 715 | # |
| 716 | # If unspecified, the default disk type is 'pd-standard' |
| 717 | "bootDiskKmsKey": "A String", # |
| 718 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 719 | # to each node in the node pool. This should be of the form |
| 720 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 721 | # For more information about protecting resources with Cloud KMS Keys please |
| 722 | # see: |
| 723 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 724 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 725 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 726 | # |
| 727 | # Secure Boot helps ensure that the system only runs authentic software by |
| 728 | # verifying the digital signature of all boot components, and halting the |
| 729 | # boot process if signature verification fails. |
| 730 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 731 | # |
| 732 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 733 | # The attestation is performed against the integrity policy baseline. This |
| 734 | # baseline is initially derived from the implicitly trusted boot image when |
| 735 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 736 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 737 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 738 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 739 | # friendly names of CPU platforms, such as |
| 740 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 741 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 742 | # information, read [how to specify min CPU |
| 743 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 744 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 745 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 746 | # inforamtion about preemptible VM instances. |
| 747 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 748 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | # The limit for this value is dependent upon the maximum number of |
| 750 | # disks available on a machine per zone. See: |
| 751 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 752 | # for more information. |
| 753 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 754 | "type": "A String", # Type of the sandbox to use for the node. |
| 755 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 756 | }, |
| 757 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 758 | # |
| 759 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 760 | # in length. These are reflected as part of a URL in the metadata server. |
| 761 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 762 | # metadata keys for the project or be one of the reserved keys: |
| 763 | # "cluster-location" |
| 764 | # "cluster-name" |
| 765 | # "cluster-uid" |
| 766 | # "configure-sh" |
| 767 | # "containerd-configure-sh" |
| 768 | # "enable-oslogin" |
| 769 | # "gci-ensure-gke-docker" |
| 770 | # "gci-metrics-enabled" |
| 771 | # "gci-update-strategy" |
| 772 | # "instance-template" |
| 773 | # "kube-env" |
| 774 | # "startup-script" |
| 775 | # "user-data" |
| 776 | # "disable-address-manager" |
| 777 | # "windows-startup-script-ps1" |
| 778 | # "common-psm1" |
| 779 | # "k8s-node-setup-psm1" |
| 780 | # "install-ssh-psm1" |
| 781 | # "user-profile-psm1" |
| 782 | # "serial-port-logging-enable" |
| 783 | # Values are free-form strings, and only have meaning as interpreted by |
| 784 | # the image running in the instance. The only restriction placed on them is |
| 785 | # that each value's size must be less than or equal to 32 KB. |
| 786 | # |
| 787 | # The total size of all keys and values must be less than 512 KB. |
| 788 | "a_key": "A String", |
| 789 | }, |
| 790 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 791 | # the specified [Zonal Compute |
| 792 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 793 | # to this node pool. |
| 794 | # is the configuration of desired reservation which instances could take |
| 795 | # capacity from. |
| 796 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 797 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 798 | # the key and specify the name of your reservation as its value. |
| 799 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 800 | "A String", |
| 801 | ], |
| 802 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 803 | }, |
| 804 | "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] | 805 | # valid sources or targets for network firewalls and are specified by |
| 806 | # the client during cluster or node pool creation. Each tag within the list |
| 807 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 808 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 809 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 810 | "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] | 811 | # 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] | 812 | # Account is specified, the "default" service account is used. |
| 813 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 814 | # the latest version of it will be used. |
| 815 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 816 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 817 | # |
| 818 | # The following scopes are recommended, but not required, and by default are |
| 819 | # not included: |
| 820 | # |
| 821 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 822 | # persistent storage on your nodes. |
| 823 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 824 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 825 | # (the [Google Container |
| 826 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 827 | # |
| 828 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 829 | # 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] | 830 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 831 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 832 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 833 | # |
| 834 | # For more information, including usage and the valid values, see: |
| 835 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 836 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 837 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 838 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 839 | # See |
| 840 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 841 | # for more information, including usage and the valid values. |
| 842 | "key": "A String", # Key for taint. |
| 843 | "value": "A String", # Value for taint. |
| 844 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 845 | }, |
| 846 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 847 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 848 | # These will added in addition to any default label(s) that |
| 849 | # Kubernetes may apply to the node. |
| 850 | # In case of conflict in label keys, the applied set may differ depending on |
| 851 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 852 | # and conflicts should be avoided. |
| 853 | # For more information, including usage and the valid values, see: |
| 854 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 855 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 856 | }, |
| 857 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 858 | "name": "A String", # The name of the node pool. |
| 859 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 860 | # simultaneously on a node in the node pool. |
| 861 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 862 | }, |
| 863 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 864 | # node pool. |
| 865 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 866 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 867 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 868 | # the Auto Upgrades will proceed. |
| 869 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 870 | # with the description of the upgrade. |
| 871 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 872 | # with the approximate start time for the upgrades, in |
| 873 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 874 | }, |
| 875 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 876 | }, |
| 877 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 878 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 879 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 880 | # this cluster, in |
| 881 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 882 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 883 | # typically put in the last `/16` from the container CIDR. |
| 884 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 885 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 886 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 887 | "provider": "A String", # The selected network policy provider. |
| 888 | }, |
| 889 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 890 | # subscribed to. Release channels are arranged in order of risk and |
| 891 | # frequency of updates. |
| 892 | # |
| 893 | # When a cluster is subscribed to a release channel, Google maintains |
| 894 | # both the master version and the node version. Node auto-upgrade |
| 895 | # defaults to true and cannot be disabled. Updates to version related |
| 896 | # fields (e.g. current_master_version) return an error. |
| 897 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 898 | }, |
| 899 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 900 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 901 | # the kubernetes version of the master and nodes. |
| 902 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 903 | # Alpha enabled clusters are automatically deleted thirty days after |
| 904 | # creation. |
| 905 | "description": "A String", # An optional description of this cluster. |
| 906 | "conditions": [ # Which conditions caused the current cluster state. |
| 907 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 908 | # (e.g., ERROR or DEGRADED). |
| 909 | "code": "A String", # Machine-friendly representation of the condition |
| 910 | "message": "A String", # Human-friendly representation of the condition |
| 911 | }, |
| 912 | ], |
| 913 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 914 | # default have no external IP addresses on the nodes and where nodes and the |
| 915 | # master communicate over private IP addresses. |
| 916 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 917 | # instead. |
| 918 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 919 | # Call Kubernetes API directly to retrieve node information. |
| 920 | "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] | 921 | # Currently available options: |
| 922 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 923 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 924 | # service with a Kubernetes-native resource model |
| 925 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 926 | # longer available as of GKE 1.15). |
| 927 | # * `none` - No metrics will be exported from the cluster. |
| 928 | # |
| 929 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 930 | # 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] | 931 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 932 | "state": "A String", # Denotes the state of etcd encryption. |
| 933 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 934 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 935 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 936 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 937 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 938 | # images will be validated by Google Binauthz. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 939 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 941 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 942 | # notation (e.g. `1.2.3.4/29`). |
| 943 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 944 | # policies. |
| 945 | # policies. |
| 946 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 947 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 948 | }, |
| 949 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 950 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 951 | # cluster resides. This field is deprecated, use location instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 952 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 953 | # Currently available options: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 954 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 955 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 956 | # service with a Kubernetes-native resource model |
| 957 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 958 | # available as of GKE 1.15). |
| 959 | # * `none` - no logs will be exported from the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 960 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 961 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 962 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 963 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 964 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 965 | "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] | 966 | # 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] | 967 | # "node_pool" object, since this configuration (along with the |
| 968 | # "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] | 969 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 970 | # For responses, this field will be populated with the node configuration of |
| 971 | # the first node pool. (For configuration of each node pool, see |
| 972 | # `node_pool.config`) |
| 973 | # |
| 974 | # If unspecified, the defaults are used. |
| 975 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 976 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 977 | # The smallest allowed disk size is 10GB. |
| 978 | # |
| 979 | # If unspecified, the default disk size is 100GB. |
| 980 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 981 | # workloads on the node pool. |
| 982 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 983 | # workloads running on the node. |
| 984 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 985 | # on the node pool. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 986 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 987 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 988 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 989 | # support for GPUs. |
| 990 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 991 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 992 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 993 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 994 | }, |
| 995 | ], |
| 996 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 997 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 998 | # `n1-standard-1`). |
| 999 | # |
| 1000 | # If unspecified, the default machine type is |
| 1001 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1002 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1003 | # |
| 1004 | # If unspecified, the default disk type is 'pd-standard' |
| 1005 | "bootDiskKmsKey": "A String", # |
| 1006 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 1007 | # to each node in the node pool. This should be of the form |
| 1008 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 1009 | # For more information about protecting resources with Cloud KMS Keys please |
| 1010 | # see: |
| 1011 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 1012 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 1013 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1014 | # |
| 1015 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1016 | # verifying the digital signature of all boot components, and halting the |
| 1017 | # boot process if signature verification fails. |
| 1018 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1019 | # |
| 1020 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1021 | # The attestation is performed against the integrity policy baseline. This |
| 1022 | # baseline is initially derived from the implicitly trusted boot image when |
| 1023 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1024 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1025 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1026 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1027 | # friendly names of CPU platforms, such as |
| 1028 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1029 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1030 | # information, read [how to specify min CPU |
| 1031 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1032 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1033 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1034 | # inforamtion about preemptible VM instances. |
| 1035 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1036 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1037 | # The limit for this value is dependent upon the maximum number of |
| 1038 | # disks available on a machine per zone. See: |
| 1039 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 1040 | # for more information. |
| 1041 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1042 | "type": "A String", # Type of the sandbox to use for the node. |
| 1043 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 1044 | }, |
| 1045 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1046 | # |
| 1047 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1048 | # in length. These are reflected as part of a URL in the metadata server. |
| 1049 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1050 | # metadata keys for the project or be one of the reserved keys: |
| 1051 | # "cluster-location" |
| 1052 | # "cluster-name" |
| 1053 | # "cluster-uid" |
| 1054 | # "configure-sh" |
| 1055 | # "containerd-configure-sh" |
| 1056 | # "enable-oslogin" |
| 1057 | # "gci-ensure-gke-docker" |
| 1058 | # "gci-metrics-enabled" |
| 1059 | # "gci-update-strategy" |
| 1060 | # "instance-template" |
| 1061 | # "kube-env" |
| 1062 | # "startup-script" |
| 1063 | # "user-data" |
| 1064 | # "disable-address-manager" |
| 1065 | # "windows-startup-script-ps1" |
| 1066 | # "common-psm1" |
| 1067 | # "k8s-node-setup-psm1" |
| 1068 | # "install-ssh-psm1" |
| 1069 | # "user-profile-psm1" |
| 1070 | # "serial-port-logging-enable" |
| 1071 | # Values are free-form strings, and only have meaning as interpreted by |
| 1072 | # the image running in the instance. The only restriction placed on them is |
| 1073 | # that each value's size must be less than or equal to 32 KB. |
| 1074 | # |
| 1075 | # The total size of all keys and values must be less than 512 KB. |
| 1076 | "a_key": "A String", |
| 1077 | }, |
| 1078 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1079 | # the specified [Zonal Compute |
| 1080 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1081 | # to this node pool. |
| 1082 | # is the configuration of desired reservation which instances could take |
| 1083 | # capacity from. |
| 1084 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1085 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1086 | # the key and specify the name of your reservation as its value. |
| 1087 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1088 | "A String", |
| 1089 | ], |
| 1090 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 1091 | }, |
| 1092 | "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] | 1093 | # valid sources or targets for network firewalls and are specified by |
| 1094 | # the client during cluster or node pool creation. Each tag within the list |
| 1095 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1096 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1097 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1098 | "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] | 1099 | # 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] | 1100 | # Account is specified, the "default" service account is used. |
| 1101 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1102 | # the latest version of it will be used. |
| 1103 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1104 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1105 | # |
| 1106 | # The following scopes are recommended, but not required, and by default are |
| 1107 | # not included: |
| 1108 | # |
| 1109 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1110 | # persistent storage on your nodes. |
| 1111 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1112 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1113 | # (the [Google Container |
| 1114 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1115 | # |
| 1116 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1117 | # 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] | 1118 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1119 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1120 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1121 | # |
| 1122 | # For more information, including usage and the valid values, see: |
| 1123 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1124 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1125 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1126 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1127 | # See |
| 1128 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1129 | # for more information, including usage and the valid values. |
| 1130 | "key": "A String", # Key for taint. |
| 1131 | "value": "A String", # Value for taint. |
| 1132 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1133 | }, |
| 1134 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1135 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1136 | # These will added in addition to any default label(s) that |
| 1137 | # Kubernetes may apply to the node. |
| 1138 | # In case of conflict in label keys, the applied set may differ depending on |
| 1139 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1140 | # and conflicts should be avoided. |
| 1141 | # For more information, including usage and the valid values, see: |
| 1142 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1143 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1144 | }, |
| 1145 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1146 | "status": "A String", # [Output only] The current status of this cluster. |
| 1147 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 1148 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 1149 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 1150 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 1151 | }, |
| 1152 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 1153 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 1154 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 1155 | # cluster is connected. Example: |
| 1156 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 1157 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 1158 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1159 | # to which the cluster is connected. Example: |
| 1160 | # projects/my-project/global/networks/my-network |
| 1161 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 1162 | # This makes same node pod to pod traffic visible for VPC network. |
| 1163 | }, |
| 1164 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 1165 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 1166 | # the following restrictions: |
| 1167 | # |
| 1168 | # * Lowercase letters, numbers, and hyphens only. |
| 1169 | # * Must start with a letter. |
| 1170 | # * Must end with a number or a letter. |
| 1171 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 1172 | # The endpoint can be accessed from the internet at |
| 1173 | # `https://username:password@endpoint/`. |
| 1174 | # |
| 1175 | # See the `masterAuth` property of this resource for username and |
| 1176 | # password information. |
| 1177 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1178 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1179 | # or |
| 1180 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1181 | # in which the cluster resides. |
| 1182 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 1183 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1184 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1185 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1186 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 1187 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1188 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 1189 | # required by Cluster Autoscaler to automatically adjust |
| 1190 | # the size of the cluster and create/delete |
| 1191 | # node pools based on the current needs. |
| 1192 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 1193 | # amount of resources in the cluster. |
| 1194 | { # Contains information about amount of some resource in the cluster. |
| 1195 | # For memory, value should be in GB. |
| 1196 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 1197 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 1198 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 1199 | }, |
| 1200 | ], |
| 1201 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 1202 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 1203 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 1204 | # created by NAP. |
| 1205 | # by NAP. |
| 1206 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 1207 | # specified, service_account should be empty. |
| 1208 | "A String", |
| 1209 | ], |
| 1210 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 1211 | # node pool. |
| 1212 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 1213 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 1214 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1215 | # the Auto Upgrades will proceed. |
| 1216 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1217 | # with the description of the upgrade. |
| 1218 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1219 | # with the approximate start time for the upgrades, in |
| 1220 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1221 | }, |
| 1222 | }, |
| 1223 | "minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. |
| 1224 | # The instance may be scheduled on the specified or newer CPU platform. |
| 1225 | # Applicable values are the friendly names of CPU platforms, such as |
| 1226 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1227 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1228 | # information, read [how to specify min CPU |
| 1229 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1230 | # To unset the min cpu platform field pass "automatic" as field value. |
| 1231 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 1232 | # disruption caused by an upgrade. |
| 1233 | # |
| 1234 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1235 | # unavailable. |
| 1236 | # |
| 1237 | # maxSurge controls the number of additional nodes that can be added to the |
| 1238 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1239 | # available nodes. |
| 1240 | # |
| 1241 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1242 | # nodes are being upgraded at the same time). |
| 1243 | # |
| 1244 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1245 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1246 | # this holds true. (Disruption stays within the limits of |
| 1247 | # PodDisruptionBudget, if it is configured.) |
| 1248 | # |
| 1249 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1250 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1251 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1252 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1253 | # there are always at least 4 nodes available. |
| 1254 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1255 | # of the node pool during the upgrade process. |
| 1256 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 1257 | # the upgrade process. A node is considered available if its status is |
| 1258 | # Ready. |
| 1259 | }, |
| 1260 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 1261 | # service_account is specified, scopes should be empty. |
| 1262 | }, |
| 1263 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 1264 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1265 | # NodePool's nodes can be created by NAP. |
| 1266 | "A String", |
| 1267 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1268 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1269 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 1270 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1271 | # is sufficient for this number of instances. You must also have available |
| 1272 | # firewall and routes quota. |
| 1273 | # 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] | 1274 | # "node_pool" object, since this configuration (along with the |
| 1275 | # "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] | 1276 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1277 | # |
| 1278 | # This field is deprecated, use node_pool.initial_node_count instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1279 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 1280 | "A String", |
| 1281 | ], |
| 1282 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 1283 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 1284 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 1285 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 1286 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 1287 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 1288 | }, |
| 1289 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 1290 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 1291 | # given only RFC 1918 private addresses and communicate with the master via |
| 1292 | # private networking. |
| 1293 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 1294 | # range will be used for assigning internal IP addresses to the master or |
| 1295 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 1296 | # any other ranges in use within the cluster's network. |
| 1297 | }, |
| 1298 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 1299 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 1300 | }, |
| 1301 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 1302 | # required by Vertical Pod Autoscaler to automatically adjust |
| 1303 | # the resources of pods controlled by it. |
| 1304 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 1305 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1306 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1307 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 1308 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1309 | # cluster resides. This field has been deprecated and replaced by the parent |
| 1310 | # field. |
| 1311 | "parent": "A String", # The parent (project and location) where the cluster will be created. |
| 1312 | # Specified in the format `projects/*/locations/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1313 | } |
| 1314 | |
| 1315 | x__xgafv: string, V1 error format. |
| 1316 | Allowed values |
| 1317 | 1 - v1 error format |
| 1318 | 2 - v2 error format |
| 1319 | |
| 1320 | Returns: |
| 1321 | An object of the form: |
| 1322 | |
| 1323 | { # This operation resource represents operations that may have happened or are |
| 1324 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1325 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1326 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1327 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1328 | "code": "A String", # Machine-friendly representation of the condition |
| 1329 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1330 | }, |
| 1331 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1332 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1333 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1334 | # or |
| 1335 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1336 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1337 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1338 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1339 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1340 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1341 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1342 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1343 | # (e.g., ERROR or DEGRADED). |
| 1344 | "code": "A String", # Machine-friendly representation of the condition |
| 1345 | "message": "A String", # Human-friendly representation of the condition |
| 1346 | }, |
| 1347 | ], |
| 1348 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1349 | "stages": [ # Substages of an operation or a stage. |
| 1350 | # Object with schema name: OperationProgress |
| 1351 | ], |
| 1352 | "status": "A String", # Status of an operation stage. |
| 1353 | # Unset for single-stage operations. |
| 1354 | "metrics": [ # Progress metric bundle, for example: |
| 1355 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1356 | # {name: "nodes total", int_value: 32}] |
| 1357 | # or |
| 1358 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1359 | # {name: "progress scale", double_value: 1.0}] |
| 1360 | { # Progress metric is (string, int|float|string) pair. |
| 1361 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1362 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1363 | "intValue": "A String", # For metrics with integer value. |
| 1364 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1365 | }, |
| 1366 | ], |
| 1367 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1368 | # Unset for single-stage operations. |
| 1369 | }, |
| 1370 | "zone": "A String", # The name of the Google Compute Engine |
| 1371 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1372 | # operation is taking place. This field is deprecated, use location instead. |
| 1373 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1374 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1375 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1376 | "detail": "A String", # Detailed operation progress, if available. |
| 1377 | "operationType": "A String", # The operation type. |
| 1378 | "status": "A String", # The current status of the operation. |
| 1379 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1380 | }</pre> |
| 1381 | </div> |
| 1382 | |
| 1383 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1384 | <code class="details" id="delete">delete(name, clusterId=None, projectId=None, zone=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1385 | <pre>Deletes the cluster, including the Kubernetes endpoint and all worker |
| 1386 | nodes. |
| 1387 | |
| 1388 | Firewalls and routes that were configured during cluster creation |
| 1389 | are also deleted. |
| 1390 | |
| 1391 | 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] | 1392 | 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] | 1393 | when the cluster was initially created. |
| 1394 | |
| 1395 | Args: |
| 1396 | 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] | 1397 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| 1398 | clusterId: string, Required. Deprecated. The name of the cluster to delete. |
| 1399 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1400 | 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] | 1401 | number](https://support.google.com/cloud/answer/6158840). |
| 1402 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1403 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1404 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1405 | cluster resides. This field has been deprecated and replaced by the name |
| 1406 | field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1407 | x__xgafv: string, V1 error format. |
| 1408 | Allowed values |
| 1409 | 1 - v1 error format |
| 1410 | 2 - v2 error format |
| 1411 | |
| 1412 | Returns: |
| 1413 | An object of the form: |
| 1414 | |
| 1415 | { # This operation resource represents operations that may have happened or are |
| 1416 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1417 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1418 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1419 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1420 | "code": "A String", # Machine-friendly representation of the condition |
| 1421 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1422 | }, |
| 1423 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1424 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1425 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1426 | # or |
| 1427 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1428 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1429 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1430 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1431 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1432 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1433 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1434 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1435 | # (e.g., ERROR or DEGRADED). |
| 1436 | "code": "A String", # Machine-friendly representation of the condition |
| 1437 | "message": "A String", # Human-friendly representation of the condition |
| 1438 | }, |
| 1439 | ], |
| 1440 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1441 | "stages": [ # Substages of an operation or a stage. |
| 1442 | # Object with schema name: OperationProgress |
| 1443 | ], |
| 1444 | "status": "A String", # Status of an operation stage. |
| 1445 | # Unset for single-stage operations. |
| 1446 | "metrics": [ # Progress metric bundle, for example: |
| 1447 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1448 | # {name: "nodes total", int_value: 32}] |
| 1449 | # or |
| 1450 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1451 | # {name: "progress scale", double_value: 1.0}] |
| 1452 | { # Progress metric is (string, int|float|string) pair. |
| 1453 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1454 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1455 | "intValue": "A String", # For metrics with integer value. |
| 1456 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1457 | }, |
| 1458 | ], |
| 1459 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1460 | # Unset for single-stage operations. |
| 1461 | }, |
| 1462 | "zone": "A String", # The name of the Google Compute Engine |
| 1463 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1464 | # operation is taking place. This field is deprecated, use location instead. |
| 1465 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1466 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1467 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1468 | "detail": "A String", # Detailed operation progress, if available. |
| 1469 | "operationType": "A String", # The operation type. |
| 1470 | "status": "A String", # The current status of the operation. |
| 1471 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1472 | }</pre> |
| 1473 | </div> |
| 1474 | |
| 1475 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1476 | <code class="details" id="get">get(name, projectId=None, zone=None, clusterId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1477 | <pre>Gets the details for a specific cluster. |
| 1478 | |
| 1479 | Args: |
| 1480 | 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] | 1481 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1482 | 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] | 1483 | number](https://support.google.com/cloud/answer/6158840). |
| 1484 | This field has been deprecated and replaced by the name field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1485 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1486 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1487 | cluster resides. This field has been deprecated and replaced by the name |
| 1488 | field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1489 | clusterId: string, Required. Deprecated. The name of the cluster to retrieve. |
| 1490 | This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1491 | x__xgafv: string, V1 error format. |
| 1492 | Allowed values |
| 1493 | 1 - v1 error format |
| 1494 | 2 - v2 error format |
| 1495 | |
| 1496 | Returns: |
| 1497 | An object of the form: |
| 1498 | |
| 1499 | { # A Google Kubernetes Engine cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1500 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 1501 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 1502 | # if cluster created with IP Alias support. |
| 1503 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1504 | }, |
| 1505 | "network": "A String", # The name of the Google Compute Engine |
| 1506 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1507 | # to which the cluster is connected. If left unspecified, the `default` |
| 1508 | # network will be used. On output this shows the network ID instead of the |
| 1509 | # name. |
| 1510 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 1511 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1512 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 1513 | # range. This field will only be set when cluster is in route-based network |
| 1514 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1515 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 1516 | # master authorized networks will disallow all external traffic to access |
| 1517 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 1518 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 1519 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 1520 | # Kubernetes master through HTTPS. |
| 1521 | { # CidrBlock contains an optional name and one CIDR block. |
| 1522 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 1523 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 1524 | }, |
| 1525 | ], |
| 1526 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 1527 | }, |
| 1528 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1529 | # cluster, if available. |
| 1530 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 1531 | # If unspecified, the defaults are used: |
| 1532 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 1533 | # be set to "admin", a random password will be generated, and a client |
| 1534 | # certificate will be issued. |
| 1535 | # Authentication can be done using HTTP basic auth or using client |
| 1536 | # certificates. |
| 1537 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 1538 | # Because the master endpoint is open to the Internet, you should create a |
| 1539 | # strong password. If a password is provided for cluster creation, username |
| 1540 | # must be non-empty. |
| 1541 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 1542 | # clusters before v1.12, if no configuration is specified, a client |
| 1543 | # certificate is issued. |
| 1544 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 1545 | }, |
| 1546 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 1547 | # to the cluster endpoint. |
| 1548 | "clusterCaCertificate": "A String", |
| 1549 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 1550 | # authenticate to the cluster endpoint. |
| 1551 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 1552 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 1553 | # leaving username unspecified (or setting it to the empty string). |
| 1554 | }, |
| 1555 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 1556 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 1557 | # during authentication using a group of security groups. |
| 1558 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 1559 | # if enabled = true. |
| 1560 | }, |
| 1561 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 1562 | # This prefix will be used for assigning private IP addresses to the |
| 1563 | # master or set of masters, as well as the ILB VIP. |
| 1564 | # This field is deprecated, use |
| 1565 | # private_cluster_config.master_ipv4_cidr_block instead. |
| 1566 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 1567 | "type": "A String", # Type of the integration. |
| 1568 | }, |
| 1569 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 1570 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 1571 | # cluster, enabling additional functionality. |
| 1572 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 1573 | # is enabled or not on the Master, it does not track whether network policy |
| 1574 | # is enabled for the nodes. |
| 1575 | # is enabled or not on the Master, it does not track whether network policy |
| 1576 | # is enabled for the nodes. |
| 1577 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 1578 | }, |
| 1579 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 1580 | # extension to manage hosted GCP services through the Kubernetes API |
| 1581 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 1582 | }, |
| 1583 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 1584 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 1585 | # at cluster creation time. |
| 1586 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 1587 | }, |
| 1588 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 1589 | # increases or decreases the number of replica pods a replication controller |
| 1590 | # has based on the resource usage of the existing pods. |
| 1591 | # increases or decreases the number of replica pods a replication controller |
| 1592 | # has based on the resource usage of the existing pods. |
| 1593 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 1594 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 1595 | # Monitoring. |
| 1596 | }, |
| 1597 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 1598 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 1599 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 1600 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 1601 | # When enabled, it runs a small pod in the cluster that manages the load |
| 1602 | # balancers. |
| 1603 | }, |
| 1604 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 1605 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 1606 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 1607 | # workloads and applications. For more information, see: |
| 1608 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 1609 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 1610 | }, |
| 1611 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 1612 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 1613 | }, |
| 1614 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 1615 | # applications. |
| 1616 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 1617 | }, |
| 1618 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 1619 | # enabled at cluster creation time. |
| 1620 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 1621 | }, |
| 1622 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 1623 | # microservices. |
| 1624 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 1625 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 1626 | }, |
| 1627 | }, |
| 1628 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 1629 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 1630 | # must be valid under a PodSecurityPolicy to be created. |
| 1631 | }, |
| 1632 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 1633 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 1634 | # instead. The current version of the node software components. |
| 1635 | # If they are currently at multiple versions because they're in the process |
| 1636 | # of being upgraded, this reflects the minimum version of all nodes. |
| 1637 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 1638 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 1639 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 1640 | # the name. |
| 1641 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 1642 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 1643 | # the policy won't accidentally undo intermediate changes (and so that users |
| 1644 | # of the API unaware of some fields won't accidentally remove other fields). |
| 1645 | # Make a <code>get()</code> request to the cluster to get the current |
| 1646 | # resource version and include it with requests to set the policy. |
| 1647 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 1648 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 1649 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 1650 | # smallest possible in the given scenario. |
| 1651 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 1652 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 1653 | }, |
| 1654 | "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] | 1655 | # maintenance to occur. The time windows may be overlapping. If no |
| 1656 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1657 | "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] | 1658 | # this window reccurs. They go on for the span of time between the start and |
| 1659 | # end time. |
| 1660 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1661 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1662 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 1663 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 1664 | # <code>FREQ=DAILY</code> |
| 1665 | # For the first weekend of every month: |
| 1666 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 1667 | # 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] | 1668 | # 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] | 1669 | # <code> |
| 1670 | # start time = 2019-01-01T09:00:00-0400 |
| 1671 | # end time = 2019-01-01T17:00:00-0400 |
| 1672 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 1673 | # </code> |
| 1674 | # Windows can span multiple days. Eg, to make the window encompass every |
| 1675 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 1676 | # <code> |
| 1677 | # start time = 2019-01-05T00:00:00Z |
| 1678 | # end time = 2019-01-07T23:59:00Z |
| 1679 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 1680 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1681 | # 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] | 1682 | # to specify duration of the window and when it first starts. |
| 1683 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1684 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 1685 | "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] | 1686 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1687 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1688 | }, |
| 1689 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1690 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1691 | # occur in these windows. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1692 | "a_key": { # Represents an arbitrary window of time. |
| 1693 | "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] | 1694 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1695 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1696 | }, |
| 1697 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1698 | }, |
| 1699 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1700 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 1701 | # Google Compute Engine resources. |
| 1702 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1703 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1704 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 1705 | # found in validMasterVersions returned by getServerConfig. The version can |
| 1706 | # be upgraded over time; such upgrades are reflected in |
| 1707 | # currentMasterVersion and currentNodeVersion. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1708 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1709 | # Users may specify either explicit versions offered by |
| 1710 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1711 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1712 | # - "latest": picks the highest valid Kubernetes version |
| 1713 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 1714 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 1715 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 1716 | # - "","-": picks the default Kubernetes version |
| 1717 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| 1718 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 1719 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 1720 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 1721 | # then the server picks the default IP allocation mode |
| 1722 | "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] | 1723 | # will be automatically chosen with the default size. |
| 1724 | # |
| 1725 | # This field is only applicable when `use_ip_aliases` is true. |
| 1726 | # |
| 1727 | # Set to blank to have a range chosen with the default size. |
| 1728 | # |
| 1729 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1730 | # netmask. |
| 1731 | # |
| 1732 | # Set to a |
| 1733 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1734 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1735 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1736 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1737 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 1738 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 1739 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 1740 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 1741 | # range. |
| 1742 | # |
| 1743 | # If this field is set to true, then cluster and services CIDRs must be |
| 1744 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 1745 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 1746 | # `services_ipv4_cidr_block` must be fully-specified. |
| 1747 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 1748 | # fully-specified. |
| 1749 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 1750 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 1751 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1752 | # |
| 1753 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1754 | # |
| 1755 | # Set to blank to have a range chosen with the default size. |
| 1756 | # |
| 1757 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1758 | # netmask. |
| 1759 | # |
| 1760 | # Set to a |
| 1761 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1762 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1763 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1764 | # to use. |
| 1765 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 1766 | # block. The secondary range will be used for pod IP |
| 1767 | # addresses. This must be an existing secondary range associated |
| 1768 | # with the cluster subnetwork. |
| 1769 | # |
| 1770 | # This field is only applicable with use_ip_aliases and |
| 1771 | # create_subnetwork is false. |
| 1772 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1773 | # |
| 1774 | # This is applicable only if `create_subnetwork` is true. |
| 1775 | # |
| 1776 | # Set to blank to have a range chosen with the default size. |
| 1777 | # |
| 1778 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1779 | # netmask. |
| 1780 | # |
| 1781 | # Set to a |
| 1782 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1783 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1784 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1785 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1786 | "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] | 1787 | # range will be automatically chosen with the default size. |
| 1788 | # |
| 1789 | # This field is only applicable when `use_ip_aliases` is true. |
| 1790 | # |
| 1791 | # If unspecified, the range will use the default size. |
| 1792 | # |
| 1793 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1794 | # netmask. |
| 1795 | # |
| 1796 | # Set to a |
| 1797 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1798 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1799 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1800 | # to use. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1801 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1802 | "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] | 1803 | # CIDR block. The secondary range will be used for service |
| 1804 | # ClusterIPs. This must be an existing secondary range associated |
| 1805 | # with the cluster subnetwork. |
| 1806 | # |
| 1807 | # This field is only applicable with use_ip_aliases and |
| 1808 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1809 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 1810 | # This is used in conjunction with use_routes. It cannot |
| 1811 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 1812 | # false, then the server picks the default IP allocation mode |
| 1813 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 1814 | # |
| 1815 | # This field is only applicable when `use_ip_aliases` is true. |
| 1816 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 1817 | # this field is empty, then an automatic name will be chosen for the new |
| 1818 | # subnetwork. |
| 1819 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 1820 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1821 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1822 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 1823 | # mode. |
| 1824 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 1825 | # identities in the system, including service accounts, nodes, and |
| 1826 | # controllers, will have statically granted permissions beyond those |
| 1827 | # provided by the RBAC configuration or IAM. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1828 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 1832 | # disabled when this config unspecified. |
| 1833 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 1834 | # daemonset will be created in the cluster to meter network egress traffic. |
| 1835 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 1836 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 1837 | # second BigQuery table will be created to hold resource consumption |
| 1838 | # records. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1839 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1840 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 1841 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1842 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1843 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1844 | "locations": [ # The list of Google Compute Engine |
| 1845 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1846 | # cluster's nodes should be located. |
| 1847 | "A String", |
| 1848 | ], |
| 1849 | "nodePools": [ # The node pools associated with this cluster. |
| 1850 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1851 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1852 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 1853 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1854 | # specification, under the control of the cluster master. They may have a set |
| 1855 | # of Kubernetes labels applied to them, which may be used to reference them |
| 1856 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 1857 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1858 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1859 | # node pool instance, if available. |
| 1860 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1861 | # only if a valid configuration is present. |
| 1862 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1863 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1864 | # max_node_count. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1865 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 1866 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 1867 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1868 | # has to enough quota to scale up the cluster. |
| 1869 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1870 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 1871 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 1872 | # is sufficient for this number of instances. You must also have available |
| 1873 | # firewall and routes quota. |
| 1874 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1875 | # disruption caused by an upgrade. |
| 1876 | # |
| 1877 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1878 | # unavailable. |
| 1879 | # |
| 1880 | # maxSurge controls the number of additional nodes that can be added to the |
| 1881 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1882 | # available nodes. |
| 1883 | # |
| 1884 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1885 | # nodes are being upgraded at the same time). |
| 1886 | # |
| 1887 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1888 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1889 | # this holds true. (Disruption stays within the limits of |
| 1890 | # PodDisruptionBudget, if it is configured.) |
| 1891 | # |
| 1892 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1893 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1894 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1895 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1896 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1897 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1898 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1899 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1900 | # the upgrade process. A node is considered available if its status is |
| 1901 | # Ready. |
| 1902 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1903 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1904 | "locations": [ # The list of Google Compute Engine |
| 1905 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1906 | # NodePool's nodes should be located. |
| 1907 | "A String", |
| 1908 | ], |
| 1909 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1910 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 1911 | # associated with this node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1912 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1913 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1914 | "version": "A String", # The version of the Kubernetes of this node. |
| 1915 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 1916 | "conditions": [ # Which conditions caused the current node pool state. |
| 1917 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1918 | # (e.g., ERROR or DEGRADED). |
| 1919 | "code": "A String", # Machine-friendly representation of the condition |
| 1920 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1921 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1922 | ], |
| 1923 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 1924 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 1925 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1926 | # The smallest allowed disk size is 10GB. |
| 1927 | # |
| 1928 | # If unspecified, the default disk size is 100GB. |
| 1929 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1930 | # workloads on the node pool. |
| 1931 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 1932 | # workloads running on the node. |
| 1933 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1934 | # on the node pool. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1935 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1936 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1937 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1938 | # support for GPUs. |
| 1939 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 1940 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 1941 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1942 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 1943 | }, |
| 1944 | ], |
| 1945 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1946 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1947 | # `n1-standard-1`). |
| 1948 | # |
| 1949 | # If unspecified, the default machine type is |
| 1950 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1951 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1952 | # |
| 1953 | # If unspecified, the default disk type is 'pd-standard' |
| 1954 | "bootDiskKmsKey": "A String", # |
| 1955 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 1956 | # to each node in the node pool. This should be of the form |
| 1957 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 1958 | # For more information about protecting resources with Cloud KMS Keys please |
| 1959 | # see: |
| 1960 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 1961 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 1962 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1963 | # |
| 1964 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1965 | # verifying the digital signature of all boot components, and halting the |
| 1966 | # boot process if signature verification fails. |
| 1967 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1968 | # |
| 1969 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1970 | # The attestation is performed against the integrity policy baseline. This |
| 1971 | # baseline is initially derived from the implicitly trusted boot image when |
| 1972 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1973 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1974 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1975 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1976 | # friendly names of CPU platforms, such as |
| 1977 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1978 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1979 | # information, read [how to specify min CPU |
| 1980 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1981 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1982 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1983 | # inforamtion about preemptible VM instances. |
| 1984 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1985 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1986 | # The limit for this value is dependent upon the maximum number of |
| 1987 | # disks available on a machine per zone. See: |
| 1988 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 1989 | # for more information. |
| 1990 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1991 | "type": "A String", # Type of the sandbox to use for the node. |
| 1992 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 1993 | }, |
| 1994 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1995 | # |
| 1996 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1997 | # in length. These are reflected as part of a URL in the metadata server. |
| 1998 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1999 | # metadata keys for the project or be one of the reserved keys: |
| 2000 | # "cluster-location" |
| 2001 | # "cluster-name" |
| 2002 | # "cluster-uid" |
| 2003 | # "configure-sh" |
| 2004 | # "containerd-configure-sh" |
| 2005 | # "enable-oslogin" |
| 2006 | # "gci-ensure-gke-docker" |
| 2007 | # "gci-metrics-enabled" |
| 2008 | # "gci-update-strategy" |
| 2009 | # "instance-template" |
| 2010 | # "kube-env" |
| 2011 | # "startup-script" |
| 2012 | # "user-data" |
| 2013 | # "disable-address-manager" |
| 2014 | # "windows-startup-script-ps1" |
| 2015 | # "common-psm1" |
| 2016 | # "k8s-node-setup-psm1" |
| 2017 | # "install-ssh-psm1" |
| 2018 | # "user-profile-psm1" |
| 2019 | # "serial-port-logging-enable" |
| 2020 | # Values are free-form strings, and only have meaning as interpreted by |
| 2021 | # the image running in the instance. The only restriction placed on them is |
| 2022 | # that each value's size must be less than or equal to 32 KB. |
| 2023 | # |
| 2024 | # The total size of all keys and values must be less than 512 KB. |
| 2025 | "a_key": "A String", |
| 2026 | }, |
| 2027 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2028 | # the specified [Zonal Compute |
| 2029 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2030 | # to this node pool. |
| 2031 | # is the configuration of desired reservation which instances could take |
| 2032 | # capacity from. |
| 2033 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2034 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2035 | # the key and specify the name of your reservation as its value. |
| 2036 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2037 | "A String", |
| 2038 | ], |
| 2039 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 2040 | }, |
| 2041 | "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] | 2042 | # valid sources or targets for network firewalls and are specified by |
| 2043 | # the client during cluster or node pool creation. Each tag within the list |
| 2044 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2045 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2046 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2047 | "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] | 2048 | # 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] | 2049 | # Account is specified, the "default" service account is used. |
| 2050 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2051 | # the latest version of it will be used. |
| 2052 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2053 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2054 | # |
| 2055 | # The following scopes are recommended, but not required, and by default are |
| 2056 | # not included: |
| 2057 | # |
| 2058 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2059 | # persistent storage on your nodes. |
| 2060 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2061 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2062 | # (the [Google Container |
| 2063 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2064 | # |
| 2065 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2066 | # 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] | 2067 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2068 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2069 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2070 | # |
| 2071 | # For more information, including usage and the valid values, see: |
| 2072 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2073 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2074 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2075 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2076 | # See |
| 2077 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2078 | # for more information, including usage and the valid values. |
| 2079 | "key": "A String", # Key for taint. |
| 2080 | "value": "A String", # Value for taint. |
| 2081 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2082 | }, |
| 2083 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2084 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2085 | # These will added in addition to any default label(s) that |
| 2086 | # Kubernetes may apply to the node. |
| 2087 | # In case of conflict in label keys, the applied set may differ depending on |
| 2088 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2089 | # and conflicts should be avoided. |
| 2090 | # For more information, including usage and the valid values, see: |
| 2091 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2092 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2093 | }, |
| 2094 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2095 | "name": "A String", # The name of the node pool. |
| 2096 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 2097 | # simultaneously on a node in the node pool. |
| 2098 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2099 | }, |
| 2100 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 2101 | # node pool. |
| 2102 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 2103 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 2104 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2105 | # the Auto Upgrades will proceed. |
| 2106 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2107 | # with the description of the upgrade. |
| 2108 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2109 | # with the approximate start time for the upgrades, in |
| 2110 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2111 | }, |
| 2112 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2113 | }, |
| 2114 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2115 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2116 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 2117 | # this cluster, in |
| 2118 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2119 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 2120 | # typically put in the last `/16` from the container CIDR. |
| 2121 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 2122 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 2123 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 2124 | "provider": "A String", # The selected network policy provider. |
| 2125 | }, |
| 2126 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 2127 | # subscribed to. Release channels are arranged in order of risk and |
| 2128 | # frequency of updates. |
| 2129 | # |
| 2130 | # When a cluster is subscribed to a release channel, Google maintains |
| 2131 | # both the master version and the node version. Node auto-upgrade |
| 2132 | # defaults to true and cannot be disabled. Updates to version related |
| 2133 | # fields (e.g. current_master_version) return an error. |
| 2134 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 2135 | }, |
| 2136 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 2137 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 2138 | # the kubernetes version of the master and nodes. |
| 2139 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 2140 | # Alpha enabled clusters are automatically deleted thirty days after |
| 2141 | # creation. |
| 2142 | "description": "A String", # An optional description of this cluster. |
| 2143 | "conditions": [ # Which conditions caused the current cluster state. |
| 2144 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2145 | # (e.g., ERROR or DEGRADED). |
| 2146 | "code": "A String", # Machine-friendly representation of the condition |
| 2147 | "message": "A String", # Human-friendly representation of the condition |
| 2148 | }, |
| 2149 | ], |
| 2150 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 2151 | # default have no external IP addresses on the nodes and where nodes and the |
| 2152 | # master communicate over private IP addresses. |
| 2153 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 2154 | # instead. |
| 2155 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 2156 | # Call Kubernetes API directly to retrieve node information. |
| 2157 | "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] | 2158 | # Currently available options: |
| 2159 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2160 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2161 | # service with a Kubernetes-native resource model |
| 2162 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 2163 | # longer available as of GKE 1.15). |
| 2164 | # * `none` - No metrics will be exported from the cluster. |
| 2165 | # |
| 2166 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 2167 | # 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] | 2168 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 2169 | "state": "A String", # Denotes the state of etcd encryption. |
| 2170 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2171 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2172 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2173 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 2174 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 2175 | # images will be validated by Google Binauthz. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2176 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2177 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 2178 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2179 | # notation (e.g. `1.2.3.4/29`). |
| 2180 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 2181 | # policies. |
| 2182 | # policies. |
| 2183 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 2184 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 2185 | }, |
| 2186 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2187 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2188 | # cluster resides. This field is deprecated, use location instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2189 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 2190 | # Currently available options: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2191 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2192 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 2193 | # service with a Kubernetes-native resource model |
| 2194 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 2195 | # available as of GKE 1.15). |
| 2196 | # * `none` - no logs will be exported from the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2197 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2198 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 2199 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 2200 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 2201 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2202 | "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] | 2203 | # 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] | 2204 | # "node_pool" object, since this configuration (along with the |
| 2205 | # "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] | 2206 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2207 | # For responses, this field will be populated with the node configuration of |
| 2208 | # the first node pool. (For configuration of each node pool, see |
| 2209 | # `node_pool.config`) |
| 2210 | # |
| 2211 | # If unspecified, the defaults are used. |
| 2212 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2213 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2214 | # The smallest allowed disk size is 10GB. |
| 2215 | # |
| 2216 | # If unspecified, the default disk size is 100GB. |
| 2217 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2218 | # workloads on the node pool. |
| 2219 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 2220 | # workloads running on the node. |
| 2221 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2222 | # on the node pool. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2223 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2224 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2225 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2226 | # support for GPUs. |
| 2227 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 2228 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 2229 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2230 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 2231 | }, |
| 2232 | ], |
| 2233 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2234 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2235 | # `n1-standard-1`). |
| 2236 | # |
| 2237 | # If unspecified, the default machine type is |
| 2238 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2239 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2240 | # |
| 2241 | # If unspecified, the default disk type is 'pd-standard' |
| 2242 | "bootDiskKmsKey": "A String", # |
| 2243 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 2244 | # to each node in the node pool. This should be of the form |
| 2245 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 2246 | # For more information about protecting resources with Cloud KMS Keys please |
| 2247 | # see: |
| 2248 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 2249 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 2250 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2251 | # |
| 2252 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2253 | # verifying the digital signature of all boot components, and halting the |
| 2254 | # boot process if signature verification fails. |
| 2255 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2256 | # |
| 2257 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2258 | # The attestation is performed against the integrity policy baseline. This |
| 2259 | # baseline is initially derived from the implicitly trusted boot image when |
| 2260 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2261 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2262 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2263 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2264 | # friendly names of CPU platforms, such as |
| 2265 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2266 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2267 | # information, read [how to specify min CPU |
| 2268 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2269 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2270 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2271 | # inforamtion about preemptible VM instances. |
| 2272 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2273 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2274 | # The limit for this value is dependent upon the maximum number of |
| 2275 | # disks available on a machine per zone. See: |
| 2276 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 2277 | # for more information. |
| 2278 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2279 | "type": "A String", # Type of the sandbox to use for the node. |
| 2280 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 2281 | }, |
| 2282 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 2283 | # |
| 2284 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2285 | # in length. These are reflected as part of a URL in the metadata server. |
| 2286 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2287 | # metadata keys for the project or be one of the reserved keys: |
| 2288 | # "cluster-location" |
| 2289 | # "cluster-name" |
| 2290 | # "cluster-uid" |
| 2291 | # "configure-sh" |
| 2292 | # "containerd-configure-sh" |
| 2293 | # "enable-oslogin" |
| 2294 | # "gci-ensure-gke-docker" |
| 2295 | # "gci-metrics-enabled" |
| 2296 | # "gci-update-strategy" |
| 2297 | # "instance-template" |
| 2298 | # "kube-env" |
| 2299 | # "startup-script" |
| 2300 | # "user-data" |
| 2301 | # "disable-address-manager" |
| 2302 | # "windows-startup-script-ps1" |
| 2303 | # "common-psm1" |
| 2304 | # "k8s-node-setup-psm1" |
| 2305 | # "install-ssh-psm1" |
| 2306 | # "user-profile-psm1" |
| 2307 | # "serial-port-logging-enable" |
| 2308 | # Values are free-form strings, and only have meaning as interpreted by |
| 2309 | # the image running in the instance. The only restriction placed on them is |
| 2310 | # that each value's size must be less than or equal to 32 KB. |
| 2311 | # |
| 2312 | # The total size of all keys and values must be less than 512 KB. |
| 2313 | "a_key": "A String", |
| 2314 | }, |
| 2315 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2316 | # the specified [Zonal Compute |
| 2317 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2318 | # to this node pool. |
| 2319 | # is the configuration of desired reservation which instances could take |
| 2320 | # capacity from. |
| 2321 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2322 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2323 | # the key and specify the name of your reservation as its value. |
| 2324 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2325 | "A String", |
| 2326 | ], |
| 2327 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 2328 | }, |
| 2329 | "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] | 2330 | # valid sources or targets for network firewalls and are specified by |
| 2331 | # the client during cluster or node pool creation. Each tag within the list |
| 2332 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2333 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2334 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2335 | "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] | 2336 | # 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] | 2337 | # Account is specified, the "default" service account is used. |
| 2338 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2339 | # the latest version of it will be used. |
| 2340 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2341 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2342 | # |
| 2343 | # The following scopes are recommended, but not required, and by default are |
| 2344 | # not included: |
| 2345 | # |
| 2346 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2347 | # persistent storage on your nodes. |
| 2348 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2349 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2350 | # (the [Google Container |
| 2351 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2352 | # |
| 2353 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2354 | # 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] | 2355 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2356 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2357 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2358 | # |
| 2359 | # For more information, including usage and the valid values, see: |
| 2360 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2361 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2362 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2363 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2364 | # See |
| 2365 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2366 | # for more information, including usage and the valid values. |
| 2367 | "key": "A String", # Key for taint. |
| 2368 | "value": "A String", # Value for taint. |
| 2369 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2370 | }, |
| 2371 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2372 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2373 | # These will added in addition to any default label(s) that |
| 2374 | # Kubernetes may apply to the node. |
| 2375 | # In case of conflict in label keys, the applied set may differ depending on |
| 2376 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2377 | # and conflicts should be avoided. |
| 2378 | # For more information, including usage and the valid values, see: |
| 2379 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2380 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2381 | }, |
| 2382 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2383 | "status": "A String", # [Output only] The current status of this cluster. |
| 2384 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 2385 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 2386 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 2387 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 2388 | }, |
| 2389 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 2390 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 2391 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 2392 | # cluster is connected. Example: |
| 2393 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 2394 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 2395 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2396 | # to which the cluster is connected. Example: |
| 2397 | # projects/my-project/global/networks/my-network |
| 2398 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 2399 | # This makes same node pod to pod traffic visible for VPC network. |
| 2400 | }, |
| 2401 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 2402 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 2403 | # the following restrictions: |
| 2404 | # |
| 2405 | # * Lowercase letters, numbers, and hyphens only. |
| 2406 | # * Must start with a letter. |
| 2407 | # * Must end with a number or a letter. |
| 2408 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 2409 | # The endpoint can be accessed from the internet at |
| 2410 | # `https://username:password@endpoint/`. |
| 2411 | # |
| 2412 | # See the `masterAuth` property of this resource for username and |
| 2413 | # password information. |
| 2414 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 2415 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2416 | # or |
| 2417 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2418 | # in which the cluster resides. |
| 2419 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 2420 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2421 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2422 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2423 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 2424 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2425 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 2426 | # required by Cluster Autoscaler to automatically adjust |
| 2427 | # the size of the cluster and create/delete |
| 2428 | # node pools based on the current needs. |
| 2429 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 2430 | # amount of resources in the cluster. |
| 2431 | { # Contains information about amount of some resource in the cluster. |
| 2432 | # For memory, value should be in GB. |
| 2433 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 2434 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 2435 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 2436 | }, |
| 2437 | ], |
| 2438 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 2439 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 2440 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 2441 | # created by NAP. |
| 2442 | # by NAP. |
| 2443 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 2444 | # specified, service_account should be empty. |
| 2445 | "A String", |
| 2446 | ], |
| 2447 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 2448 | # node pool. |
| 2449 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 2450 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 2451 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2452 | # the Auto Upgrades will proceed. |
| 2453 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2454 | # with the description of the upgrade. |
| 2455 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2456 | # with the approximate start time for the upgrades, in |
| 2457 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2458 | }, |
| 2459 | }, |
| 2460 | "minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. |
| 2461 | # The instance may be scheduled on the specified or newer CPU platform. |
| 2462 | # Applicable values are the friendly names of CPU platforms, such as |
| 2463 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2464 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2465 | # information, read [how to specify min CPU |
| 2466 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2467 | # To unset the min cpu platform field pass "automatic" as field value. |
| 2468 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 2469 | # disruption caused by an upgrade. |
| 2470 | # |
| 2471 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2472 | # unavailable. |
| 2473 | # |
| 2474 | # maxSurge controls the number of additional nodes that can be added to the |
| 2475 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2476 | # available nodes. |
| 2477 | # |
| 2478 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2479 | # nodes are being upgraded at the same time). |
| 2480 | # |
| 2481 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2482 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2483 | # this holds true. (Disruption stays within the limits of |
| 2484 | # PodDisruptionBudget, if it is configured.) |
| 2485 | # |
| 2486 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2487 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2488 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2489 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2490 | # there are always at least 4 nodes available. |
| 2491 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2492 | # of the node pool during the upgrade process. |
| 2493 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 2494 | # the upgrade process. A node is considered available if its status is |
| 2495 | # Ready. |
| 2496 | }, |
| 2497 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 2498 | # service_account is specified, scopes should be empty. |
| 2499 | }, |
| 2500 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 2501 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2502 | # NodePool's nodes can be created by NAP. |
| 2503 | "A String", |
| 2504 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2505 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2506 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 2507 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2508 | # is sufficient for this number of instances. You must also have available |
| 2509 | # firewall and routes quota. |
| 2510 | # 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] | 2511 | # "node_pool" object, since this configuration (along with the |
| 2512 | # "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] | 2513 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2514 | # |
| 2515 | # This field is deprecated, use node_pool.initial_node_count instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2516 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 2517 | "A String", |
| 2518 | ], |
| 2519 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 2520 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 2521 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 2522 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 2523 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 2524 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 2525 | }, |
| 2526 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 2527 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 2528 | # given only RFC 1918 private addresses and communicate with the master via |
| 2529 | # private networking. |
| 2530 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 2531 | # range will be used for assigning internal IP addresses to the master or |
| 2532 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 2533 | # any other ranges in use within the cluster's network. |
| 2534 | }, |
| 2535 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 2536 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 2537 | }, |
| 2538 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 2539 | # required by Vertical Pod Autoscaler to automatically adjust |
| 2540 | # the resources of pods controlled by it. |
| 2541 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 2542 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2543 | }</pre> |
| 2544 | </div> |
| 2545 | |
| 2546 | <div class="method"> |
| 2547 | <code class="details" id="getJwks">getJwks(parent, x__xgafv=None)</code> |
| 2548 | <pre>Gets the public component of the cluster signing keys in |
| 2549 | JSON Web Key format. |
| 2550 | This API is not yet intended for general use, and is not available for all |
| 2551 | clusters. |
| 2552 | |
| 2553 | Args: |
| 2554 | parent: string, The cluster (project, location, cluster id) to get keys for. Specified in |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2555 | the format `projects/*/locations/*/clusters/*`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2556 | x__xgafv: string, V1 error format. |
| 2557 | Allowed values |
| 2558 | 1 - v1 error format |
| 2559 | 2 - v2 error format |
| 2560 | |
| 2561 | Returns: |
| 2562 | An object of the form: |
| 2563 | |
| 2564 | { # GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2565 | "keys": [ # The public component of the keys used by the cluster to sign token |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2566 | # requests. |
| 2567 | { # Jwk is a JSON Web Key as specified in RFC 7517 |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2568 | "x": "A String", # Used for ECDSA keys. |
| 2569 | "crv": "A String", # Used for ECDSA keys. |
| 2570 | "kid": "A String", # Key ID. |
| 2571 | "e": "A String", # Used for RSA keys. |
| 2572 | "kty": "A String", # Key Type. |
| 2573 | "n": "A String", # Used for RSA keys. |
| 2574 | "alg": "A String", # Algorithm. |
| 2575 | "use": "A String", # Permitted uses for the public keys. |
| 2576 | "y": "A String", # Used for ECDSA keys. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2577 | }, |
| 2578 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2579 | "cacheHeader": { # RFC-2616: cache control support # OnePlatform automatically extracts this field and uses it to set the HTTP |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2580 | # Cache-Control header. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2581 | "directive": "A String", # 14.9 request and response directives |
| 2582 | "age": "A String", # 14.6 response cache age, in seconds since the response is generated |
| 2583 | "expires": "A String", # 14.21 response cache expires, in RFC 1123 date format |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2584 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2585 | }</pre> |
| 2586 | </div> |
| 2587 | |
| 2588 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2589 | <code class="details" id="list">list(parent, projectId=None, zone=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2590 | <pre>Lists all clusters owned by a project in either the specified zone or all |
| 2591 | zones. |
| 2592 | |
| 2593 | Args: |
| 2594 | parent: string, The parent (project and location) where the clusters will be listed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2595 | Specified in the format `projects/*/locations/*`. |
| 2596 | Location "-" matches all zones and all regions. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2597 | 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] | 2598 | number](https://support.google.com/cloud/answer/6158840). |
| 2599 | This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2600 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 2601 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2602 | cluster resides, or "-" for all zones. This field has been deprecated and |
| 2603 | replaced by the parent field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2604 | x__xgafv: string, V1 error format. |
| 2605 | Allowed values |
| 2606 | 1 - v1 error format |
| 2607 | 2 - v2 error format |
| 2608 | |
| 2609 | Returns: |
| 2610 | An object of the form: |
| 2611 | |
| 2612 | { # ListClustersResponse is the result of ListClustersRequest. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2613 | "clusters": [ # A list of clusters in the project in the specified zone, or |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2614 | # across all ones. |
| 2615 | { # A Google Kubernetes Engine cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2616 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 2617 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 2618 | # if cluster created with IP Alias support. |
| 2619 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2620 | }, |
| 2621 | "network": "A String", # The name of the Google Compute Engine |
| 2622 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2623 | # to which the cluster is connected. If left unspecified, the `default` |
| 2624 | # network will be used. On output this shows the network ID instead of the |
| 2625 | # name. |
| 2626 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 2627 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2628 | # containers. This is provisioned from within the `container_ipv4_cidr` |
| 2629 | # range. This field will only be set when cluster is in route-based network |
| 2630 | # mode. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2631 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 2632 | # master authorized networks will disallow all external traffic to access |
| 2633 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 2634 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 2635 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 2636 | # Kubernetes master through HTTPS. |
| 2637 | { # CidrBlock contains an optional name and one CIDR block. |
| 2638 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 2639 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 2640 | }, |
| 2641 | ], |
| 2642 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| 2643 | }, |
| 2644 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2645 | # cluster, if available. |
| 2646 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 2647 | # If unspecified, the defaults are used: |
| 2648 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 2649 | # be set to "admin", a random password will be generated, and a client |
| 2650 | # certificate will be issued. |
| 2651 | # Authentication can be done using HTTP basic auth or using client |
| 2652 | # certificates. |
| 2653 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 2654 | # Because the master endpoint is open to the Internet, you should create a |
| 2655 | # strong password. If a password is provided for cluster creation, username |
| 2656 | # must be non-empty. |
| 2657 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 2658 | # clusters before v1.12, if no configuration is specified, a client |
| 2659 | # certificate is issued. |
| 2660 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 2661 | }, |
| 2662 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 2663 | # to the cluster endpoint. |
| 2664 | "clusterCaCertificate": "A String", |
| 2665 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 2666 | # authenticate to the cluster endpoint. |
| 2667 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 2668 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 2669 | # leaving username unspecified (or setting it to the empty string). |
| 2670 | }, |
| 2671 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 2672 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 2673 | # during authentication using a group of security groups. |
| 2674 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 2675 | # if enabled = true. |
| 2676 | }, |
| 2677 | "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. |
| 2678 | # This prefix will be used for assigning private IP addresses to the |
| 2679 | # master or set of masters, as well as the ILB VIP. |
| 2680 | # This field is deprecated, use |
| 2681 | # private_cluster_config.master_ipv4_cidr_block instead. |
| 2682 | "clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster. |
| 2683 | "type": "A String", # Type of the integration. |
| 2684 | }, |
| 2685 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 2686 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 2687 | # cluster, enabling additional functionality. |
| 2688 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 2689 | # is enabled or not on the Master, it does not track whether network policy |
| 2690 | # is enabled for the nodes. |
| 2691 | # is enabled or not on the Master, it does not track whether network policy |
| 2692 | # is enabled for the nodes. |
| 2693 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 2694 | }, |
| 2695 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 2696 | # extension to manage hosted GCP services through the Kubernetes API |
| 2697 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 2698 | }, |
| 2699 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 2700 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 2701 | # at cluster creation time. |
| 2702 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 2703 | }, |
| 2704 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 2705 | # increases or decreases the number of replica pods a replication controller |
| 2706 | # has based on the resource usage of the existing pods. |
| 2707 | # increases or decreases the number of replica pods a replication controller |
| 2708 | # has based on the resource usage of the existing pods. |
| 2709 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 2710 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 2711 | # Monitoring. |
| 2712 | }, |
| 2713 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 2714 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 2715 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 2716 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 2717 | # When enabled, it runs a small pod in the cluster that manages the load |
| 2718 | # balancers. |
| 2719 | }, |
| 2720 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 2721 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 2722 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 2723 | # workloads and applications. For more information, see: |
| 2724 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 2725 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 2726 | }, |
| 2727 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 2728 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 2729 | }, |
| 2730 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 2731 | # applications. |
| 2732 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 2733 | }, |
| 2734 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 2735 | # enabled at cluster creation time. |
| 2736 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 2737 | }, |
| 2738 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 2739 | # microservices. |
| 2740 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 2741 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 2742 | }, |
| 2743 | }, |
| 2744 | "podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature. |
| 2745 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 2746 | # must be valid under a PodSecurityPolicy to be created. |
| 2747 | }, |
| 2748 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 2749 | # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) |
| 2750 | # instead. The current version of the node software components. |
| 2751 | # If they are currently at multiple versions because they're in the process |
| 2752 | # of being upgraded, this reflects the minimum version of all nodes. |
| 2753 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 2754 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 2755 | # the cluster is connected. On output this shows the subnetwork ID instead of |
| 2756 | # the name. |
| 2757 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 2758 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 2759 | # the policy won't accidentally undo intermediate changes (and so that users |
| 2760 | # of the API unaware of some fields won't accidentally remove other fields). |
| 2761 | # Make a <code>get()</code> request to the cluster to get the current |
| 2762 | # resource version and include it with requests to set the policy. |
| 2763 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 2764 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 2765 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 2766 | # smallest possible in the given scenario. |
| 2767 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 2768 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 2769 | }, |
| 2770 | "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] | 2771 | # maintenance to occur. The time windows may be overlapping. If no |
| 2772 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2773 | "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] | 2774 | # this window reccurs. They go on for the span of time between the start and |
| 2775 | # end time. |
| 2776 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2777 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2778 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 2779 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 2780 | # <code>FREQ=DAILY</code> |
| 2781 | # For the first weekend of every month: |
| 2782 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 2783 | # 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] | 2784 | # 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] | 2785 | # <code> |
| 2786 | # start time = 2019-01-01T09:00:00-0400 |
| 2787 | # end time = 2019-01-01T17:00:00-0400 |
| 2788 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 2789 | # </code> |
| 2790 | # Windows can span multiple days. Eg, to make the window encompass every |
| 2791 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 2792 | # <code> |
| 2793 | # start time = 2019-01-05T00:00:00Z |
| 2794 | # end time = 2019-01-07T23:59:00Z |
| 2795 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 2796 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2797 | # 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] | 2798 | # to specify duration of the window and when it first starts. |
| 2799 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2800 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 2801 | "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] | 2802 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2803 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2804 | }, |
| 2805 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2806 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2807 | # occur in these windows. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2808 | "a_key": { # Represents an arbitrary window of time. |
| 2809 | "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] | 2810 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2811 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2812 | }, |
| 2813 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2814 | }, |
| 2815 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2816 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 2817 | # Google Compute Engine resources. |
| 2818 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2819 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2820 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 2821 | # found in validMasterVersions returned by getServerConfig. The version can |
| 2822 | # be upgraded over time; such upgrades are reflected in |
| 2823 | # currentMasterVersion and currentNodeVersion. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2824 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2825 | # Users may specify either explicit versions offered by |
| 2826 | # Kubernetes Engine or version aliases, which have the following behavior: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2827 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2828 | # - "latest": picks the highest valid Kubernetes version |
| 2829 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 2830 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 2831 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 2832 | # - "","-": picks the default Kubernetes version |
| 2833 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
| 2834 | "useRoutes": True or False, # Whether routes will be used for pod IPs in the cluster. |
| 2835 | # This is used in conjunction with use_ip_aliases. It cannot be true if |
| 2836 | # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, |
| 2837 | # then the server picks the default IP allocation mode |
| 2838 | "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] | 2839 | # will be automatically chosen with the default size. |
| 2840 | # |
| 2841 | # This field is only applicable when `use_ip_aliases` is true. |
| 2842 | # |
| 2843 | # Set to blank to have a range chosen with the default size. |
| 2844 | # |
| 2845 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2846 | # netmask. |
| 2847 | # |
| 2848 | # Set to a |
| 2849 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2850 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2851 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2852 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2853 | "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain |
| 2854 | # kinds of network routes. By default we do not allow cluster CIDR ranges to |
| 2855 | # intersect with any user declared routes. With allow_route_overlap == true, |
| 2856 | # we allow overlapping with CIDR ranges that are larger than the cluster CIDR |
| 2857 | # range. |
| 2858 | # |
| 2859 | # If this field is set to true, then cluster and services CIDRs must be |
| 2860 | # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: |
| 2861 | # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and |
| 2862 | # `services_ipv4_cidr_block` must be fully-specified. |
| 2863 | # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be |
| 2864 | # fully-specified. |
| 2865 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
| 2866 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 2867 | # `cluster.cluster_ipv4_cidr` must be left blank. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2868 | # |
| 2869 | # This field is only applicable when `use_ip_aliases` is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2870 | # |
| 2871 | # Set to blank to have a range chosen with the default size. |
| 2872 | # |
| 2873 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2874 | # netmask. |
| 2875 | # |
| 2876 | # Set to a |
| 2877 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2878 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2879 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2880 | # to use. |
| 2881 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 2882 | # block. The secondary range will be used for pod IP |
| 2883 | # addresses. This must be an existing secondary range associated |
| 2884 | # with the cluster subnetwork. |
| 2885 | # |
| 2886 | # This field is only applicable with use_ip_aliases and |
| 2887 | # create_subnetwork is false. |
| 2888 | "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2889 | # |
| 2890 | # This is applicable only if `create_subnetwork` is true. |
| 2891 | # |
| 2892 | # Set to blank to have a range chosen with the default size. |
| 2893 | # |
| 2894 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2895 | # netmask. |
| 2896 | # |
| 2897 | # Set to a |
| 2898 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2899 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2900 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2901 | # to use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2902 | "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] | 2903 | # range will be automatically chosen with the default size. |
| 2904 | # |
| 2905 | # This field is only applicable when `use_ip_aliases` is true. |
| 2906 | # |
| 2907 | # If unspecified, the range will use the default size. |
| 2908 | # |
| 2909 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2910 | # netmask. |
| 2911 | # |
| 2912 | # Set to a |
| 2913 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2914 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2915 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2916 | # to use. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2917 | # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2918 | "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] | 2919 | # CIDR block. The secondary range will be used for service |
| 2920 | # ClusterIPs. This must be an existing secondary range associated |
| 2921 | # with the cluster subnetwork. |
| 2922 | # |
| 2923 | # This field is only applicable with use_ip_aliases and |
| 2924 | # create_subnetwork is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2925 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 2926 | # This is used in conjunction with use_routes. It cannot |
| 2927 | # be true if use_routes is true. If both use_ip_aliases and use_routes are |
| 2928 | # false, then the server picks the default IP allocation mode |
| 2929 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 2930 | # |
| 2931 | # This field is only applicable when `use_ip_aliases` is true. |
| 2932 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 2933 | # this field is empty, then an automatic name will be chosen for the new |
| 2934 | # subnetwork. |
| 2935 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 2936 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2937 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2938 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 2939 | # mode. |
| 2940 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 2941 | # identities in the system, including service accounts, nodes, and |
| 2942 | # controllers, will have statically granted permissions beyond those |
| 2943 | # provided by the RBAC configuration or IAM. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2944 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2945 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 2946 | # This field is deprecated, use tpu_config.enabled instead. |
| 2947 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
| 2948 | # disabled when this config unspecified. |
| 2949 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 2950 | # daemonset will be created in the cluster to meter network egress traffic. |
| 2951 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 2952 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 2953 | # second BigQuery table will be created to hold resource consumption |
| 2954 | # records. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2955 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2956 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 2957 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2958 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2959 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2960 | "locations": [ # The list of Google Compute Engine |
| 2961 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2962 | # cluster's nodes should be located. |
| 2963 | "A String", |
| 2964 | ], |
| 2965 | "nodePools": [ # The node pools associated with this cluster. |
| 2966 | # This field should not be set if "node_config" or "initial_node_count" are |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2967 | # specified. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2968 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 2969 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2970 | # specification, under the control of the cluster master. They may have a set |
| 2971 | # of Kubernetes labels applied to them, which may be used to reference them |
| 2972 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 2973 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2974 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2975 | # node pool instance, if available. |
| 2976 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2977 | # only if a valid configuration is present. |
| 2978 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2979 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2980 | # max_node_count. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2981 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 2982 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 2983 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2984 | # has to enough quota to scale up the cluster. |
| 2985 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2986 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 2987 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 2988 | # is sufficient for this number of instances. You must also have available |
| 2989 | # firewall and routes quota. |
| 2990 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2991 | # disruption caused by an upgrade. |
| 2992 | # |
| 2993 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2994 | # unavailable. |
| 2995 | # |
| 2996 | # maxSurge controls the number of additional nodes that can be added to the |
| 2997 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2998 | # available nodes. |
| 2999 | # |
| 3000 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 3001 | # nodes are being upgraded at the same time). |
| 3002 | # |
| 3003 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 3004 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 3005 | # this holds true. (Disruption stays within the limits of |
| 3006 | # PodDisruptionBudget, if it is configured.) |
| 3007 | # |
| 3008 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 3009 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 3010 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 3011 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 3012 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3013 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3014 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3015 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3016 | # the upgrade process. A node is considered available if its status is |
| 3017 | # Ready. |
| 3018 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3019 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3020 | "locations": [ # The list of Google Compute Engine |
| 3021 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3022 | # NodePool's nodes should be located. |
| 3023 | "A String", |
| 3024 | ], |
| 3025 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3026 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 3027 | # associated with this node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3028 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3029 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3030 | "version": "A String", # The version of the Kubernetes of this node. |
| 3031 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 3032 | "conditions": [ # Which conditions caused the current node pool state. |
| 3033 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3034 | # (e.g., ERROR or DEGRADED). |
| 3035 | "code": "A String", # Machine-friendly representation of the condition |
| 3036 | "message": "A String", # Human-friendly representation of the condition |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3037 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3038 | ], |
| 3039 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 3040 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| 3041 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3042 | # The smallest allowed disk size is 10GB. |
| 3043 | # |
| 3044 | # If unspecified, the default disk size is 100GB. |
| 3045 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3046 | # workloads on the node pool. |
| 3047 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 3048 | # workloads running on the node. |
| 3049 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3050 | # on the node pool. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3051 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3052 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3053 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3054 | # support for GPUs. |
| 3055 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 3056 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 3057 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3058 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 3059 | }, |
| 3060 | ], |
| 3061 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3062 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3063 | # `n1-standard-1`). |
| 3064 | # |
| 3065 | # If unspecified, the default machine type is |
| 3066 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3067 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3068 | # |
| 3069 | # If unspecified, the default disk type is 'pd-standard' |
| 3070 | "bootDiskKmsKey": "A String", # |
| 3071 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 3072 | # to each node in the node pool. This should be of the form |
| 3073 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 3074 | # For more information about protecting resources with Cloud KMS Keys please |
| 3075 | # see: |
| 3076 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 3077 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 3078 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3079 | # |
| 3080 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3081 | # verifying the digital signature of all boot components, and halting the |
| 3082 | # boot process if signature verification fails. |
| 3083 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3084 | # |
| 3085 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3086 | # The attestation is performed against the integrity policy baseline. This |
| 3087 | # baseline is initially derived from the implicitly trusted boot image when |
| 3088 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3089 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3090 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3091 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3092 | # friendly names of CPU platforms, such as |
| 3093 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3094 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3095 | # information, read [how to specify min CPU |
| 3096 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3097 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3098 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3099 | # inforamtion about preemptible VM instances. |
| 3100 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3101 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3102 | # The limit for this value is dependent upon the maximum number of |
| 3103 | # disks available on a machine per zone. See: |
| 3104 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 3105 | # for more information. |
| 3106 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3107 | "type": "A String", # Type of the sandbox to use for the node. |
| 3108 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 3109 | }, |
| 3110 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3111 | # |
| 3112 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3113 | # in length. These are reflected as part of a URL in the metadata server. |
| 3114 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3115 | # metadata keys for the project or be one of the reserved keys: |
| 3116 | # "cluster-location" |
| 3117 | # "cluster-name" |
| 3118 | # "cluster-uid" |
| 3119 | # "configure-sh" |
| 3120 | # "containerd-configure-sh" |
| 3121 | # "enable-oslogin" |
| 3122 | # "gci-ensure-gke-docker" |
| 3123 | # "gci-metrics-enabled" |
| 3124 | # "gci-update-strategy" |
| 3125 | # "instance-template" |
| 3126 | # "kube-env" |
| 3127 | # "startup-script" |
| 3128 | # "user-data" |
| 3129 | # "disable-address-manager" |
| 3130 | # "windows-startup-script-ps1" |
| 3131 | # "common-psm1" |
| 3132 | # "k8s-node-setup-psm1" |
| 3133 | # "install-ssh-psm1" |
| 3134 | # "user-profile-psm1" |
| 3135 | # "serial-port-logging-enable" |
| 3136 | # Values are free-form strings, and only have meaning as interpreted by |
| 3137 | # the image running in the instance. The only restriction placed on them is |
| 3138 | # that each value's size must be less than or equal to 32 KB. |
| 3139 | # |
| 3140 | # The total size of all keys and values must be less than 512 KB. |
| 3141 | "a_key": "A String", |
| 3142 | }, |
| 3143 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3144 | # the specified [Zonal Compute |
| 3145 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3146 | # to this node pool. |
| 3147 | # is the configuration of desired reservation which instances could take |
| 3148 | # capacity from. |
| 3149 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3150 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3151 | # the key and specify the name of your reservation as its value. |
| 3152 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3153 | "A String", |
| 3154 | ], |
| 3155 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 3156 | }, |
| 3157 | "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] | 3158 | # valid sources or targets for network firewalls and are specified by |
| 3159 | # the client during cluster or node pool creation. Each tag within the list |
| 3160 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3161 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3162 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3163 | "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] | 3164 | # 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] | 3165 | # Account is specified, the "default" service account is used. |
| 3166 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3167 | # the latest version of it will be used. |
| 3168 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3169 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3170 | # |
| 3171 | # The following scopes are recommended, but not required, and by default are |
| 3172 | # not included: |
| 3173 | # |
| 3174 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3175 | # persistent storage on your nodes. |
| 3176 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3177 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3178 | # (the [Google Container |
| 3179 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3180 | # |
| 3181 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3182 | # 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] | 3183 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3184 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3185 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3186 | # |
| 3187 | # For more information, including usage and the valid values, see: |
| 3188 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3189 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3190 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3191 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3192 | # See |
| 3193 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3194 | # for more information, including usage and the valid values. |
| 3195 | "key": "A String", # Key for taint. |
| 3196 | "value": "A String", # Value for taint. |
| 3197 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3198 | }, |
| 3199 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3200 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3201 | # These will added in addition to any default label(s) that |
| 3202 | # Kubernetes may apply to the node. |
| 3203 | # In case of conflict in label keys, the applied set may differ depending on |
| 3204 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3205 | # and conflicts should be avoided. |
| 3206 | # For more information, including usage and the valid values, see: |
| 3207 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3208 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3209 | }, |
| 3210 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3211 | "name": "A String", # The name of the node pool. |
| 3212 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 3213 | # simultaneously on a node in the node pool. |
| 3214 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 3215 | }, |
| 3216 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 3217 | # node pool. |
| 3218 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 3219 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 3220 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3221 | # the Auto Upgrades will proceed. |
| 3222 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3223 | # with the description of the upgrade. |
| 3224 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3225 | # with the approximate start time for the upgrades, in |
| 3226 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3227 | }, |
| 3228 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3229 | }, |
| 3230 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3231 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3232 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 3233 | # this cluster, in |
| 3234 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3235 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 3236 | # typically put in the last `/16` from the container CIDR. |
| 3237 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 3238 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 3239 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 3240 | "provider": "A String", # The selected network policy provider. |
| 3241 | }, |
| 3242 | "releaseChannel": { # ReleaseChannel indicates which release channel a cluster is # Release channel configuration. |
| 3243 | # subscribed to. Release channels are arranged in order of risk and |
| 3244 | # frequency of updates. |
| 3245 | # |
| 3246 | # When a cluster is subscribed to a release channel, Google maintains |
| 3247 | # both the master version and the node version. Node auto-upgrade |
| 3248 | # defaults to true and cannot be disabled. Updates to version related |
| 3249 | # fields (e.g. current_master_version) return an error. |
| 3250 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| 3251 | }, |
| 3252 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 3253 | # API groups (e.g. v1beta1) and features that may not be production ready in |
| 3254 | # the kubernetes version of the master and nodes. |
| 3255 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 3256 | # Alpha enabled clusters are automatically deleted thirty days after |
| 3257 | # creation. |
| 3258 | "description": "A String", # An optional description of this cluster. |
| 3259 | "conditions": [ # Which conditions caused the current cluster state. |
| 3260 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3261 | # (e.g., ERROR or DEGRADED). |
| 3262 | "code": "A String", # Machine-friendly representation of the condition |
| 3263 | "message": "A String", # Human-friendly representation of the condition |
| 3264 | }, |
| 3265 | ], |
| 3266 | "privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by |
| 3267 | # default have no external IP addresses on the nodes and where nodes and the |
| 3268 | # master communicate over private IP addresses. |
| 3269 | # This field is deprecated, use private_cluster_config.enable_private_nodes |
| 3270 | # instead. |
| 3271 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 3272 | # Call Kubernetes API directly to retrieve node information. |
| 3273 | "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] | 3274 | # Currently available options: |
| 3275 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3276 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3277 | # service with a Kubernetes-native resource model |
| 3278 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 3279 | # longer available as of GKE 1.15). |
| 3280 | # * `none` - No metrics will be exported from the cluster. |
| 3281 | # |
| 3282 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 3283 | # 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] | 3284 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 3285 | "state": "A String", # Denotes the state of etcd encryption. |
| 3286 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3287 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3288 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3289 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 3290 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 3291 | # images will be validated by Google Binauthz. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3292 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3293 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 3294 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3295 | # notation (e.g. `1.2.3.4/29`). |
| 3296 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 3297 | # policies. |
| 3298 | # policies. |
| 3299 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 3300 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 3301 | }, |
| 3302 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3303 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3304 | # cluster resides. This field is deprecated, use location instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3305 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
| 3306 | # Currently available options: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3307 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3308 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3309 | # service with a Kubernetes-native resource model |
| 3310 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3311 | # available as of GKE 1.15). |
| 3312 | # * `none` - no logs will be exported from the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3313 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3314 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3315 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 3316 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 3317 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3318 | "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] | 3319 | # 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] | 3320 | # "node_pool" object, since this configuration (along with the |
| 3321 | # "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] | 3322 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3323 | # For responses, this field will be populated with the node configuration of |
| 3324 | # the first node pool. (For configuration of each node pool, see |
| 3325 | # `node_pool.config`) |
| 3326 | # |
| 3327 | # If unspecified, the defaults are used. |
| 3328 | # This field is deprecated, use node_pool.config instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3329 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3330 | # The smallest allowed disk size is 10GB. |
| 3331 | # |
| 3332 | # If unspecified, the default disk size is 100GB. |
| 3333 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3334 | # workloads on the node pool. |
| 3335 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 3336 | # workloads running on the node. |
| 3337 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3338 | # on the node pool. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3339 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3340 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3341 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3342 | # support for GPUs. |
| 3343 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 3344 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 3345 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3346 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 3347 | }, |
| 3348 | ], |
| 3349 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3350 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3351 | # `n1-standard-1`). |
| 3352 | # |
| 3353 | # If unspecified, the default machine type is |
| 3354 | # `n1-standard-1`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3355 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3356 | # |
| 3357 | # If unspecified, the default disk type is 'pd-standard' |
| 3358 | "bootDiskKmsKey": "A String", # |
| 3359 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 3360 | # to each node in the node pool. This should be of the form |
| 3361 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 3362 | # For more information about protecting resources with Cloud KMS Keys please |
| 3363 | # see: |
| 3364 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| 3365 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 3366 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3367 | # |
| 3368 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3369 | # verifying the digital signature of all boot components, and halting the |
| 3370 | # boot process if signature verification fails. |
| 3371 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3372 | # |
| 3373 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3374 | # The attestation is performed against the integrity policy baseline. This |
| 3375 | # baseline is initially derived from the implicitly trusted boot image when |
| 3376 | # the instance is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3377 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3378 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3379 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3380 | # friendly names of CPU platforms, such as |
| 3381 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3382 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3383 | # information, read [how to specify min CPU |
| 3384 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3385 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3386 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3387 | # inforamtion about preemptible VM instances. |
| 3388 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3389 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3390 | # The limit for this value is dependent upon the maximum number of |
| 3391 | # disks available on a machine per zone. See: |
| 3392 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 3393 | # for more information. |
| 3394 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3395 | "type": "A String", # Type of the sandbox to use for the node. |
| 3396 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 3397 | }, |
| 3398 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3399 | # |
| 3400 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3401 | # in length. These are reflected as part of a URL in the metadata server. |
| 3402 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3403 | # metadata keys for the project or be one of the reserved keys: |
| 3404 | # "cluster-location" |
| 3405 | # "cluster-name" |
| 3406 | # "cluster-uid" |
| 3407 | # "configure-sh" |
| 3408 | # "containerd-configure-sh" |
| 3409 | # "enable-oslogin" |
| 3410 | # "gci-ensure-gke-docker" |
| 3411 | # "gci-metrics-enabled" |
| 3412 | # "gci-update-strategy" |
| 3413 | # "instance-template" |
| 3414 | # "kube-env" |
| 3415 | # "startup-script" |
| 3416 | # "user-data" |
| 3417 | # "disable-address-manager" |
| 3418 | # "windows-startup-script-ps1" |
| 3419 | # "common-psm1" |
| 3420 | # "k8s-node-setup-psm1" |
| 3421 | # "install-ssh-psm1" |
| 3422 | # "user-profile-psm1" |
| 3423 | # "serial-port-logging-enable" |
| 3424 | # Values are free-form strings, and only have meaning as interpreted by |
| 3425 | # the image running in the instance. The only restriction placed on them is |
| 3426 | # that each value's size must be less than or equal to 32 KB. |
| 3427 | # |
| 3428 | # The total size of all keys and values must be less than 512 KB. |
| 3429 | "a_key": "A String", |
| 3430 | }, |
| 3431 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3432 | # the specified [Zonal Compute |
| 3433 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3434 | # to this node pool. |
| 3435 | # is the configuration of desired reservation which instances could take |
| 3436 | # capacity from. |
| 3437 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3438 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3439 | # the key and specify the name of your reservation as its value. |
| 3440 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3441 | "A String", |
| 3442 | ], |
| 3443 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 3444 | }, |
| 3445 | "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] | 3446 | # valid sources or targets for network firewalls and are specified by |
| 3447 | # the client during cluster or node pool creation. Each tag within the list |
| 3448 | # must comply with RFC1035. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3449 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3450 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3451 | "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] | 3452 | # 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] | 3453 | # Account is specified, the "default" service account is used. |
| 3454 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3455 | # the latest version of it will be used. |
| 3456 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3457 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3458 | # |
| 3459 | # The following scopes are recommended, but not required, and by default are |
| 3460 | # not included: |
| 3461 | # |
| 3462 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3463 | # persistent storage on your nodes. |
| 3464 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3465 | # communicating with **gcr.io** |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3466 | # (the [Google Container |
| 3467 | # Registry](https://cloud.google.com/container-registry/)). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3468 | # |
| 3469 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3470 | # 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] | 3471 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3472 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3473 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3474 | # |
| 3475 | # For more information, including usage and the valid values, see: |
| 3476 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3477 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3478 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3479 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3480 | # See |
| 3481 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3482 | # for more information, including usage and the valid values. |
| 3483 | "key": "A String", # Key for taint. |
| 3484 | "value": "A String", # Value for taint. |
| 3485 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3486 | }, |
| 3487 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3488 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3489 | # These will added in addition to any default label(s) that |
| 3490 | # Kubernetes may apply to the node. |
| 3491 | # In case of conflict in label keys, the applied set may differ depending on |
| 3492 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3493 | # and conflicts should be avoided. |
| 3494 | # For more information, including usage and the valid values, see: |
| 3495 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3496 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3497 | }, |
| 3498 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3499 | "status": "A String", # [Output only] The current status of this cluster. |
| 3500 | "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; |
| 3501 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 3502 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 3503 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 3504 | }, |
| 3505 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
| 3506 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 3507 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 3508 | # cluster is connected. Example: |
| 3509 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 3510 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 3511 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 3512 | # to which the cluster is connected. Example: |
| 3513 | # projects/my-project/global/networks/my-network |
| 3514 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 3515 | # This makes same node pod to pod traffic visible for VPC network. |
| 3516 | }, |
| 3517 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 3518 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 3519 | # the following restrictions: |
| 3520 | # |
| 3521 | # * Lowercase letters, numbers, and hyphens only. |
| 3522 | # * Must start with a letter. |
| 3523 | # * Must end with a number or a letter. |
| 3524 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 3525 | # The endpoint can be accessed from the internet at |
| 3526 | # `https://username:password@endpoint/`. |
| 3527 | # |
| 3528 | # See the `masterAuth` property of this resource for username and |
| 3529 | # password information. |
| 3530 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 3531 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3532 | # or |
| 3533 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3534 | # in which the cluster resides. |
| 3535 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 3536 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3537 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3538 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3539 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 3540 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3541 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 3542 | # required by Cluster Autoscaler to automatically adjust |
| 3543 | # the size of the cluster and create/delete |
| 3544 | # node pools based on the current needs. |
| 3545 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 3546 | # amount of resources in the cluster. |
| 3547 | { # Contains information about amount of some resource in the cluster. |
| 3548 | # For memory, value should be in GB. |
| 3549 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 3550 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 3551 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 3552 | }, |
| 3553 | ], |
| 3554 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 3555 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 3556 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 3557 | # created by NAP. |
| 3558 | # by NAP. |
| 3559 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 3560 | # specified, service_account should be empty. |
| 3561 | "A String", |
| 3562 | ], |
| 3563 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 3564 | # node pool. |
| 3565 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 3566 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 3567 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3568 | # the Auto Upgrades will proceed. |
| 3569 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3570 | # with the description of the upgrade. |
| 3571 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3572 | # with the approximate start time for the upgrades, in |
| 3573 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3574 | }, |
| 3575 | }, |
| 3576 | "minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. |
| 3577 | # The instance may be scheduled on the specified or newer CPU platform. |
| 3578 | # Applicable values are the friendly names of CPU platforms, such as |
| 3579 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3580 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3581 | # information, read [how to specify min CPU |
| 3582 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3583 | # To unset the min cpu platform field pass "automatic" as field value. |
| 3584 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 3585 | # disruption caused by an upgrade. |
| 3586 | # |
| 3587 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 3588 | # unavailable. |
| 3589 | # |
| 3590 | # maxSurge controls the number of additional nodes that can be added to the |
| 3591 | # node pool temporarily for the time of the upgrade to increase the number of |
| 3592 | # available nodes. |
| 3593 | # |
| 3594 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 3595 | # nodes are being upgraded at the same time). |
| 3596 | # |
| 3597 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 3598 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 3599 | # this holds true. (Disruption stays within the limits of |
| 3600 | # PodDisruptionBudget, if it is configured.) |
| 3601 | # |
| 3602 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 3603 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 3604 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 3605 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 3606 | # there are always at least 4 nodes available. |
| 3607 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 3608 | # of the node pool during the upgrade process. |
| 3609 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 3610 | # the upgrade process. A node is considered available if its status is |
| 3611 | # Ready. |
| 3612 | }, |
| 3613 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 3614 | # service_account is specified, scopes should be empty. |
| 3615 | }, |
| 3616 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 3617 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3618 | # NodePool's nodes can be created by NAP. |
| 3619 | "A String", |
| 3620 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3621 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3622 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 3623 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3624 | # is sufficient for this number of instances. You must also have available |
| 3625 | # firewall and routes quota. |
| 3626 | # 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] | 3627 | # "node_pool" object, since this configuration (along with the |
| 3628 | # "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] | 3629 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3630 | # |
| 3631 | # This field is deprecated, use node_pool.initial_node_count instead. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3632 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 3633 | "A String", |
| 3634 | ], |
| 3635 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 3636 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 3637 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 3638 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 3639 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 3640 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 3641 | }, |
| 3642 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 3643 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 3644 | # given only RFC 1918 private addresses and communicate with the master via |
| 3645 | # private networking. |
| 3646 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 3647 | # range will be used for assigning internal IP addresses to the master or |
| 3648 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 3649 | # any other ranges in use within the cluster's network. |
| 3650 | }, |
| 3651 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 3652 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 3653 | }, |
| 3654 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 3655 | # required by Vertical Pod Autoscaler to automatically adjust |
| 3656 | # the resources of pods controlled by it. |
| 3657 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 3658 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3659 | }, |
| 3660 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3661 | "missingZones": [ # If any zones are listed here, the list of clusters returned |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3662 | # may be missing those zones. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3663 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3664 | ], |
| 3665 | }</pre> |
| 3666 | </div> |
| 3667 | |
| 3668 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3669 | <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] | 3670 | <pre>Sets the addons for a specific cluster. |
| 3671 | |
| 3672 | Args: |
| 3673 | 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] | 3674 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3675 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3676 | The object takes the form of: |
| 3677 | |
| 3678 | { # SetAddonsRequest sets the addons associated with the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3679 | "name": "A String", # The name (project, location, cluster) of the cluster to set addons. |
| 3680 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3681 | "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] | 3682 | # number](https://support.google.com/cloud/answer/6158840). |
| 3683 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3684 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 3685 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3686 | # cluster resides. This field has been deprecated and replaced by the name |
| 3687 | # field. |
| 3688 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 3689 | # This field has been deprecated and replaced by the name field. |
| 3690 | "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] | 3691 | # cluster. |
| 3692 | # cluster, enabling additional functionality. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3693 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3694 | # is enabled or not on the Master, it does not track whether network policy |
| 3695 | # is enabled for the nodes. |
| 3696 | # is enabled or not on the Master, it does not track whether network policy |
| 3697 | # is enabled for the nodes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3698 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3699 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3700 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 3701 | # extension to manage hosted GCP services through the Kubernetes API |
| 3702 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 3703 | }, |
| 3704 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3705 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 3706 | # at cluster creation time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3707 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3708 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3709 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3710 | # increases or decreases the number of replica pods a replication controller |
| 3711 | # has based on the resource usage of the existing pods. |
| 3712 | # increases or decreases the number of replica pods a replication controller |
| 3713 | # has based on the resource usage of the existing pods. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3714 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3715 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 3716 | # Monitoring. |
| 3717 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3718 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 3719 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 3720 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 3721 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 3722 | # When enabled, it runs a small pod in the cluster that manages the load |
| 3723 | # balancers. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3724 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3725 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3726 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 3727 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 3728 | # workloads and applications. For more information, see: |
| 3729 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3730 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 3731 | }, |
| 3732 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 3733 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 3734 | }, |
| 3735 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 3736 | # applications. |
| 3737 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 3738 | }, |
| 3739 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 3740 | # enabled at cluster creation time. |
| 3741 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 3742 | }, |
| 3743 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 3744 | # microservices. |
| 3745 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 3746 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3747 | }, |
| 3748 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3749 | } |
| 3750 | |
| 3751 | x__xgafv: string, V1 error format. |
| 3752 | Allowed values |
| 3753 | 1 - v1 error format |
| 3754 | 2 - v2 error format |
| 3755 | |
| 3756 | Returns: |
| 3757 | An object of the form: |
| 3758 | |
| 3759 | { # This operation resource represents operations that may have happened or are |
| 3760 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3761 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3762 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3763 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3764 | "code": "A String", # Machine-friendly representation of the condition |
| 3765 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3766 | }, |
| 3767 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3768 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3769 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3770 | # or |
| 3771 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3772 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3773 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 3774 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3775 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3776 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3777 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3778 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3779 | # (e.g., ERROR or DEGRADED). |
| 3780 | "code": "A String", # Machine-friendly representation of the condition |
| 3781 | "message": "A String", # Human-friendly representation of the condition |
| 3782 | }, |
| 3783 | ], |
| 3784 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3785 | "stages": [ # Substages of an operation or a stage. |
| 3786 | # Object with schema name: OperationProgress |
| 3787 | ], |
| 3788 | "status": "A String", # Status of an operation stage. |
| 3789 | # Unset for single-stage operations. |
| 3790 | "metrics": [ # Progress metric bundle, for example: |
| 3791 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3792 | # {name: "nodes total", int_value: 32}] |
| 3793 | # or |
| 3794 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3795 | # {name: "progress scale", double_value: 1.0}] |
| 3796 | { # Progress metric is (string, int|float|string) pair. |
| 3797 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3798 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3799 | "intValue": "A String", # For metrics with integer value. |
| 3800 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3801 | }, |
| 3802 | ], |
| 3803 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3804 | # Unset for single-stage operations. |
| 3805 | }, |
| 3806 | "zone": "A String", # The name of the Google Compute Engine |
| 3807 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3808 | # operation is taking place. This field is deprecated, use location instead. |
| 3809 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3810 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3811 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3812 | "detail": "A String", # Detailed operation progress, if available. |
| 3813 | "operationType": "A String", # The operation type. |
| 3814 | "status": "A String", # The current status of the operation. |
| 3815 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3816 | }</pre> |
| 3817 | </div> |
| 3818 | |
| 3819 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3820 | <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] | 3821 | <pre>Enables or disables the ABAC authorization mechanism on a cluster. |
| 3822 | |
| 3823 | Args: |
| 3824 | 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] | 3825 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3826 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3827 | The object takes the form of: |
| 3828 | |
| 3829 | { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for |
| 3830 | # a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3831 | "name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. |
| 3832 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3833 | "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. |
| 3834 | "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] | 3835 | # number](https://support.google.com/cloud/answer/6158840). |
| 3836 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3837 | "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] | 3838 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3839 | # cluster resides. This field has been deprecated and replaced by the name |
| 3840 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3841 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. |
| 3842 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3843 | } |
| 3844 | |
| 3845 | x__xgafv: string, V1 error format. |
| 3846 | Allowed values |
| 3847 | 1 - v1 error format |
| 3848 | 2 - v2 error format |
| 3849 | |
| 3850 | Returns: |
| 3851 | An object of the form: |
| 3852 | |
| 3853 | { # This operation resource represents operations that may have happened or are |
| 3854 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3855 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3856 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3857 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3858 | "code": "A String", # Machine-friendly representation of the condition |
| 3859 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3860 | }, |
| 3861 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3862 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3863 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3864 | # or |
| 3865 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3866 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3867 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 3868 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3869 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3870 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3871 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3872 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3873 | # (e.g., ERROR or DEGRADED). |
| 3874 | "code": "A String", # Machine-friendly representation of the condition |
| 3875 | "message": "A String", # Human-friendly representation of the condition |
| 3876 | }, |
| 3877 | ], |
| 3878 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3879 | "stages": [ # Substages of an operation or a stage. |
| 3880 | # Object with schema name: OperationProgress |
| 3881 | ], |
| 3882 | "status": "A String", # Status of an operation stage. |
| 3883 | # Unset for single-stage operations. |
| 3884 | "metrics": [ # Progress metric bundle, for example: |
| 3885 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3886 | # {name: "nodes total", int_value: 32}] |
| 3887 | # or |
| 3888 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3889 | # {name: "progress scale", double_value: 1.0}] |
| 3890 | { # Progress metric is (string, int|float|string) pair. |
| 3891 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3892 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3893 | "intValue": "A String", # For metrics with integer value. |
| 3894 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3895 | }, |
| 3896 | ], |
| 3897 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3898 | # Unset for single-stage operations. |
| 3899 | }, |
| 3900 | "zone": "A String", # The name of the Google Compute Engine |
| 3901 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3902 | # operation is taking place. This field is deprecated, use location instead. |
| 3903 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3904 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3905 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3906 | "detail": "A String", # Detailed operation progress, if available. |
| 3907 | "operationType": "A String", # The operation type. |
| 3908 | "status": "A String", # The current status of the operation. |
| 3909 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3910 | }</pre> |
| 3911 | </div> |
| 3912 | |
| 3913 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3914 | <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] | 3915 | <pre>Sets the locations for a specific cluster. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3916 | Deprecated. Use |
| 3917 | [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) |
| 3918 | instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3919 | |
| 3920 | Args: |
| 3921 | 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] | 3922 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3923 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3924 | The object takes the form of: |
| 3925 | |
| 3926 | { # SetLocationsRequest sets the locations of the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3927 | "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] | 3928 | # number](https://support.google.com/cloud/answer/6158840). |
| 3929 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3930 | "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] | 3931 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3932 | # cluster resides. This field has been deprecated and replaced by the name |
| 3933 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3934 | "locations": [ # Required. The desired list of Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3935 | # [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] | 3936 | # 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] | 3937 | # will result in nodes being either created or removed from the cluster, |
| 3938 | # depending on whether locations are being added or removed. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3939 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3940 | # This list must always include the cluster's primary zone. |
| 3941 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3942 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3943 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 3944 | # This field has been deprecated and replaced by the name field. |
| 3945 | "name": "A String", # The name (project, location, cluster) of the cluster to set locations. |
| 3946 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3947 | } |
| 3948 | |
| 3949 | x__xgafv: string, V1 error format. |
| 3950 | Allowed values |
| 3951 | 1 - v1 error format |
| 3952 | 2 - v2 error format |
| 3953 | |
| 3954 | Returns: |
| 3955 | An object of the form: |
| 3956 | |
| 3957 | { # This operation resource represents operations that may have happened or are |
| 3958 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3959 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3960 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3961 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3962 | "code": "A String", # Machine-friendly representation of the condition |
| 3963 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3964 | }, |
| 3965 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3966 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3967 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3968 | # or |
| 3969 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3970 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3971 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 3972 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3973 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3974 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3975 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3976 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3977 | # (e.g., ERROR or DEGRADED). |
| 3978 | "code": "A String", # Machine-friendly representation of the condition |
| 3979 | "message": "A String", # Human-friendly representation of the condition |
| 3980 | }, |
| 3981 | ], |
| 3982 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3983 | "stages": [ # Substages of an operation or a stage. |
| 3984 | # Object with schema name: OperationProgress |
| 3985 | ], |
| 3986 | "status": "A String", # Status of an operation stage. |
| 3987 | # Unset for single-stage operations. |
| 3988 | "metrics": [ # Progress metric bundle, for example: |
| 3989 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3990 | # {name: "nodes total", int_value: 32}] |
| 3991 | # or |
| 3992 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3993 | # {name: "progress scale", double_value: 1.0}] |
| 3994 | { # Progress metric is (string, int|float|string) pair. |
| 3995 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3996 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3997 | "intValue": "A String", # For metrics with integer value. |
| 3998 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3999 | }, |
| 4000 | ], |
| 4001 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4002 | # Unset for single-stage operations. |
| 4003 | }, |
| 4004 | "zone": "A String", # The name of the Google Compute Engine |
| 4005 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4006 | # operation is taking place. This field is deprecated, use location instead. |
| 4007 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4008 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4009 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4010 | "detail": "A String", # Detailed operation progress, if available. |
| 4011 | "operationType": "A String", # The operation type. |
| 4012 | "status": "A String", # The current status of the operation. |
| 4013 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4014 | }</pre> |
| 4015 | </div> |
| 4016 | |
| 4017 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4018 | <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] | 4019 | <pre>Sets the logging service for a specific cluster. |
| 4020 | |
| 4021 | Args: |
| 4022 | 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] | 4023 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4024 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4025 | The object takes the form of: |
| 4026 | |
| 4027 | { # SetLoggingServiceRequest sets the logging service of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4028 | "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] | 4029 | # Currently available options: |
| 4030 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4031 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 4032 | # service with a Kubernetes-native resource model |
| 4033 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 4034 | # available as of GKE 1.15). |
| 4035 | # * `none` - no logs will be exported from the cluster. |
| 4036 | # |
| 4037 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 4038 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4039 | "name": "A String", # The name (project, location, cluster) of the cluster to set logging. |
| 4040 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4041 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4042 | # number](https://support.google.com/cloud/answer/6158840). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4043 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4044 | "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] | 4045 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4046 | # cluster resides. This field has been deprecated and replaced by the name |
| 4047 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4048 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4049 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4050 | } |
| 4051 | |
| 4052 | x__xgafv: string, V1 error format. |
| 4053 | Allowed values |
| 4054 | 1 - v1 error format |
| 4055 | 2 - v2 error format |
| 4056 | |
| 4057 | Returns: |
| 4058 | An object of the form: |
| 4059 | |
| 4060 | { # This operation resource represents operations that may have happened or are |
| 4061 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4062 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4063 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4064 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4065 | "code": "A String", # Machine-friendly representation of the condition |
| 4066 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4067 | }, |
| 4068 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4069 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4070 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4071 | # or |
| 4072 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4073 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4074 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4075 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4076 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4077 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4078 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4079 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4080 | # (e.g., ERROR or DEGRADED). |
| 4081 | "code": "A String", # Machine-friendly representation of the condition |
| 4082 | "message": "A String", # Human-friendly representation of the condition |
| 4083 | }, |
| 4084 | ], |
| 4085 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4086 | "stages": [ # Substages of an operation or a stage. |
| 4087 | # Object with schema name: OperationProgress |
| 4088 | ], |
| 4089 | "status": "A String", # Status of an operation stage. |
| 4090 | # Unset for single-stage operations. |
| 4091 | "metrics": [ # Progress metric bundle, for example: |
| 4092 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4093 | # {name: "nodes total", int_value: 32}] |
| 4094 | # or |
| 4095 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4096 | # {name: "progress scale", double_value: 1.0}] |
| 4097 | { # Progress metric is (string, int|float|string) pair. |
| 4098 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4099 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4100 | "intValue": "A String", # For metrics with integer value. |
| 4101 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4102 | }, |
| 4103 | ], |
| 4104 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4105 | # Unset for single-stage operations. |
| 4106 | }, |
| 4107 | "zone": "A String", # The name of the Google Compute Engine |
| 4108 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4109 | # operation is taking place. This field is deprecated, use location instead. |
| 4110 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4111 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4112 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4113 | "detail": "A String", # Detailed operation progress, if available. |
| 4114 | "operationType": "A String", # The operation type. |
| 4115 | "status": "A String", # The current status of the operation. |
| 4116 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4117 | }</pre> |
| 4118 | </div> |
| 4119 | |
| 4120 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4121 | <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] | 4122 | <pre>Sets the maintenance policy for a cluster. |
| 4123 | |
| 4124 | Args: |
| 4125 | name: string, The name (project, location, cluster id) of the cluster to set maintenance |
| 4126 | policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4127 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4128 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4129 | The object takes the form of: |
| 4130 | |
| 4131 | { # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4132 | "clusterId": "A String", # Required. The name of the cluster to update. |
| 4133 | "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] | 4134 | # clears the existing maintenance policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4135 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 4136 | # the policy won't accidentally undo intermediate changes (and so that users |
| 4137 | # of the API unaware of some fields won't accidentally remove other fields). |
| 4138 | # Make a <code>get()</code> request to the cluster to get the current |
| 4139 | # resource version and include it with requests to set the policy. |
| 4140 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
| 4141 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 4142 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 4143 | # smallest possible in the given scenario. |
| 4144 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 4145 | # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 4146 | }, |
| 4147 | "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] | 4148 | # maintenance to occur. The time windows may be overlapping. If no |
| 4149 | # maintenance windows are set, maintenance can occur at any time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4150 | "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] | 4151 | # this window reccurs. They go on for the span of time between the start and |
| 4152 | # end time. |
| 4153 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4154 | # For example, to have something repeat every weekday, you'd use: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4155 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 4156 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 4157 | # <code>FREQ=DAILY</code> |
| 4158 | # For the first weekend of every month: |
| 4159 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 4160 | # 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] | 4161 | # 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] | 4162 | # <code> |
| 4163 | # start time = 2019-01-01T09:00:00-0400 |
| 4164 | # end time = 2019-01-01T17:00:00-0400 |
| 4165 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 4166 | # </code> |
| 4167 | # Windows can span multiple days. Eg, to make the window encompass every |
| 4168 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 4169 | # <code> |
| 4170 | # start time = 2019-01-05T00:00:00Z |
| 4171 | # end time = 2019-01-07T23:59:00Z |
| 4172 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 4173 | # </code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4174 | # 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] | 4175 | # to specify duration of the window and when it first starts. |
| 4176 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4177 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 4178 | "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] | 4179 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4180 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4181 | }, |
| 4182 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4183 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4184 | # occur in these windows. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4185 | "a_key": { # Represents an arbitrary window of time. |
| 4186 | "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] | 4187 | # start time. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4188 | "startTime": "A String", # The time that the window first starts. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4189 | }, |
| 4190 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4191 | }, |
| 4192 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4193 | "name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4194 | # policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4195 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4196 | "projectId": "A String", # Required. The Google Developers Console [project ID or project |
| 4197 | # number](https://support.google.com/cloud/answer/6158840). |
| 4198 | "zone": "A String", # Required. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4199 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4200 | # cluster resides. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4201 | } |
| 4202 | |
| 4203 | x__xgafv: string, V1 error format. |
| 4204 | Allowed values |
| 4205 | 1 - v1 error format |
| 4206 | 2 - v2 error format |
| 4207 | |
| 4208 | Returns: |
| 4209 | An object of the form: |
| 4210 | |
| 4211 | { # This operation resource represents operations that may have happened or are |
| 4212 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4213 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4214 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4215 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4216 | "code": "A String", # Machine-friendly representation of the condition |
| 4217 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4218 | }, |
| 4219 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4220 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4221 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4222 | # or |
| 4223 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4224 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4225 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4226 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4227 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4228 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4229 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4230 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4231 | # (e.g., ERROR or DEGRADED). |
| 4232 | "code": "A String", # Machine-friendly representation of the condition |
| 4233 | "message": "A String", # Human-friendly representation of the condition |
| 4234 | }, |
| 4235 | ], |
| 4236 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4237 | "stages": [ # Substages of an operation or a stage. |
| 4238 | # Object with schema name: OperationProgress |
| 4239 | ], |
| 4240 | "status": "A String", # Status of an operation stage. |
| 4241 | # Unset for single-stage operations. |
| 4242 | "metrics": [ # Progress metric bundle, for example: |
| 4243 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4244 | # {name: "nodes total", int_value: 32}] |
| 4245 | # or |
| 4246 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4247 | # {name: "progress scale", double_value: 1.0}] |
| 4248 | { # Progress metric is (string, int|float|string) pair. |
| 4249 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4250 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4251 | "intValue": "A String", # For metrics with integer value. |
| 4252 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4253 | }, |
| 4254 | ], |
| 4255 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4256 | # Unset for single-stage operations. |
| 4257 | }, |
| 4258 | "zone": "A String", # The name of the Google Compute Engine |
| 4259 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4260 | # operation is taking place. This field is deprecated, use location instead. |
| 4261 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4262 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4263 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4264 | "detail": "A String", # Detailed operation progress, if available. |
| 4265 | "operationType": "A String", # The operation type. |
| 4266 | "status": "A String", # The current status of the operation. |
| 4267 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4268 | }</pre> |
| 4269 | </div> |
| 4270 | |
| 4271 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4272 | <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] | 4273 | <pre>Sets master auth materials. Currently supports changing the admin password |
| 4274 | or a specific cluster, either via password generation or explicitly setting |
| 4275 | the password. |
| 4276 | |
| 4277 | Args: |
| 4278 | 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] | 4279 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4280 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4281 | The object takes the form of: |
| 4282 | |
| 4283 | { # SetMasterAuthRequest updates the admin password of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4284 | "name": "A String", # The name (project, location, cluster) of the cluster to set auth. |
| 4285 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4286 | "action": "A String", # Required. The exact form of action to be taken on the master auth. |
| 4287 | "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] | 4288 | # number](https://support.google.com/cloud/answer/6158840). |
| 4289 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4290 | "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] | 4291 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4292 | "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] | 4293 | # Authentication can be done using HTTP basic auth or using client |
| 4294 | # certificates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4295 | "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] | 4296 | # Because the master endpoint is open to the Internet, you should create a |
| 4297 | # strong password. If a password is provided for cluster creation, username |
| 4298 | # must be non-empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4299 | "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] | 4300 | # clusters before v1.12, if no configuration is specified, a client |
| 4301 | # certificate is issued. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4302 | "issueClientCertificate": True or False, # Issue a client certificate. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4303 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4304 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 4305 | # to the cluster endpoint. |
| 4306 | "clusterCaCertificate": "A String", |
| 4307 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 4308 | # authenticate to the cluster endpoint. |
| 4309 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 4310 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 4311 | # leaving username unspecified (or setting it to the empty string). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4312 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4313 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4314 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4315 | # cluster resides. This field has been deprecated and replaced by the name |
| 4316 | # field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4317 | } |
| 4318 | |
| 4319 | x__xgafv: string, V1 error format. |
| 4320 | Allowed values |
| 4321 | 1 - v1 error format |
| 4322 | 2 - v2 error format |
| 4323 | |
| 4324 | Returns: |
| 4325 | An object of the form: |
| 4326 | |
| 4327 | { # This operation resource represents operations that may have happened or are |
| 4328 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4329 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4330 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4331 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4332 | "code": "A String", # Machine-friendly representation of the condition |
| 4333 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4334 | }, |
| 4335 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4336 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4337 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4338 | # or |
| 4339 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4340 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4341 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4342 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4343 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4344 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4345 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4346 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4347 | # (e.g., ERROR or DEGRADED). |
| 4348 | "code": "A String", # Machine-friendly representation of the condition |
| 4349 | "message": "A String", # Human-friendly representation of the condition |
| 4350 | }, |
| 4351 | ], |
| 4352 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4353 | "stages": [ # Substages of an operation or a stage. |
| 4354 | # Object with schema name: OperationProgress |
| 4355 | ], |
| 4356 | "status": "A String", # Status of an operation stage. |
| 4357 | # Unset for single-stage operations. |
| 4358 | "metrics": [ # Progress metric bundle, for example: |
| 4359 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4360 | # {name: "nodes total", int_value: 32}] |
| 4361 | # or |
| 4362 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4363 | # {name: "progress scale", double_value: 1.0}] |
| 4364 | { # Progress metric is (string, int|float|string) pair. |
| 4365 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4366 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4367 | "intValue": "A String", # For metrics with integer value. |
| 4368 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4369 | }, |
| 4370 | ], |
| 4371 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4372 | # Unset for single-stage operations. |
| 4373 | }, |
| 4374 | "zone": "A String", # The name of the Google Compute Engine |
| 4375 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4376 | # operation is taking place. This field is deprecated, use location instead. |
| 4377 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4378 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4379 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4380 | "detail": "A String", # Detailed operation progress, if available. |
| 4381 | "operationType": "A String", # The operation type. |
| 4382 | "status": "A String", # The current status of the operation. |
| 4383 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4384 | }</pre> |
| 4385 | </div> |
| 4386 | |
| 4387 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4388 | <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] | 4389 | <pre>Sets the monitoring service for a specific cluster. |
| 4390 | |
| 4391 | Args: |
| 4392 | 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] | 4393 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4394 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4395 | The object takes the form of: |
| 4396 | |
| 4397 | { # SetMonitoringServiceRequest sets the monitoring service of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4398 | "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] | 4399 | # number](https://support.google.com/cloud/answer/6158840). |
| 4400 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4401 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4402 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4403 | # cluster resides. This field has been deprecated and replaced by the name |
| 4404 | # field. |
| 4405 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 4406 | # This field has been deprecated and replaced by the name field. |
| 4407 | "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] | 4408 | # Currently available options: |
| 4409 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4410 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4411 | # service with a Kubernetes-native resource model |
| 4412 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 4413 | # longer available as of GKE 1.15). |
| 4414 | # * `none` - No metrics will be exported from the cluster. |
| 4415 | # |
| 4416 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 4417 | # 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] | 4418 | "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. |
| 4419 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4420 | } |
| 4421 | |
| 4422 | x__xgafv: string, V1 error format. |
| 4423 | Allowed values |
| 4424 | 1 - v1 error format |
| 4425 | 2 - v2 error format |
| 4426 | |
| 4427 | Returns: |
| 4428 | An object of the form: |
| 4429 | |
| 4430 | { # This operation resource represents operations that may have happened or are |
| 4431 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4432 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4433 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4434 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4435 | "code": "A String", # Machine-friendly representation of the condition |
| 4436 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4437 | }, |
| 4438 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4439 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4440 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4441 | # or |
| 4442 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4443 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4444 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4445 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4446 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4447 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4448 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4449 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4450 | # (e.g., ERROR or DEGRADED). |
| 4451 | "code": "A String", # Machine-friendly representation of the condition |
| 4452 | "message": "A String", # Human-friendly representation of the condition |
| 4453 | }, |
| 4454 | ], |
| 4455 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4456 | "stages": [ # Substages of an operation or a stage. |
| 4457 | # Object with schema name: OperationProgress |
| 4458 | ], |
| 4459 | "status": "A String", # Status of an operation stage. |
| 4460 | # Unset for single-stage operations. |
| 4461 | "metrics": [ # Progress metric bundle, for example: |
| 4462 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4463 | # {name: "nodes total", int_value: 32}] |
| 4464 | # or |
| 4465 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4466 | # {name: "progress scale", double_value: 1.0}] |
| 4467 | { # Progress metric is (string, int|float|string) pair. |
| 4468 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4469 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4470 | "intValue": "A String", # For metrics with integer value. |
| 4471 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4472 | }, |
| 4473 | ], |
| 4474 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4475 | # Unset for single-stage operations. |
| 4476 | }, |
| 4477 | "zone": "A String", # The name of the Google Compute Engine |
| 4478 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4479 | # operation is taking place. This field is deprecated, use location instead. |
| 4480 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4481 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4482 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4483 | "detail": "A String", # Detailed operation progress, if available. |
| 4484 | "operationType": "A String", # The operation type. |
| 4485 | "status": "A String", # The current status of the operation. |
| 4486 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4487 | }</pre> |
| 4488 | </div> |
| 4489 | |
| 4490 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4491 | <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] | 4492 | <pre>Enables or disables Network Policy for a cluster. |
| 4493 | |
| 4494 | Args: |
| 4495 | 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] | 4496 | policy. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4497 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4498 | The object takes the form of: |
| 4499 | |
| 4500 | { # SetNetworkPolicyRequest enables/disables network policy for a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4501 | "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] | 4502 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4503 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4504 | "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] | 4505 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4506 | # cluster resides. This field has been deprecated and replaced by the name |
| 4507 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4508 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 4509 | # This field has been deprecated and replaced by the name field. |
| 4510 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature. |
| 4511 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 4512 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 4513 | "provider": "A String", # The selected network policy provider. |
| 4514 | }, |
| 4515 | "name": "A String", # The name (project, location, cluster id) of the cluster to set networking |
| 4516 | # policy. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4517 | } |
| 4518 | |
| 4519 | x__xgafv: string, V1 error format. |
| 4520 | Allowed values |
| 4521 | 1 - v1 error format |
| 4522 | 2 - v2 error format |
| 4523 | |
| 4524 | Returns: |
| 4525 | An object of the form: |
| 4526 | |
| 4527 | { # This operation resource represents operations that may have happened or are |
| 4528 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4529 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4530 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4531 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4532 | "code": "A String", # Machine-friendly representation of the condition |
| 4533 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4534 | }, |
| 4535 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4536 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4537 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4538 | # or |
| 4539 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4540 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4541 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4542 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4543 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4544 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4545 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4546 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4547 | # (e.g., ERROR or DEGRADED). |
| 4548 | "code": "A String", # Machine-friendly representation of the condition |
| 4549 | "message": "A String", # Human-friendly representation of the condition |
| 4550 | }, |
| 4551 | ], |
| 4552 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4553 | "stages": [ # Substages of an operation or a stage. |
| 4554 | # Object with schema name: OperationProgress |
| 4555 | ], |
| 4556 | "status": "A String", # Status of an operation stage. |
| 4557 | # Unset for single-stage operations. |
| 4558 | "metrics": [ # Progress metric bundle, for example: |
| 4559 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4560 | # {name: "nodes total", int_value: 32}] |
| 4561 | # or |
| 4562 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4563 | # {name: "progress scale", double_value: 1.0}] |
| 4564 | { # Progress metric is (string, int|float|string) pair. |
| 4565 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4566 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4567 | "intValue": "A String", # For metrics with integer value. |
| 4568 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4569 | }, |
| 4570 | ], |
| 4571 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4572 | # Unset for single-stage operations. |
| 4573 | }, |
| 4574 | "zone": "A String", # The name of the Google Compute Engine |
| 4575 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4576 | # operation is taking place. This field is deprecated, use location instead. |
| 4577 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4578 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4579 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4580 | "detail": "A String", # Detailed operation progress, if available. |
| 4581 | "operationType": "A String", # The operation type. |
| 4582 | "status": "A String", # The current status of the operation. |
| 4583 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4584 | }</pre> |
| 4585 | </div> |
| 4586 | |
| 4587 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4588 | <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] | 4589 | <pre>Sets labels on a cluster. |
| 4590 | |
| 4591 | Args: |
| 4592 | 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] | 4593 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4594 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4595 | The object takes the form of: |
| 4596 | |
| 4597 | { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container |
| 4598 | # Engine cluster, which will in turn set them for Google Compute Engine |
| 4599 | # resources used by that cluster |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4600 | "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4601 | # used to detect conflicts. The fingerprint is initially generated by |
| 4602 | # Kubernetes Engine and changes after every request to modify or update |
| 4603 | # labels. You must always provide an up-to-date fingerprint hash when |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4604 | # updating or changing labels. Make a <code>get()</code> request to the |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4605 | # resource to get the latest fingerprint. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4606 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4607 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4608 | # cluster resides. This field has been deprecated and replaced by the name |
| 4609 | # field. |
| 4610 | "name": "A String", # The name (project, location, cluster id) of the cluster to set labels. |
| 4611 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4612 | "resourceLabels": { # Required. The labels to set for that cluster. |
| 4613 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4614 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4615 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 4616 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4617 | # This field has been deprecated and replaced by the name field. |
| 4618 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 4619 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4620 | } |
| 4621 | |
| 4622 | x__xgafv: string, V1 error format. |
| 4623 | Allowed values |
| 4624 | 1 - v1 error format |
| 4625 | 2 - v2 error format |
| 4626 | |
| 4627 | Returns: |
| 4628 | An object of the form: |
| 4629 | |
| 4630 | { # This operation resource represents operations that may have happened or are |
| 4631 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4632 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4633 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4634 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4635 | "code": "A String", # Machine-friendly representation of the condition |
| 4636 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4637 | }, |
| 4638 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4639 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4640 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4641 | # or |
| 4642 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4643 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4644 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4645 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4646 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4647 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4648 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4649 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4650 | # (e.g., ERROR or DEGRADED). |
| 4651 | "code": "A String", # Machine-friendly representation of the condition |
| 4652 | "message": "A String", # Human-friendly representation of the condition |
| 4653 | }, |
| 4654 | ], |
| 4655 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4656 | "stages": [ # Substages of an operation or a stage. |
| 4657 | # Object with schema name: OperationProgress |
| 4658 | ], |
| 4659 | "status": "A String", # Status of an operation stage. |
| 4660 | # Unset for single-stage operations. |
| 4661 | "metrics": [ # Progress metric bundle, for example: |
| 4662 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4663 | # {name: "nodes total", int_value: 32}] |
| 4664 | # or |
| 4665 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4666 | # {name: "progress scale", double_value: 1.0}] |
| 4667 | { # Progress metric is (string, int|float|string) pair. |
| 4668 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4669 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4670 | "intValue": "A String", # For metrics with integer value. |
| 4671 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4672 | }, |
| 4673 | ], |
| 4674 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4675 | # Unset for single-stage operations. |
| 4676 | }, |
| 4677 | "zone": "A String", # The name of the Google Compute Engine |
| 4678 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4679 | # operation is taking place. This field is deprecated, use location instead. |
| 4680 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4681 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4682 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4683 | "detail": "A String", # Detailed operation progress, if available. |
| 4684 | "operationType": "A String", # The operation type. |
| 4685 | "status": "A String", # The current status of the operation. |
| 4686 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4687 | }</pre> |
| 4688 | </div> |
| 4689 | |
| 4690 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4691 | <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] | 4692 | <pre>Starts master IP rotation. |
| 4693 | |
| 4694 | Args: |
| 4695 | 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] | 4696 | rotation. Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4697 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4698 | The object takes the form of: |
| 4699 | |
| 4700 | { # StartIPRotationRequest creates a new IP for the cluster and then performs |
| 4701 | # a node upgrade on each node pool to point to the new IP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4702 | "name": "A String", # The name (project, location, cluster id) of the cluster to start IP |
| 4703 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| 4704 | "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] | 4705 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4706 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4707 | "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] | 4708 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4709 | # cluster resides. This field has been deprecated and replaced by the name |
| 4710 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4711 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 4712 | # This field has been deprecated and replaced by the name field. |
| 4713 | "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4714 | } |
| 4715 | |
| 4716 | x__xgafv: string, V1 error format. |
| 4717 | Allowed values |
| 4718 | 1 - v1 error format |
| 4719 | 2 - v2 error format |
| 4720 | |
| 4721 | Returns: |
| 4722 | An object of the form: |
| 4723 | |
| 4724 | { # This operation resource represents operations that may have happened or are |
| 4725 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4726 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4727 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4728 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4729 | "code": "A String", # Machine-friendly representation of the condition |
| 4730 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4731 | }, |
| 4732 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4733 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4734 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4735 | # or |
| 4736 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4737 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4738 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 4739 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4740 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4741 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4742 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4743 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4744 | # (e.g., ERROR or DEGRADED). |
| 4745 | "code": "A String", # Machine-friendly representation of the condition |
| 4746 | "message": "A String", # Human-friendly representation of the condition |
| 4747 | }, |
| 4748 | ], |
| 4749 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4750 | "stages": [ # Substages of an operation or a stage. |
| 4751 | # Object with schema name: OperationProgress |
| 4752 | ], |
| 4753 | "status": "A String", # Status of an operation stage. |
| 4754 | # Unset for single-stage operations. |
| 4755 | "metrics": [ # Progress metric bundle, for example: |
| 4756 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4757 | # {name: "nodes total", int_value: 32}] |
| 4758 | # or |
| 4759 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4760 | # {name: "progress scale", double_value: 1.0}] |
| 4761 | { # Progress metric is (string, int|float|string) pair. |
| 4762 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4763 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4764 | "intValue": "A String", # For metrics with integer value. |
| 4765 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4766 | }, |
| 4767 | ], |
| 4768 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4769 | # Unset for single-stage operations. |
| 4770 | }, |
| 4771 | "zone": "A String", # The name of the Google Compute Engine |
| 4772 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4773 | # operation is taking place. This field is deprecated, use location instead. |
| 4774 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4775 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4776 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4777 | "detail": "A String", # Detailed operation progress, if available. |
| 4778 | "operationType": "A String", # The operation type. |
| 4779 | "status": "A String", # The current status of the operation. |
| 4780 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4781 | }</pre> |
| 4782 | </div> |
| 4783 | |
| 4784 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4785 | <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] | 4786 | <pre>Updates the settings for a specific cluster. |
| 4787 | |
| 4788 | Args: |
| 4789 | 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] | 4790 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4791 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4792 | The object takes the form of: |
| 4793 | |
| 4794 | { # UpdateClusterRequest updates the settings of a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4795 | "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] | 4796 | # number](https://support.google.com/cloud/answer/6158840). |
| 4797 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4798 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 4799 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4800 | # cluster resides. This field has been deprecated and replaced by the name |
| 4801 | # field. |
| 4802 | "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] | 4803 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4804 | "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] | 4805 | # be applied to a cluster with each request, so at most one field can be |
| 4806 | # provided. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4807 | "desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. |
| 4808 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 4809 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 4810 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 4811 | "masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. |
| 4812 | "enabled": True or False, # Whenever master is accessible globally or not. |
| 4813 | }, |
| 4814 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 4815 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 4816 | # given only RFC 1918 private addresses and communicate with the master via |
| 4817 | # private networking. |
| 4818 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 4819 | # range will be used for assigning internal IP addresses to the master or |
| 4820 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 4821 | # any other ranges in use within the cluster's network. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4822 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4823 | "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 4824 | # required by Vertical Pod Autoscaler to automatically adjust |
| 4825 | # the resources of pods controlled by it. |
| 4826 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 4827 | }, |
| 4828 | "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. |
| 4829 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 4830 | # images will be validated by Google Binauthz. |
| 4831 | }, |
| 4832 | "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 4833 | # cluster, enabling additional functionality. |
| 4834 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 4835 | # is enabled or not on the Master, it does not track whether network policy |
| 4836 | # is enabled for the nodes. |
| 4837 | # is enabled or not on the Master, it does not track whether network policy |
| 4838 | # is enabled for the nodes. |
| 4839 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 4840 | }, |
| 4841 | "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes |
| 4842 | # extension to manage hosted GCP services through the Kubernetes API |
| 4843 | "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. |
| 4844 | }, |
| 4845 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be |
| 4846 | # enabled in order to enable Cloud Run addon. This option can only be enabled |
| 4847 | # at cluster creation time. |
| 4848 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 4849 | }, |
| 4850 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 4851 | # increases or decreases the number of replica pods a replication controller |
| 4852 | # has based on the resource usage of the existing pods. |
| 4853 | # increases or decreases the number of replica pods a replication controller |
| 4854 | # has based on the resource usage of the existing pods. |
| 4855 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 4856 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 4857 | # Monitoring. |
| 4858 | }, |
| 4859 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 4860 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 4861 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 4862 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 4863 | # When enabled, it runs a small pod in the cluster that manages the load |
| 4864 | # balancers. |
| 4865 | }, |
| 4866 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 4867 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 4868 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 4869 | # workloads and applications. For more information, see: |
| 4870 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 4871 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 4872 | }, |
| 4873 | "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
| 4874 | "enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster. |
| 4875 | }, |
| 4876 | "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s |
| 4877 | # applications. |
| 4878 | "enabled": True or False, # Whether KALM is enabled for this cluster. |
| 4879 | }, |
| 4880 | "gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. This option can only be # Configuration for the Compute Engine Persistent Disk CSI driver. |
| 4881 | # enabled at cluster creation time. |
| 4882 | "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. |
| 4883 | }, |
| 4884 | "istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure |
| 4885 | # microservices. |
| 4886 | "disabled": True or False, # Whether Istio is enabled for this cluster. |
| 4887 | "auth": "A String", # The specified Istio auth mode, either none, or mutual TLS. |
| 4888 | }, |
| 4889 | }, |
| 4890 | "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an |
| 4891 | # upgrade). |
| 4892 | # |
| 4893 | # Users may specify either explicit versions offered by |
| 4894 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 4895 | # |
| 4896 | # - "latest": picks the highest valid Kubernetes version |
| 4897 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4898 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4899 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4900 | # - "-": picks the Kubernetes master version |
| 4901 | "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility. |
| 4902 | # visibility on this cluster. |
| 4903 | "enabled": True or False, # Enables intra node visibility for this cluster. |
| 4904 | }, |
| 4905 | "desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature. |
| 4906 | "enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods |
| 4907 | # must be valid under a PodSecurityPolicy to be created. |
| 4908 | }, |
| 4909 | "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4910 | # required by Cluster Autoscaler to automatically adjust |
| 4911 | # the size of the cluster and create/delete |
| 4912 | # node pools based on the current needs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4913 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 4914 | # amount of resources in the cluster. |
| 4915 | { # Contains information about amount of some resource in the cluster. |
| 4916 | # For memory, value should be in GB. |
| 4917 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 4918 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 4919 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 4920 | }, |
| 4921 | ], |
| 4922 | "autoscalingProfile": "A String", # Defines autoscaling behaviour. |
| 4923 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 4924 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4925 | # created by NAP. |
| 4926 | # by NAP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4927 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 4928 | # specified, service_account should be empty. |
| 4929 | "A String", |
| 4930 | ], |
| 4931 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 4932 | # node pool. |
| 4933 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 4934 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| 4935 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 4936 | # the Auto Upgrades will proceed. |
| 4937 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 4938 | # with the description of the upgrade. |
| 4939 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 4940 | # with the approximate start time for the upgrades, in |
| 4941 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 4942 | }, |
| 4943 | }, |
| 4944 | "minCpuPlatform": "A String", # Minimum CPU platform to be used for NAP created node pools. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4945 | # The instance may be scheduled on the specified or newer CPU platform. |
| 4946 | # Applicable values are the friendly names of CPU platforms, such as |
| 4947 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 4948 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 4949 | # information, read [how to specify min CPU |
| 4950 | # 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] | 4951 | # To unset the min cpu platform field pass "automatic" as field value. |
| 4952 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4953 | # disruption caused by an upgrade. |
| 4954 | # |
| 4955 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 4956 | # unavailable. |
| 4957 | # |
| 4958 | # maxSurge controls the number of additional nodes that can be added to the |
| 4959 | # node pool temporarily for the time of the upgrade to increase the number of |
| 4960 | # available nodes. |
| 4961 | # |
| 4962 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 4963 | # nodes are being upgraded at the same time). |
| 4964 | # |
| 4965 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 4966 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 4967 | # this holds true. (Disruption stays within the limits of |
| 4968 | # PodDisruptionBudget, if it is configured.) |
| 4969 | # |
| 4970 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 4971 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 4972 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 4973 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 4974 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4975 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4976 | # of the node pool during the upgrade process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4977 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4978 | # the upgrade process. A node is considered available if its status is |
| 4979 | # Ready. |
| 4980 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4981 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 4982 | # service_account is specified, scopes should be empty. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4983 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4984 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 4985 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4986 | # NodePool's nodes can be created by NAP. |
| 4987 | "A String", |
| 4988 | ], |
| 4989 | }, |
| 4990 | "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 4991 | "state": "A String", # Denotes the state of etcd encryption. |
| 4992 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 4993 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 4994 | }, |
| 4995 | "desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature. |
| 4996 | # master authorized networks will disallow all external traffic to access |
| 4997 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 4998 | # Google Compute Engine Public IPs and Google Prod IPs. |
| 4999 | "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access |
| 5000 | # Kubernetes master through HTTPS. |
| 5001 | { # CidrBlock contains an optional name and one CIDR block. |
| 5002 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 5003 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5004 | }, |
| 5005 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5006 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5007 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5008 | "desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration. |
| 5009 | "enabled": True or False, # Whether Cloud TPU integration is enabled or not. |
| 5010 | "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. |
| 5011 | "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. |
| 5012 | }, |
| 5013 | "desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage. |
| 5014 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 5015 | # daemonset will be created in the cluster to meter network egress traffic. |
| 5016 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 5017 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 5018 | # second BigQuery table will be created to hold resource consumption |
| 5019 | # records. |
| 5020 | }, |
| 5021 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 5022 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 5023 | }, |
| 5024 | }, |
| 5025 | "desiredLocations": [ # The desired list of Google Compute Engine |
| 5026 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5027 | # cluster's nodes should be located. Changing the locations a cluster is in |
| 5028 | # will result in nodes being either created or removed from the cluster, |
| 5029 | # depending on whether locations are being added or removed. |
| 5030 | # |
| 5031 | # This list must always include the cluster's primary zone. |
| 5032 | "A String", |
| 5033 | ], |
| 5034 | "desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5035 | # desired_node_pool_id. If there is only one pool in the |
| 5036 | # cluster and desired_node_pool_id is not provided then |
| 5037 | # the change applies to that single node pool. |
| 5038 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5039 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5040 | # max_node_count. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5041 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 5042 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 5043 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5044 | # has to enough quota to scale up the cluster. |
| 5045 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5046 | "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5047 | # Currently available options: |
| 5048 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5049 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5050 | # service with a Kubernetes-native resource model |
| 5051 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 5052 | # longer available as of GKE 1.15). |
| 5053 | # * `none` - No metrics will be exported from the cluster. |
| 5054 | # |
| 5055 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 5056 | # 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] | 5057 | "desiredImageType": "A String", # The desired image type for the node pool. |
| 5058 | # NOTE: Set the "desired_node_pool" field as well. |
| 5059 | "desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster. |
| 5060 | "type": "A String", # Type of the integration. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5061 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5062 | "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity. |
| 5063 | # policies. |
| 5064 | "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. |
| 5065 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5066 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5067 | "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if |
| 5068 | # "desired_node_version", "desired_image_family", |
| 5069 | # "desired_node_pool_autoscaling", or "desired_workload_metadata_config" |
| 5070 | # is specified and there is more than one node pool on the cluster. |
| 5071 | "desiredReleaseChannel": { # ReleaseChannel indicates which release channel a cluster is # The desired release channel configuration. |
| 5072 | # subscribed to. Release channels are arranged in order of risk and |
| 5073 | # frequency of updates. |
| 5074 | # |
| 5075 | # When a cluster is subscribed to a release channel, Google maintains |
| 5076 | # both the master version and the node version. Node auto-upgrade |
| 5077 | # defaults to true and cannot be disabled. Updates to version related |
| 5078 | # fields (e.g. current_master_version) return an error. |
| 5079 | "channel": "A String", # channel specifies which release channel the cluster is subscribed to. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5080 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5081 | "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the |
| 5082 | # latest supported version. |
| 5083 | # |
| 5084 | # Users may specify either explicit versions offered by |
| 5085 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 5086 | # |
| 5087 | # - "latest": picks the highest valid Kubernetes version |
| 5088 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 5089 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 5090 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 5091 | # - "-": picks the default Kubernetes version |
| 5092 | "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. |
| 5093 | "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] | 5094 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5095 | "desiredLoggingService": "A String", # The logging service the cluster should use to write logs. |
| 5096 | # Currently available options: |
| 5097 | # |
| 5098 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 5099 | # service with a Kubernetes-native resource model |
| 5100 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 5101 | # available as of GKE 1.15). |
| 5102 | # * `none` - no logs will be exported from the cluster. |
| 5103 | # |
| 5104 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 5105 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5106 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5107 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 5108 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5109 | } |
| 5110 | |
| 5111 | x__xgafv: string, V1 error format. |
| 5112 | Allowed values |
| 5113 | 1 - v1 error format |
| 5114 | 2 - v2 error format |
| 5115 | |
| 5116 | Returns: |
| 5117 | An object of the form: |
| 5118 | |
| 5119 | { # This operation resource represents operations that may have happened or are |
| 5120 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5121 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5122 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5123 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5124 | "code": "A String", # Machine-friendly representation of the condition |
| 5125 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5126 | }, |
| 5127 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5128 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5129 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5130 | # or |
| 5131 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5132 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5133 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5134 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5135 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5136 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5137 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5138 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5139 | # (e.g., ERROR or DEGRADED). |
| 5140 | "code": "A String", # Machine-friendly representation of the condition |
| 5141 | "message": "A String", # Human-friendly representation of the condition |
| 5142 | }, |
| 5143 | ], |
| 5144 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 5145 | "stages": [ # Substages of an operation or a stage. |
| 5146 | # Object with schema name: OperationProgress |
| 5147 | ], |
| 5148 | "status": "A String", # Status of an operation stage. |
| 5149 | # Unset for single-stage operations. |
| 5150 | "metrics": [ # Progress metric bundle, for example: |
| 5151 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5152 | # {name: "nodes total", int_value: 32}] |
| 5153 | # or |
| 5154 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5155 | # {name: "progress scale", double_value: 1.0}] |
| 5156 | { # Progress metric is (string, int|float|string) pair. |
| 5157 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5158 | "doubleValue": 3.14, # For metrics with floating point value. |
| 5159 | "intValue": "A String", # For metrics with integer value. |
| 5160 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 5161 | }, |
| 5162 | ], |
| 5163 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5164 | # Unset for single-stage operations. |
| 5165 | }, |
| 5166 | "zone": "A String", # The name of the Google Compute Engine |
| 5167 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5168 | # operation is taking place. This field is deprecated, use location instead. |
| 5169 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 5170 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5171 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 5172 | "detail": "A String", # Detailed operation progress, if available. |
| 5173 | "operationType": "A String", # The operation type. |
| 5174 | "status": "A String", # The current status of the operation. |
| 5175 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5176 | }</pre> |
| 5177 | </div> |
| 5178 | |
| 5179 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5180 | <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] | 5181 | <pre>Updates the master for a specific cluster. |
| 5182 | |
| 5183 | Args: |
| 5184 | 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] | 5185 | Specified in the format `projects/*/locations/*/clusters/*`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5186 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5187 | The object takes the form of: |
| 5188 | |
| 5189 | { # UpdateMasterRequest updates the master of the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5190 | "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] | 5191 | # number](https://support.google.com/cloud/answer/6158840). |
| 5192 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5193 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 5194 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5195 | # cluster resides. This field has been deprecated and replaced by the name |
| 5196 | # field. |
| 5197 | "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] | 5198 | # |
| 5199 | # Users may specify either explicit versions offered by |
| 5200 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 5201 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5202 | # - "latest": picks the highest valid Kubernetes version |
| 5203 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 5204 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 5205 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 5206 | # - "-": picks the default Kubernetes version |
| 5207 | "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] | 5208 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5209 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 5210 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5211 | } |
| 5212 | |
| 5213 | x__xgafv: string, V1 error format. |
| 5214 | Allowed values |
| 5215 | 1 - v1 error format |
| 5216 | 2 - v2 error format |
| 5217 | |
| 5218 | Returns: |
| 5219 | An object of the form: |
| 5220 | |
| 5221 | { # This operation resource represents operations that may have happened or are |
| 5222 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5223 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5224 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5225 | # (e.g., ERROR or DEGRADED). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5226 | "code": "A String", # Machine-friendly representation of the condition |
| 5227 | "message": "A String", # Human-friendly representation of the condition |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5228 | }, |
| 5229 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5230 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5231 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5232 | # or |
| 5233 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 5234 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5235 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 5236 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5237 | "startTime": "A String", # [Output only] The time the operation started, in |
| 5238 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 5239 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 5240 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 5241 | # (e.g., ERROR or DEGRADED). |
| 5242 | "code": "A String", # Machine-friendly representation of the condition |
| 5243 | "message": "A String", # Human-friendly representation of the condition |
| 5244 | }, |
| 5245 | ], |
| 5246 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 5247 | "stages": [ # Substages of an operation or a stage. |
| 5248 | # Object with schema name: OperationProgress |
| 5249 | ], |
| 5250 | "status": "A String", # Status of an operation stage. |
| 5251 | # Unset for single-stage operations. |
| 5252 | "metrics": [ # Progress metric bundle, for example: |
| 5253 | # metrics: [{name: "nodes done", int_value: 15}, |
| 5254 | # {name: "nodes total", int_value: 32}] |
| 5255 | # or |
| 5256 | # metrics: [{name: "progress", double_value: 0.56}, |
| 5257 | # {name: "progress scale", double_value: 1.0}] |
| 5258 | { # Progress metric is (string, int|float|string) pair. |
| 5259 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 5260 | "doubleValue": 3.14, # For metrics with floating point value. |
| 5261 | "intValue": "A String", # For metrics with integer value. |
| 5262 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 5263 | }, |
| 5264 | ], |
| 5265 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 5266 | # Unset for single-stage operations. |
| 5267 | }, |
| 5268 | "zone": "A String", # The name of the Google Compute Engine |
| 5269 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 5270 | # operation is taking place. This field is deprecated, use location instead. |
| 5271 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 5272 | "selfLink": "A String", # Server-defined URL for the resource. |
| 5273 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 5274 | "detail": "A String", # Detailed operation progress, if available. |
| 5275 | "operationType": "A String", # The operation type. |
| 5276 | "status": "A String", # The current status of the operation. |
| 5277 | "name": "A String", # The server-assigned ID for the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5278 | }</pre> |
| 5279 | </div> |
| 5280 | |
| 5281 | </body></html> |