Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -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 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.clusters.html">clusters</a></h1> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 78 | <code><a href="container_v1.projects.zones.clusters.nodePools.html">nodePools()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the nodePools Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 83 | <code><a href="#addons">addons(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Sets the addons for a specific cluster.</p> |
| 85 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#completeIpRotation">completeIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 87 | <p class="firstline">Completes master IP rotation.</p> |
| 88 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 89 | <code><a href="#create">create(projectId, zone, body=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 90 | <p class="firstline">Creates a cluster, consisting of the specified number and type of Google</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 91 | <p class="toc_element"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <code><a href="#delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 93 | <p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 94 | <p class="toc_element"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <code><a href="#get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 96 | <p class="firstline">Gets the details of a specific cluster.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 97 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 98 | <code><a href="#legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 99 | <p class="firstline">Enables or disables the ABAC authorization mechanism on a cluster.</p> |
| 100 | <p class="toc_element"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | <code><a href="#list">list(projectId, zone, parent=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 102 | <p class="firstline">Lists all clusters owned by a project in either the specified zone or all</p> |
| 103 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | <code><a href="#locations">locations(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | <p class="firstline">Sets the locations for a specific cluster.</p> |
| 106 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | <code><a href="#logging">logging(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 108 | <p class="firstline">Sets the logging service for a specific cluster.</p> |
| 109 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | <code><a href="#master">master(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | <p class="firstline">Updates the master for a specific cluster.</p> |
| 112 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 113 | <code><a href="#monitoring">monitoring(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 114 | <p class="firstline">Sets the monitoring service for a specific cluster.</p> |
| 115 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | <code><a href="#resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 117 | <p class="firstline">Sets labels on a cluster.</p> |
| 118 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 119 | <code><a href="#setMaintenancePolicy">setMaintenancePolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | <p class="firstline">Sets the maintenance policy for a cluster.</p> |
| 121 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 122 | <code><a href="#setMasterAuth">setMasterAuth(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 123 | <p class="firstline">Sets master auth materials. Currently supports changing the admin password</p> |
| 124 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 125 | <code><a href="#setNetworkPolicy">setNetworkPolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 126 | <p class="firstline">Enables or disables Network Policy for a cluster.</p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 127 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 128 | <code><a href="#startIpRotation">startIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 129 | <p class="firstline">Starts master IP rotation.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 130 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 131 | <code><a href="#update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 132 | <p class="firstline">Updates the settings of a specific cluster.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 133 | <h3>Method Details</h3> |
| 134 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 135 | <code class="details" id="addons">addons(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | <pre>Sets the addons for a specific cluster. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 137 | |
| 138 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 139 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 140 | number](https://support.google.com/cloud/answer/6158840). |
| 141 | This field has been deprecated and replaced by the name field. (required) |
| 142 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 143 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 144 | cluster resides. This field has been deprecated and replaced by the name |
| 145 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 147 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 148 | body: object, The request body. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 149 | The object takes the form of: |
| 150 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | { # SetAddonsConfigRequest sets the addons associated with the cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "name": "A String", # The name (project, location, cluster) of the cluster to set addons. |
| 153 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 154 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 155 | # number](https://support.google.com/cloud/answer/6158840). |
| 156 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 158 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 159 | # cluster resides. This field has been deprecated and replaced by the name |
| 160 | # field. |
| 161 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 162 | # This field has been deprecated and replaced by the name field. |
| 163 | "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] | 164 | # cluster. |
| 165 | # cluster, enabling additional functionality. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 167 | # is enabled or not on the Master, it does not track whether network policy |
| 168 | # is enabled for the nodes. |
| 169 | # is enabled or not on the Master, it does not track whether network policy |
| 170 | # is enabled for the nodes. |
| 171 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 172 | }, |
| 173 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 174 | # managed Knative service. |
| 175 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 176 | }, |
| 177 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 178 | # increases or decreases the number of replica pods a replication controller |
| 179 | # has based on the resource usage of the existing pods. |
| 180 | # increases or decreases the number of replica pods a replication controller |
| 181 | # has based on the resource usage of the existing pods. |
| 182 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 183 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 184 | # Monitoring. |
| 185 | }, |
| 186 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 187 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 188 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 189 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 190 | # When enabled, it runs a small pod in the cluster that manages the load |
| 191 | # balancers. |
| 192 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 194 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 195 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 196 | # workloads and applications. For more information, see: |
| 197 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 198 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 199 | }, |
| 200 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | x__xgafv: string, V1 error format. |
| 204 | Allowed values |
| 205 | 1 - v1 error format |
| 206 | 2 - v2 error format |
| 207 | |
| 208 | Returns: |
| 209 | An object of the form: |
| 210 | |
| 211 | { # This operation resource represents operations that may have happened or are |
| 212 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 213 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 214 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 215 | # (e.g., ERROR or DEGRADED). |
| 216 | "code": "A String", # Machine-friendly representation of the condition |
| 217 | "message": "A String", # Human-friendly representation of the condition |
| 218 | }, |
| 219 | ], |
| 220 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 221 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 222 | # Unset for single-stage operations. |
| 223 | "stages": [ # Substages of an operation or a stage. |
| 224 | # Object with schema name: OperationProgress |
| 225 | ], |
| 226 | "metrics": [ # Progress metric bundle, for example: |
| 227 | # metrics: [{name: "nodes done", int_value: 15}, |
| 228 | # {name: "nodes total", int_value: 32}] |
| 229 | # or |
| 230 | # metrics: [{name: "progress", double_value: 0.56}, |
| 231 | # {name: "progress scale", double_value: 1.0}] |
| 232 | { # Progress metric is (string, int|float|string) pair. |
| 233 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 234 | "doubleValue": 3.14, # For metrics with floating point value. |
| 235 | "intValue": "A String", # For metrics with integer value. |
| 236 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 237 | }, |
| 238 | ], |
| 239 | "status": "A String", # Status of an operation stage. |
| 240 | # Unset for single-stage operations. |
| 241 | }, |
| 242 | "zone": "A String", # The name of the Google Compute Engine |
| 243 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 244 | # operation is taking place. This field is deprecated, use location instead. |
| 245 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 246 | "selfLink": "A String", # Server-defined URL for the resource. |
| 247 | "detail": "A String", # Detailed operation progress, if available. |
| 248 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 249 | "operationType": "A String", # The operation type. |
| 250 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | "name": "A String", # The server-assigned ID for the operation. |
| 252 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 253 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 254 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 255 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 256 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 257 | }, |
| 258 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 259 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 260 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "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] | 262 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 263 | # or |
| 264 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 265 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | "startTime": "A String", # [Output only] The time the operation started, in |
| 267 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 268 | }</pre> |
| 269 | </div> |
| 270 | |
| 271 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 272 | <code class="details" id="completeIpRotation">completeIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 273 | <pre>Completes master IP rotation. |
| 274 | |
| 275 | Args: |
| 276 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 277 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 278 | This field has been deprecated and replaced by the name field. (required) |
| 279 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 280 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 281 | cluster resides. This field has been deprecated and replaced by the name |
| 282 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 283 | clusterId: string, Deprecated. The name of the cluster. |
| 284 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 285 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 286 | The object takes the form of: |
| 287 | |
| 288 | { # CompleteIPRotationRequest moves the cluster master back into single-IP mode. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 289 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 290 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 291 | "name": "A String", # The name (project, location, cluster id) of the cluster to complete IP |
| 292 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
| 293 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 294 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 295 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 296 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 297 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 298 | # cluster resides. This field has been deprecated and replaced by the name |
| 299 | # field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | x__xgafv: string, V1 error format. |
| 303 | Allowed values |
| 304 | 1 - v1 error format |
| 305 | 2 - v2 error format |
| 306 | |
| 307 | Returns: |
| 308 | An object of the form: |
| 309 | |
| 310 | { # This operation resource represents operations that may have happened or are |
| 311 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 312 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 313 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 314 | # (e.g., ERROR or DEGRADED). |
| 315 | "code": "A String", # Machine-friendly representation of the condition |
| 316 | "message": "A String", # Human-friendly representation of the condition |
| 317 | }, |
| 318 | ], |
| 319 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 320 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 321 | # Unset for single-stage operations. |
| 322 | "stages": [ # Substages of an operation or a stage. |
| 323 | # Object with schema name: OperationProgress |
| 324 | ], |
| 325 | "metrics": [ # Progress metric bundle, for example: |
| 326 | # metrics: [{name: "nodes done", int_value: 15}, |
| 327 | # {name: "nodes total", int_value: 32}] |
| 328 | # or |
| 329 | # metrics: [{name: "progress", double_value: 0.56}, |
| 330 | # {name: "progress scale", double_value: 1.0}] |
| 331 | { # Progress metric is (string, int|float|string) pair. |
| 332 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 333 | "doubleValue": 3.14, # For metrics with floating point value. |
| 334 | "intValue": "A String", # For metrics with integer value. |
| 335 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 336 | }, |
| 337 | ], |
| 338 | "status": "A String", # Status of an operation stage. |
| 339 | # Unset for single-stage operations. |
| 340 | }, |
| 341 | "zone": "A String", # The name of the Google Compute Engine |
| 342 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 343 | # operation is taking place. This field is deprecated, use location instead. |
| 344 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 345 | "selfLink": "A String", # Server-defined URL for the resource. |
| 346 | "detail": "A String", # Detailed operation progress, if available. |
| 347 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 348 | "operationType": "A String", # The operation type. |
| 349 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 350 | "name": "A String", # The server-assigned ID for the operation. |
| 351 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 352 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 353 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 355 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 356 | }, |
| 357 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 359 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | "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] | 361 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 362 | # or |
| 363 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 364 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | "startTime": "A String", # [Output only] The time the operation started, in |
| 366 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 367 | }</pre> |
| 368 | </div> |
| 369 | |
| 370 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 371 | <code class="details" id="create">create(projectId, zone, body=None, x__xgafv=None)</code> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 372 | <pre>Creates a cluster, consisting of the specified number and type of Google |
| 373 | Compute Engine instances. |
| 374 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | By default, the cluster is created in the project's |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 376 | [default |
| 377 | network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 378 | |
| 379 | One firewall is added for the cluster. After cluster creation, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 380 | the Kubelet creates routes for each node to allow the containers |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 381 | on that node to communicate with all other instances in the |
| 382 | cluster. |
| 383 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | 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] | 385 | which CIDR range the cluster is using. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 386 | |
| 387 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 388 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 389 | number](https://support.google.com/cloud/answer/6158840). |
| 390 | This field has been deprecated and replaced by the parent field. (required) |
| 391 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 392 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 393 | cluster resides. This field has been deprecated and replaced by the parent |
| 394 | field. (required) |
| 395 | body: object, The request body. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 396 | The object takes the form of: |
| 397 | |
| 398 | { # CreateClusterRequest creates a cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 399 | "parent": "A String", # The parent (project and location) where the cluster will be created. |
| 400 | # Specified in the format `projects/*/locations/*`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 402 | # resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 403 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 404 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 405 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 406 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 407 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 408 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 409 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 410 | # required by Cluster Autoscaler to automatically adjust |
| 411 | # the size of the cluster and create/delete |
| 412 | # node pools based on the current needs. |
| 413 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 414 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 415 | # NodePool's nodes can be created by NAP. |
| 416 | "A String", |
| 417 | ], |
| 418 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 419 | # amount of resources in the cluster. |
| 420 | { # Contains information about amount of some resource in the cluster. |
| 421 | # For memory, value should be in GB. |
| 422 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 423 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 424 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 425 | }, |
| 426 | ], |
| 427 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 428 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 429 | # created by NAP. |
| 430 | # by NAP. |
| 431 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 432 | # node pool. |
| 433 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 434 | # the Auto Upgrades will proceed. |
| 435 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 436 | # with the approximate start time for the upgrades, in |
| 437 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 438 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 439 | # with the description of the upgrade. |
| 440 | }, |
| 441 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 442 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 443 | # they fail health checks too many times, an automatic repair action will be |
| 444 | # triggered. |
| 445 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 446 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 447 | # up to date with the latest release version of Kubernetes. |
| 448 | }, |
| 449 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 450 | # specified, service_account should be empty. |
| 451 | "A String", |
| 452 | ], |
| 453 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 454 | # disruption caused by an upgrade. |
| 455 | # |
| 456 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 457 | # unavailable. |
| 458 | # |
| 459 | # maxSurge controls the number of additional nodes that can be added to the |
| 460 | # node pool temporarily for the time of the upgrade to increase the number of |
| 461 | # available nodes. |
| 462 | # |
| 463 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 464 | # nodes are being upgraded at the same time). |
| 465 | # |
| 466 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 467 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 468 | # this holds true. (Disruption stays within the limits of |
| 469 | # PodDisruptionBudget, if it is configured.) |
| 470 | # |
| 471 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 472 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 473 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 474 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 475 | # there are always at least 4 nodes available. |
| 476 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 477 | # the upgrade process. A node is considered available if its status is |
| 478 | # Ready. |
| 479 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 480 | # of the node pool during the upgrade process. |
| 481 | }, |
| 482 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 483 | # service_account is specified, scopes should be empty. |
| 484 | }, |
| 485 | }, |
| 486 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 487 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 488 | # is sufficient for this number of instances. You must also have available |
| 489 | # firewall and routes quota. |
| 490 | # For requests, this field should only be used in lieu of a |
| 491 | # "node_pool" object, since this configuration (along with the |
| 492 | # "node_config") will be used to create a "NodePool" object with an |
| 493 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 494 | # |
| 495 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 496 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 497 | "A String", |
| 498 | ], |
| 499 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 500 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 501 | # range will be used for assigning internal IP addresses to the master or |
| 502 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 503 | # any other ranges in use within the cluster's network. |
| 504 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 505 | # given only RFC 1918 private addresses and communicate with the master via |
| 506 | # private networking. |
| 507 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 508 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 509 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 510 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 511 | }, |
| 512 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 513 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 514 | }, |
| 515 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 516 | # required by Vertical Pod Autoscaler to automatically adjust |
| 517 | # the resources of pods controlled by it. |
| 518 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 519 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 521 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 522 | # if cluster created with IP Alias support. |
| 523 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 524 | }, |
| 525 | "network": "A String", # The name of the Google Compute Engine |
| 526 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 527 | # to which the cluster is connected. If left unspecified, the `default` |
| 528 | # network will be used. |
| 529 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 530 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 531 | # containers. This is provisioned from within the `container_ipv4_cidr` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 532 | # range. This field will only be set when cluster is in route-based network |
| 533 | # mode. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 534 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 535 | # master authorized networks will disallow all external traffic to access |
| 536 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 537 | # Google Compute Engine Public IPs and Google Prod IPs. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 538 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 539 | # Kubernetes master through HTTPS. |
| 540 | { # CidrBlock contains an optional name and one CIDR block. |
| 541 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 542 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 543 | }, |
| 544 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 545 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 546 | }, |
| 547 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 548 | # cluster, if available. |
| 549 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 550 | # If unspecified, the defaults are used: |
| 551 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 552 | # be set to "admin", a random password will be generated, and a client |
| 553 | # certificate will be issued. |
| 554 | # Authentication can be done using HTTP basic auth or using client |
| 555 | # certificates. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 556 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 557 | # Because the master endpoint is open to the Internet, you should create a |
| 558 | # strong password. If a password is provided for cluster creation, username |
| 559 | # must be non-empty. |
| 560 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 561 | # clusters before v1.12, if no configuration is specified, a client |
| 562 | # certificate is issued. |
| 563 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 564 | }, |
| 565 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 566 | # to the cluster endpoint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 567 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 568 | # trust for the cluster. |
| 569 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 570 | # authenticate to the cluster endpoint. |
| 571 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 572 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 573 | # leaving username unspecified (or setting it to the empty string). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | }, |
| 575 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 576 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 577 | # during authentication using a group of security groups. |
| 578 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 579 | # if enabled = true. |
| 580 | }, |
| 581 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 582 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 583 | # cluster, enabling additional functionality. |
| 584 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 585 | # is enabled or not on the Master, it does not track whether network policy |
| 586 | # is enabled for the nodes. |
| 587 | # is enabled or not on the Master, it does not track whether network policy |
| 588 | # is enabled for the nodes. |
| 589 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 590 | }, |
| 591 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 592 | # managed Knative service. |
| 593 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 594 | }, |
| 595 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 596 | # increases or decreases the number of replica pods a replication controller |
| 597 | # has based on the resource usage of the existing pods. |
| 598 | # increases or decreases the number of replica pods a replication controller |
| 599 | # has based on the resource usage of the existing pods. |
| 600 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 601 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 602 | # Monitoring. |
| 603 | }, |
| 604 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 605 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 606 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 607 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 608 | # When enabled, it runs a small pod in the cluster that manages the load |
| 609 | # balancers. |
| 610 | }, |
| 611 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 612 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 613 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 614 | # workloads and applications. For more information, see: |
| 615 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 616 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 617 | }, |
| 618 | }, |
| 619 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 620 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 621 | # instead. The current version of the node software components. If they are |
| 622 | # currently at multiple versions because they're in the process of being |
| 623 | # upgraded, this reflects the minimum version of all nodes. |
| 624 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 625 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 626 | # the cluster is connected. |
| 627 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 628 | # Google Compute Engine resources. |
| 629 | "a_key": "A String", |
| 630 | }, |
| 631 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 632 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 633 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 634 | # occur in these windows. |
| 635 | "a_key": { # Represents an arbitrary window of time. |
| 636 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 637 | # start time. |
| 638 | "startTime": "A String", # The time that the window first starts. |
| 639 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 640 | }, |
| 641 | "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] | 642 | # maintenance to occur. The time windows may be overlapping. If no |
| 643 | # maintenance windows are set, maintenance can occur at any time. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 644 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 645 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 646 | # start time. |
| 647 | "startTime": "A String", # The time that the window first starts. |
| 648 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 649 | "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] | 650 | # this window reccurs. They go on for the span of time between the start and |
| 651 | # end time. |
| 652 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 653 | # For example, to have something repeat every weekday, you'd use: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 654 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 655 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 656 | # <code>FREQ=DAILY</code> |
| 657 | # For the first weekend of every month: |
| 658 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 659 | # 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] | 660 | # 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] | 661 | # <code> |
| 662 | # start time = 2019-01-01T09:00:00-0400 |
| 663 | # end time = 2019-01-01T17:00:00-0400 |
| 664 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 665 | # </code> |
| 666 | # Windows can span multiple days. Eg, to make the window encompass every |
| 667 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 668 | # <code> |
| 669 | # start time = 2019-01-05T00:00:00Z |
| 670 | # end time = 2019-01-07T23:59:00Z |
| 671 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 672 | # </code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 673 | # 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] | 674 | # to specify duration of the window and when it first starts. |
| 675 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 676 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 677 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 678 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 679 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 680 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 681 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 682 | # smallest possible in the given scenario. |
| 683 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 684 | # format "PTnHnMnS". |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 685 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 686 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 687 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 688 | # the policy won't accidentally undo intermediate changes (and so that users |
| 689 | # of the API unaware of some fields won't accidentally remove other fields). |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 690 | # Make a <code>get()</code> request to the cluster to get the current |
| 691 | # resource version and include it with requests to set the policy. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 692 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 693 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 694 | # found in validMasterVersions returned by getServerConfig. The version can |
| 695 | # be upgraded over time; such upgrades are reflected in |
| 696 | # currentMasterVersion and currentNodeVersion. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 697 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 698 | # Users may specify either explicit versions offered by |
| 699 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 700 | # |
| 701 | # - "latest": picks the highest valid Kubernetes version |
| 702 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 703 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 704 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 705 | # - "","-": picks the default Kubernetes version |
| 706 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 708 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 709 | # block. The secondary range will be used for pod IP |
| 710 | # addresses. This must be an existing secondary range associated |
| 711 | # with the cluster subnetwork. |
| 712 | # |
| 713 | # This field is only applicable with use_ip_aliases is true and |
| 714 | # create_subnetwork is false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 715 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 716 | # `cluster.cluster_ipv4_cidr` must be left blank. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 717 | # |
| 718 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 719 | # |
| 720 | # Set to blank to have a range chosen with the default size. |
| 721 | # |
| 722 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 723 | # netmask. |
| 724 | # |
| 725 | # Set to a |
| 726 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 727 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 728 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 729 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | "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] | 731 | # |
| 732 | # This is applicable only if `create_subnetwork` is true. |
| 733 | # |
| 734 | # Set to blank to have a range chosen with the default size. |
| 735 | # |
| 736 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 737 | # netmask. |
| 738 | # |
| 739 | # Set to a |
| 740 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 741 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 742 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 743 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 744 | "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] | 745 | # range will be automatically chosen with the default size. |
| 746 | # |
| 747 | # This field is only applicable when `use_ip_aliases` is true. |
| 748 | # |
| 749 | # If unspecified, the range will use the default size. |
| 750 | # |
| 751 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 752 | # netmask. |
| 753 | # |
| 754 | # Set to a |
| 755 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 756 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 757 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 758 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 759 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 760 | "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] | 761 | # CIDR block. The secondary range will be used for service |
| 762 | # ClusterIPs. This must be an existing secondary range associated |
| 763 | # with the cluster subnetwork. |
| 764 | # |
| 765 | # This field is only applicable with use_ip_aliases is true and |
| 766 | # create_subnetwork is false. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 767 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 768 | # |
| 769 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 770 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 771 | # this field is empty, then an automatic name will be chosen for the new |
| 772 | # subnetwork. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 773 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 774 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 775 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 776 | # will be automatically chosen with the default size. |
| 777 | # |
| 778 | # This field is only applicable when `use_ip_aliases` is true. |
| 779 | # |
| 780 | # Set to blank to have a range chosen with the default size. |
| 781 | # |
| 782 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 783 | # netmask. |
| 784 | # |
| 785 | # Set to a |
| 786 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 787 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 788 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 789 | # to use. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 790 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 791 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 792 | # mode. |
| 793 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 794 | # identities in the system, including service accounts, nodes, and |
| 795 | # controllers, will have statically granted permissions beyond those |
| 796 | # provided by the RBAC configuration or IAM. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 797 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 798 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 799 | # disabled when this config is unspecified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 800 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 801 | # daemonset will be created in the cluster to meter network egress traffic. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 802 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 803 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 804 | # second BigQuery table will be created to hold resource consumption |
| 805 | # records. |
| 806 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 807 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 808 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
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 | }, |
| 811 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 812 | "locations": [ # The list of Google Compute Engine |
| 813 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 814 | # cluster's nodes should be located. |
| 815 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 816 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 817 | "nodePools": [ # The node pools associated with this cluster. |
| 818 | # This field should not be set if "node_config" or "initial_node_count" are |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 819 | # specified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 820 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 821 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 822 | # specification, under the control of the cluster master. They may have a set |
| 823 | # of Kubernetes labels applied to them, which may be used to reference them |
| 824 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 825 | # the workload. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 826 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 827 | # node pool instance, if available. |
| 828 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 829 | # only if a valid configuration is present. |
| 830 | # adjust the size of the node pool to the current cluster usage. |
| 831 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 832 | # has to enough quota to scale up the cluster. |
| 833 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 834 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 835 | # max_node_count. |
| 836 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 837 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 838 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 839 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 840 | # is sufficient for this number of instances. You must also have available |
| 841 | # firewall and routes quota. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 842 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 843 | "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] | 844 | # disruption caused by an upgrade. |
| 845 | # |
| 846 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 847 | # unavailable. |
| 848 | # |
| 849 | # maxSurge controls the number of additional nodes that can be added to the |
| 850 | # node pool temporarily for the time of the upgrade to increase the number of |
| 851 | # available nodes. |
| 852 | # |
| 853 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 854 | # nodes are being upgraded at the same time). |
| 855 | # |
| 856 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 857 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 858 | # this holds true. (Disruption stays within the limits of |
| 859 | # PodDisruptionBudget, if it is configured.) |
| 860 | # |
| 861 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 862 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 863 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 864 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 865 | # there are always at least 4 nodes available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 866 | "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] | 867 | # the upgrade process. A node is considered available if its status is |
| 868 | # Ready. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 869 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 870 | # of the node pool during the upgrade process. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 871 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 872 | "locations": [ # The list of Google Compute Engine |
| 873 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 874 | # NodePool's nodes should be located. |
| 875 | "A String", |
| 876 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 877 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 878 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 879 | # associated with this node pool. |
| 880 | "A String", |
| 881 | ], |
| 882 | "version": "A String", # The version of the Kubernetes of this node. |
| 883 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 884 | "conditions": [ # Which conditions caused the current node pool state. |
| 885 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 886 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 887 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 888 | "message": "A String", # Human-friendly representation of the condition |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 889 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 890 | ], |
| 891 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 892 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 893 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 894 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 895 | # |
| 896 | # The following scopes are recommended, but not required, and by default are |
| 897 | # not included: |
| 898 | # |
| 899 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 900 | # persistent storage on your nodes. |
| 901 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 902 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 903 | # (the [Google Container |
| 904 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 905 | # |
| 906 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 907 | # 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] | 908 | "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 909 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 911 | # |
| 912 | # For more information, including usage and the valid values, see: |
| 913 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 914 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 915 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 916 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 917 | # See |
| 918 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 919 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 920 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 921 | "value": "A String", # Value for taint. |
| 922 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 923 | }, |
| 924 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 925 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 926 | # These will added in addition to any default label(s) that |
| 927 | # Kubernetes may apply to the node. |
| 928 | # In case of conflict in label keys, the applied set may differ depending on |
| 929 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 930 | # and conflicts should be avoided. |
| 931 | # For more information, including usage and the valid values, see: |
| 932 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 933 | "a_key": "A String", |
| 934 | }, |
| 935 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 936 | # The smallest allowed disk size is 10GB. |
| 937 | # |
| 938 | # If unspecified, the default disk size is 100GB. |
| 939 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 940 | # workloads on the node pool. |
| 941 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 942 | # on the node pool. |
| 943 | }, |
| 944 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 945 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 946 | # support for GPUs. |
| 947 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 948 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 949 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 950 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 951 | }, |
| 952 | ], |
| 953 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 954 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 955 | # `n1-standard-1`). |
| 956 | # |
| 957 | # If unspecified, the default machine type is |
| 958 | # `n1-standard-1`. |
| 959 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 960 | # |
| 961 | # If unspecified, the default disk type is 'pd-standard' |
| 962 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 963 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 964 | # |
| 965 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 966 | # The attestation is performed against the integrity policy baseline. This |
| 967 | # baseline is initially derived from the implicitly trusted boot image when |
| 968 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 969 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 970 | # |
| 971 | # Secure Boot helps ensure that the system only runs authentic software by |
| 972 | # verifying the digital signature of all boot components, and halting the |
| 973 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 974 | }, |
| 975 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 976 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 977 | # friendly names of CPU platforms, such as |
| 978 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 979 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 980 | # information, read [how to specify min CPU |
| 981 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 982 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 983 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 984 | # information about preemptible VM instances. |
| 985 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 986 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 987 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 988 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 989 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 990 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 991 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 992 | "type": "A String", # Type of the sandbox to use for the node. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 993 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 994 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 995 | # |
| 996 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 997 | # in length. These are reflected as part of a URL in the metadata server. |
| 998 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 999 | # metadata keys for the project or be one of the reserved keys: |
| 1000 | # "cluster-location" |
| 1001 | # "cluster-name" |
| 1002 | # "cluster-uid" |
| 1003 | # "configure-sh" |
| 1004 | # "containerd-configure-sh" |
| 1005 | # "enable-os-login" |
| 1006 | # "gci-ensure-gke-docker" |
| 1007 | # "gci-metrics-enabled" |
| 1008 | # "gci-update-strategy" |
| 1009 | # "instance-template" |
| 1010 | # "kube-env" |
| 1011 | # "startup-script" |
| 1012 | # "user-data" |
| 1013 | # "disable-address-manager" |
| 1014 | # "windows-startup-script-ps1" |
| 1015 | # "common-psm1" |
| 1016 | # "k8s-node-setup-psm1" |
| 1017 | # "install-ssh-psm1" |
| 1018 | # "user-profile-psm1" |
| 1019 | # "serial-port-logging-enable" |
| 1020 | # |
| 1021 | # Values are free-form strings, and only have meaning as interpreted by |
| 1022 | # the image running in the instance. The only restriction placed on them is |
| 1023 | # that each value's size must be less than or equal to 32 KB. |
| 1024 | # |
| 1025 | # The total size of all keys and values must be less than 512 KB. |
| 1026 | "a_key": "A String", |
| 1027 | }, |
| 1028 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1029 | # the specified [Zonal Compute |
| 1030 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1031 | # to this node pool. |
| 1032 | # is the configuration of desired reservation which instances could take |
| 1033 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1034 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1035 | "A String", |
| 1036 | ], |
| 1037 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1038 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1039 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1040 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1041 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1042 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 1043 | # valid sources or targets for network firewalls and are specified by |
| 1044 | # the client during cluster or node pool creation. Each tag within the list |
| 1045 | # must comply with RFC1035. |
| 1046 | "A String", |
| 1047 | ], |
| 1048 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 1049 | # Specify the email address of the Service Account; otherwise, if no Service |
| 1050 | # Account is specified, the "default" service account is used. |
| 1051 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1052 | # the latest version of it will be used. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1053 | }, |
| 1054 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 1055 | # simultaneously on a node in the node pool. |
| 1056 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1057 | }, |
| 1058 | "name": "A String", # The name of the node pool. |
| 1059 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 1060 | # node pool. |
| 1061 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1062 | # the Auto Upgrades will proceed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1063 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1064 | # with the approximate start time for the upgrades, in |
| 1065 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1066 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1067 | # with the description of the upgrade. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1068 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1069 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 1070 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 1071 | # they fail health checks too many times, an automatic repair action will be |
| 1072 | # triggered. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1073 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 1074 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 1075 | # up to date with the latest release version of Kubernetes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1076 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1077 | }, |
| 1078 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1079 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1080 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 1081 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 1082 | "provider": "A String", # The selected network policy provider. |
| 1083 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 1084 | }, |
| 1085 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 1086 | # this cluster, in |
| 1087 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1088 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 1089 | # typically put in the last `/16` from the container CIDR. |
| 1090 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 1091 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 1092 | # the kubernetes version of the master and nodes. |
| 1093 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 1094 | # Alpha enabled clusters are automatically deleted thirty days after |
| 1095 | # creation. |
| 1096 | "description": "A String", # An optional description of this cluster. |
| 1097 | "conditions": [ # Which conditions caused the current cluster state. |
| 1098 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1099 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1100 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1101 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1102 | }, |
| 1103 | ], |
| 1104 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 1105 | # Call Kubernetes API directly to retrieve node information. |
| 1106 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1107 | # Currently available options: |
| 1108 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1109 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1110 | # service with a Kubernetes-native resource model |
| 1111 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 1112 | # longer available as of GKE 1.15). |
| 1113 | # * `none` - No metrics will be exported from the cluster. |
| 1114 | # |
| 1115 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 1116 | # 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] | 1117 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 1118 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 1119 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 1120 | "state": "A String", # Denotes the state of etcd encryption. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1121 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1122 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 1123 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 1124 | # images will be validated by Binary Authorization. |
| 1125 | }, |
| 1126 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 1127 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1128 | # notation (e.g. `1.2.3.4/29`). |
| 1129 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 1130 | # policies. |
| 1131 | # policies. |
| 1132 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 1133 | }, |
| 1134 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 1135 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1136 | # cluster resides. This field is deprecated, use location instead. |
| 1137 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 1138 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1139 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1140 | # Currently available options: |
| 1141 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1142 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 1143 | # service with a Kubernetes-native resource model |
| 1144 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 1145 | # available as of GKE 1.15). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1146 | # * `none` - no logs will be exported from the cluster. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1147 | # |
| 1148 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 1149 | # 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] | 1150 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1151 | # 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] | 1152 | # "node_pool" object, since this configuration (along with the |
| 1153 | # "initial_node_count") will be used to create a "NodePool" object with an |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1154 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1155 | # For responses, this field will be populated with the node configuration of |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1156 | # the first node pool. (For configuration of each node pool, see |
| 1157 | # `node_pool.config`) |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1158 | # |
| 1159 | # If unspecified, the defaults are used. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1160 | # This field is deprecated, use node_pool.config instead. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1161 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1162 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1163 | # |
| 1164 | # The following scopes are recommended, but not required, and by default are |
| 1165 | # not included: |
| 1166 | # |
| 1167 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1168 | # persistent storage on your nodes. |
| 1169 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1170 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1171 | # (the [Google Container |
| 1172 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1173 | # |
| 1174 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1175 | # 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] | 1176 | "A String", |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1177 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1178 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1179 | # |
| 1180 | # For more information, including usage and the valid values, see: |
| 1181 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1182 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1183 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1184 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1185 | # See |
| 1186 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1187 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1188 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1189 | "value": "A String", # Value for taint. |
| 1190 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1191 | }, |
| 1192 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1193 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1194 | # These will added in addition to any default label(s) that |
| 1195 | # Kubernetes may apply to the node. |
| 1196 | # In case of conflict in label keys, the applied set may differ depending on |
| 1197 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1198 | # and conflicts should be avoided. |
| 1199 | # For more information, including usage and the valid values, see: |
| 1200 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1201 | "a_key": "A String", |
| 1202 | }, |
| 1203 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1204 | # The smallest allowed disk size is 10GB. |
| 1205 | # |
| 1206 | # If unspecified, the default disk size is 100GB. |
| 1207 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1208 | # workloads on the node pool. |
| 1209 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1210 | # on the node pool. |
| 1211 | }, |
| 1212 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1213 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1214 | # support for GPUs. |
| 1215 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1216 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1217 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1218 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1219 | }, |
| 1220 | ], |
| 1221 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1222 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1223 | # `n1-standard-1`). |
| 1224 | # |
| 1225 | # If unspecified, the default machine type is |
| 1226 | # `n1-standard-1`. |
| 1227 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 1228 | # |
| 1229 | # If unspecified, the default disk type is 'pd-standard' |
| 1230 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1231 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1232 | # |
| 1233 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1234 | # The attestation is performed against the integrity policy baseline. This |
| 1235 | # baseline is initially derived from the implicitly trusted boot image when |
| 1236 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1237 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1238 | # |
| 1239 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1240 | # verifying the digital signature of all boot components, and halting the |
| 1241 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1242 | }, |
| 1243 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1244 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1245 | # friendly names of CPU platforms, such as |
| 1246 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1247 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1248 | # information, read [how to specify min CPU |
| 1249 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1250 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1251 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1252 | # information about preemptible VM instances. |
| 1253 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1254 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1255 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1256 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1257 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1258 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1259 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1260 | "type": "A String", # Type of the sandbox to use for the node. |
| 1261 | }, |
| 1262 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1263 | # |
| 1264 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1265 | # in length. These are reflected as part of a URL in the metadata server. |
| 1266 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1267 | # metadata keys for the project or be one of the reserved keys: |
| 1268 | # "cluster-location" |
| 1269 | # "cluster-name" |
| 1270 | # "cluster-uid" |
| 1271 | # "configure-sh" |
| 1272 | # "containerd-configure-sh" |
| 1273 | # "enable-os-login" |
| 1274 | # "gci-ensure-gke-docker" |
| 1275 | # "gci-metrics-enabled" |
| 1276 | # "gci-update-strategy" |
| 1277 | # "instance-template" |
| 1278 | # "kube-env" |
| 1279 | # "startup-script" |
| 1280 | # "user-data" |
| 1281 | # "disable-address-manager" |
| 1282 | # "windows-startup-script-ps1" |
| 1283 | # "common-psm1" |
| 1284 | # "k8s-node-setup-psm1" |
| 1285 | # "install-ssh-psm1" |
| 1286 | # "user-profile-psm1" |
| 1287 | # "serial-port-logging-enable" |
| 1288 | # |
| 1289 | # Values are free-form strings, and only have meaning as interpreted by |
| 1290 | # the image running in the instance. The only restriction placed on them is |
| 1291 | # that each value's size must be less than or equal to 32 KB. |
| 1292 | # |
| 1293 | # The total size of all keys and values must be less than 512 KB. |
| 1294 | "a_key": "A String", |
| 1295 | }, |
| 1296 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1297 | # the specified [Zonal Compute |
| 1298 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1299 | # to this node pool. |
| 1300 | # is the configuration of desired reservation which instances could take |
| 1301 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1302 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1303 | "A String", |
| 1304 | ], |
| 1305 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1306 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1307 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1308 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1309 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1310 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 1311 | # valid sources or targets for network firewalls and are specified by |
| 1312 | # the client during cluster or node pool creation. Each tag within the list |
| 1313 | # must comply with RFC1035. |
| 1314 | "A String", |
| 1315 | ], |
| 1316 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 1317 | # Specify the email address of the Service Account; otherwise, if no Service |
| 1318 | # Account is specified, the "default" service account is used. |
| 1319 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1320 | # the latest version of it will be used. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1321 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1322 | "status": "A String", # [Output only] The current status of this cluster. |
| 1323 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1324 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 1325 | # This makes same node pod to pod traffic visible for VPC network. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1326 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 1327 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 1328 | # cluster is connected. Example: |
| 1329 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 1330 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 1331 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1332 | # to which the cluster is connected. Example: |
| 1333 | # projects/my-project/global/networks/my-network |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1334 | }, |
| 1335 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 1336 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 1337 | # the following restrictions: |
| 1338 | # |
| 1339 | # * Lowercase letters, numbers, and hyphens only. |
| 1340 | # * Must start with a letter. |
| 1341 | # * Must end with a number or a letter. |
| 1342 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 1343 | # The endpoint can be accessed from the internet at |
| 1344 | # `https://username:password@endpoint/`. |
| 1345 | # |
| 1346 | # See the `masterAuth` property of this resource for username and |
| 1347 | # password information. |
| 1348 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1349 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1350 | # or |
| 1351 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1352 | # in which the cluster resides. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1353 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1354 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 1355 | # number](https://support.google.com/cloud/answer/6158840). |
| 1356 | # This field has been deprecated and replaced by the parent field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1357 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 1358 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1359 | # cluster resides. This field has been deprecated and replaced by the parent |
| 1360 | # field. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1361 | } |
| 1362 | |
| 1363 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1364 | Allowed values |
| 1365 | 1 - v1 error format |
| 1366 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1367 | |
| 1368 | Returns: |
| 1369 | An object of the form: |
| 1370 | |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1371 | { # This operation resource represents operations that may have happened or are |
| 1372 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1373 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1374 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1375 | # (e.g., ERROR or DEGRADED). |
| 1376 | "code": "A String", # Machine-friendly representation of the condition |
| 1377 | "message": "A String", # Human-friendly representation of the condition |
| 1378 | }, |
| 1379 | ], |
| 1380 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1381 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1382 | # Unset for single-stage operations. |
| 1383 | "stages": [ # Substages of an operation or a stage. |
| 1384 | # Object with schema name: OperationProgress |
| 1385 | ], |
| 1386 | "metrics": [ # Progress metric bundle, for example: |
| 1387 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1388 | # {name: "nodes total", int_value: 32}] |
| 1389 | # or |
| 1390 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1391 | # {name: "progress scale", double_value: 1.0}] |
| 1392 | { # Progress metric is (string, int|float|string) pair. |
| 1393 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1394 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1395 | "intValue": "A String", # For metrics with integer value. |
| 1396 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1397 | }, |
| 1398 | ], |
| 1399 | "status": "A String", # Status of an operation stage. |
| 1400 | # Unset for single-stage operations. |
| 1401 | }, |
| 1402 | "zone": "A String", # The name of the Google Compute Engine |
| 1403 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1404 | # operation is taking place. This field is deprecated, use location instead. |
| 1405 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1406 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1407 | "detail": "A String", # Detailed operation progress, if available. |
| 1408 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1409 | "operationType": "A String", # The operation type. |
| 1410 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1411 | "name": "A String", # The server-assigned ID for the operation. |
| 1412 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1413 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1414 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1415 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1416 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1417 | }, |
| 1418 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1419 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1420 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1421 | "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] | 1422 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1423 | # or |
| 1424 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1425 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1426 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1427 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1428 | }</pre> |
| 1429 | </div> |
| 1430 | |
| 1431 | <div class="method"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1432 | <code class="details" id="delete">delete(projectId, zone, clusterId, name=None, x__xgafv=None)</code> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1433 | <pre>Deletes the cluster, including the Kubernetes endpoint and all worker |
| 1434 | nodes. |
| 1435 | |
| 1436 | Firewalls and routes that were configured during cluster creation |
| 1437 | are also deleted. |
| 1438 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1439 | 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] | 1440 | 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] | 1441 | when the cluster was initially created. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1442 | |
| 1443 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1444 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 1445 | number](https://support.google.com/cloud/answer/6158840). |
| 1446 | This field has been deprecated and replaced by the name field. (required) |
| 1447 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1448 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1449 | cluster resides. This field has been deprecated and replaced by the name |
| 1450 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1451 | clusterId: string, Deprecated. The name of the cluster to delete. |
| 1452 | This field has been deprecated and replaced by the name field. (required) |
| 1453 | 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] | 1454 | Specified in the format `projects/*/locations/*/clusters/*`. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1455 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1456 | Allowed values |
| 1457 | 1 - v1 error format |
| 1458 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1459 | |
| 1460 | Returns: |
| 1461 | An object of the form: |
| 1462 | |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1463 | { # This operation resource represents operations that may have happened or are |
| 1464 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1465 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1466 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1467 | # (e.g., ERROR or DEGRADED). |
| 1468 | "code": "A String", # Machine-friendly representation of the condition |
| 1469 | "message": "A String", # Human-friendly representation of the condition |
| 1470 | }, |
| 1471 | ], |
| 1472 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 1473 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1474 | # Unset for single-stage operations. |
| 1475 | "stages": [ # Substages of an operation or a stage. |
| 1476 | # Object with schema name: OperationProgress |
| 1477 | ], |
| 1478 | "metrics": [ # Progress metric bundle, for example: |
| 1479 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1480 | # {name: "nodes total", int_value: 32}] |
| 1481 | # or |
| 1482 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1483 | # {name: "progress scale", double_value: 1.0}] |
| 1484 | { # Progress metric is (string, int|float|string) pair. |
| 1485 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1486 | "doubleValue": 3.14, # For metrics with floating point value. |
| 1487 | "intValue": "A String", # For metrics with integer value. |
| 1488 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 1489 | }, |
| 1490 | ], |
| 1491 | "status": "A String", # Status of an operation stage. |
| 1492 | # Unset for single-stage operations. |
| 1493 | }, |
| 1494 | "zone": "A String", # The name of the Google Compute Engine |
| 1495 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1496 | # operation is taking place. This field is deprecated, use location instead. |
| 1497 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 1498 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1499 | "detail": "A String", # Detailed operation progress, if available. |
| 1500 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 1501 | "operationType": "A String", # The operation type. |
| 1502 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1503 | "name": "A String", # The server-assigned ID for the operation. |
| 1504 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1505 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1506 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1507 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1508 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1509 | }, |
| 1510 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1511 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1512 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1513 | "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] | 1514 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1515 | # or |
| 1516 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1517 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1518 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1519 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1520 | }</pre> |
| 1521 | </div> |
| 1522 | |
| 1523 | <div class="method"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1524 | <code class="details" id="get">get(projectId, zone, clusterId, name=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1525 | <pre>Gets the details of a specific cluster. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1526 | |
| 1527 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1528 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 1529 | number](https://support.google.com/cloud/answer/6158840). |
| 1530 | This field has been deprecated and replaced by the name field. (required) |
| 1531 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1532 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1533 | cluster resides. This field has been deprecated and replaced by the name |
| 1534 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1535 | clusterId: string, Deprecated. The name of the cluster to retrieve. |
| 1536 | This field has been deprecated and replaced by the name field. (required) |
| 1537 | 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] | 1538 | Specified in the format `projects/*/locations/*/clusters/*`. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1539 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1540 | Allowed values |
| 1541 | 1 - v1 error format |
| 1542 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1543 | |
| 1544 | Returns: |
| 1545 | An object of the form: |
| 1546 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1547 | { # A Google Kubernetes Engine cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1548 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 1549 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1550 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 1551 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1552 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 1553 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 1554 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 1555 | # required by Cluster Autoscaler to automatically adjust |
| 1556 | # the size of the cluster and create/delete |
| 1557 | # node pools based on the current needs. |
| 1558 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 1559 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1560 | # NodePool's nodes can be created by NAP. |
| 1561 | "A String", |
| 1562 | ], |
| 1563 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 1564 | # amount of resources in the cluster. |
| 1565 | { # Contains information about amount of some resource in the cluster. |
| 1566 | # For memory, value should be in GB. |
| 1567 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 1568 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 1569 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 1570 | }, |
| 1571 | ], |
| 1572 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 1573 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 1574 | # created by NAP. |
| 1575 | # by NAP. |
| 1576 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 1577 | # node pool. |
| 1578 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1579 | # the Auto Upgrades will proceed. |
| 1580 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1581 | # with the approximate start time for the upgrades, in |
| 1582 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1583 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1584 | # with the description of the upgrade. |
| 1585 | }, |
| 1586 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 1587 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 1588 | # they fail health checks too many times, an automatic repair action will be |
| 1589 | # triggered. |
| 1590 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 1591 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 1592 | # up to date with the latest release version of Kubernetes. |
| 1593 | }, |
| 1594 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 1595 | # specified, service_account should be empty. |
| 1596 | "A String", |
| 1597 | ], |
| 1598 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 1599 | # disruption caused by an upgrade. |
| 1600 | # |
| 1601 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1602 | # unavailable. |
| 1603 | # |
| 1604 | # maxSurge controls the number of additional nodes that can be added to the |
| 1605 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1606 | # available nodes. |
| 1607 | # |
| 1608 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1609 | # nodes are being upgraded at the same time). |
| 1610 | # |
| 1611 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1612 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1613 | # this holds true. (Disruption stays within the limits of |
| 1614 | # PodDisruptionBudget, if it is configured.) |
| 1615 | # |
| 1616 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1617 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1618 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1619 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1620 | # there are always at least 4 nodes available. |
| 1621 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 1622 | # the upgrade process. A node is considered available if its status is |
| 1623 | # Ready. |
| 1624 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1625 | # of the node pool during the upgrade process. |
| 1626 | }, |
| 1627 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 1628 | # service_account is specified, scopes should be empty. |
| 1629 | }, |
| 1630 | }, |
| 1631 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 1632 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 1633 | # is sufficient for this number of instances. You must also have available |
| 1634 | # firewall and routes quota. |
| 1635 | # For requests, this field should only be used in lieu of a |
| 1636 | # "node_pool" object, since this configuration (along with the |
| 1637 | # "node_config") will be used to create a "NodePool" object with an |
| 1638 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 1639 | # |
| 1640 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 1641 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 1642 | "A String", |
| 1643 | ], |
| 1644 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 1645 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 1646 | # range will be used for assigning internal IP addresses to the master or |
| 1647 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 1648 | # any other ranges in use within the cluster's network. |
| 1649 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 1650 | # given only RFC 1918 private addresses and communicate with the master via |
| 1651 | # private networking. |
| 1652 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 1653 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 1654 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 1655 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 1656 | }, |
| 1657 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 1658 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 1659 | }, |
| 1660 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 1661 | # required by Vertical Pod Autoscaler to automatically adjust |
| 1662 | # the resources of pods controlled by it. |
| 1663 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 1664 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1665 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 1666 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 1667 | # if cluster created with IP Alias support. |
| 1668 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1669 | }, |
| 1670 | "network": "A String", # The name of the Google Compute Engine |
| 1671 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 1672 | # to which the cluster is connected. If left unspecified, the `default` |
| 1673 | # network will be used. |
| 1674 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 1675 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1676 | # containers. This is provisioned from within the `container_ipv4_cidr` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1677 | # range. This field will only be set when cluster is in route-based network |
| 1678 | # mode. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1679 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 1680 | # master authorized networks will disallow all external traffic to access |
| 1681 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 1682 | # Google Compute Engine Public IPs and Google Prod IPs. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1683 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 1684 | # Kubernetes master through HTTPS. |
| 1685 | { # CidrBlock contains an optional name and one CIDR block. |
| 1686 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 1687 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 1688 | }, |
| 1689 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1690 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1691 | }, |
| 1692 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1693 | # cluster, if available. |
| 1694 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 1695 | # If unspecified, the defaults are used: |
| 1696 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 1697 | # be set to "admin", a random password will be generated, and a client |
| 1698 | # certificate will be issued. |
| 1699 | # Authentication can be done using HTTP basic auth or using client |
| 1700 | # certificates. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1701 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 1702 | # Because the master endpoint is open to the Internet, you should create a |
| 1703 | # strong password. If a password is provided for cluster creation, username |
| 1704 | # must be non-empty. |
| 1705 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 1706 | # clusters before v1.12, if no configuration is specified, a client |
| 1707 | # certificate is issued. |
| 1708 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 1709 | }, |
| 1710 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 1711 | # to the cluster endpoint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1712 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 1713 | # trust for the cluster. |
| 1714 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 1715 | # authenticate to the cluster endpoint. |
| 1716 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 1717 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 1718 | # leaving username unspecified (or setting it to the empty string). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1719 | }, |
| 1720 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 1721 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 1722 | # during authentication using a group of security groups. |
| 1723 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 1724 | # if enabled = true. |
| 1725 | }, |
| 1726 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 1727 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 1728 | # cluster, enabling additional functionality. |
| 1729 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 1730 | # is enabled or not on the Master, it does not track whether network policy |
| 1731 | # is enabled for the nodes. |
| 1732 | # is enabled or not on the Master, it does not track whether network policy |
| 1733 | # is enabled for the nodes. |
| 1734 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 1735 | }, |
| 1736 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 1737 | # managed Knative service. |
| 1738 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 1739 | }, |
| 1740 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 1741 | # increases or decreases the number of replica pods a replication controller |
| 1742 | # has based on the resource usage of the existing pods. |
| 1743 | # increases or decreases the number of replica pods a replication controller |
| 1744 | # has based on the resource usage of the existing pods. |
| 1745 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 1746 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 1747 | # Monitoring. |
| 1748 | }, |
| 1749 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 1750 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 1751 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 1752 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 1753 | # When enabled, it runs a small pod in the cluster that manages the load |
| 1754 | # balancers. |
| 1755 | }, |
| 1756 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 1757 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 1758 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 1759 | # workloads and applications. For more information, see: |
| 1760 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 1761 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 1762 | }, |
| 1763 | }, |
| 1764 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 1765 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 1766 | # instead. The current version of the node software components. If they are |
| 1767 | # currently at multiple versions because they're in the process of being |
| 1768 | # upgraded, this reflects the minimum version of all nodes. |
| 1769 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 1770 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 1771 | # the cluster is connected. |
| 1772 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 1773 | # Google Compute Engine resources. |
| 1774 | "a_key": "A String", |
| 1775 | }, |
| 1776 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 1777 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1778 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 1779 | # occur in these windows. |
| 1780 | "a_key": { # Represents an arbitrary window of time. |
| 1781 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1782 | # start time. |
| 1783 | "startTime": "A String", # The time that the window first starts. |
| 1784 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1785 | }, |
| 1786 | "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] | 1787 | # maintenance to occur. The time windows may be overlapping. If no |
| 1788 | # maintenance windows are set, maintenance can occur at any time. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1789 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 1790 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 1791 | # start time. |
| 1792 | "startTime": "A String", # The time that the window first starts. |
| 1793 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1794 | "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] | 1795 | # this window reccurs. They go on for the span of time between the start and |
| 1796 | # end time. |
| 1797 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1798 | # For example, to have something repeat every weekday, you'd use: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1799 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 1800 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 1801 | # <code>FREQ=DAILY</code> |
| 1802 | # For the first weekend of every month: |
| 1803 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 1804 | # 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] | 1805 | # 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] | 1806 | # <code> |
| 1807 | # start time = 2019-01-01T09:00:00-0400 |
| 1808 | # end time = 2019-01-01T17:00:00-0400 |
| 1809 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 1810 | # </code> |
| 1811 | # Windows can span multiple days. Eg, to make the window encompass every |
| 1812 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 1813 | # <code> |
| 1814 | # start time = 2019-01-05T00:00:00Z |
| 1815 | # end time = 2019-01-07T23:59:00Z |
| 1816 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 1817 | # </code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1818 | # 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] | 1819 | # to specify duration of the window and when it first starts. |
| 1820 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1821 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1822 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 1823 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 1824 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 1825 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 1826 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 1827 | # smallest possible in the given scenario. |
| 1828 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 1829 | # format "PTnHnMnS". |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1830 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1831 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1832 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 1833 | # the policy won't accidentally undo intermediate changes (and so that users |
| 1834 | # of the API unaware of some fields won't accidentally remove other fields). |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1835 | # Make a <code>get()</code> request to the cluster to get the current |
| 1836 | # resource version and include it with requests to set the policy. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1837 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1838 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 1839 | # found in validMasterVersions returned by getServerConfig. The version can |
| 1840 | # be upgraded over time; such upgrades are reflected in |
| 1841 | # currentMasterVersion and currentNodeVersion. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1842 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1843 | # Users may specify either explicit versions offered by |
| 1844 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 1845 | # |
| 1846 | # - "latest": picks the highest valid Kubernetes version |
| 1847 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 1848 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 1849 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 1850 | # - "","-": picks the default Kubernetes version |
| 1851 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1852 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1853 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 1854 | # block. The secondary range will be used for pod IP |
| 1855 | # addresses. This must be an existing secondary range associated |
| 1856 | # with the cluster subnetwork. |
| 1857 | # |
| 1858 | # This field is only applicable with use_ip_aliases is true and |
| 1859 | # create_subnetwork is false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1860 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 1861 | # `cluster.cluster_ipv4_cidr` must be left blank. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1862 | # |
| 1863 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1864 | # |
| 1865 | # Set to blank to have a range chosen with the default size. |
| 1866 | # |
| 1867 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1868 | # netmask. |
| 1869 | # |
| 1870 | # Set to a |
| 1871 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1872 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1873 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1874 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1875 | "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] | 1876 | # |
| 1877 | # This is applicable only if `create_subnetwork` is true. |
| 1878 | # |
| 1879 | # Set to blank to have a range chosen with the default size. |
| 1880 | # |
| 1881 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1882 | # netmask. |
| 1883 | # |
| 1884 | # Set to a |
| 1885 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1886 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1887 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1888 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1889 | "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] | 1890 | # range will be automatically chosen with the default size. |
| 1891 | # |
| 1892 | # This field is only applicable when `use_ip_aliases` is true. |
| 1893 | # |
| 1894 | # If unspecified, the range will use the default size. |
| 1895 | # |
| 1896 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1897 | # netmask. |
| 1898 | # |
| 1899 | # Set to a |
| 1900 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1901 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1902 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1903 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1904 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 1905 | "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] | 1906 | # CIDR block. The secondary range will be used for service |
| 1907 | # ClusterIPs. This must be an existing secondary range associated |
| 1908 | # with the cluster subnetwork. |
| 1909 | # |
| 1910 | # This field is only applicable with use_ip_aliases is true and |
| 1911 | # create_subnetwork is false. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1912 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 1913 | # |
| 1914 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1915 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 1916 | # this field is empty, then an automatic name will be chosen for the new |
| 1917 | # subnetwork. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1918 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 1919 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 1920 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 1921 | # will be automatically chosen with the default size. |
| 1922 | # |
| 1923 | # This field is only applicable when `use_ip_aliases` is true. |
| 1924 | # |
| 1925 | # Set to blank to have a range chosen with the default size. |
| 1926 | # |
| 1927 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 1928 | # netmask. |
| 1929 | # |
| 1930 | # Set to a |
| 1931 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1932 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1933 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1934 | # to use. |
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 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 1937 | # mode. |
| 1938 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 1939 | # identities in the system, including service accounts, nodes, and |
| 1940 | # controllers, will have statically granted permissions beyond those |
| 1941 | # provided by the RBAC configuration or IAM. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1942 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1943 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1944 | # disabled when this config is unspecified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1945 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1946 | # daemonset will be created in the cluster to meter network egress traffic. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1947 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 1948 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1949 | # second BigQuery table will be created to hold resource consumption |
| 1950 | # records. |
| 1951 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1952 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 1953 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1954 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1955 | }, |
| 1956 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 1957 | "locations": [ # The list of Google Compute Engine |
| 1958 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1959 | # cluster's nodes should be located. |
| 1960 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1961 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1962 | "nodePools": [ # The node pools associated with this cluster. |
| 1963 | # This field should not be set if "node_config" or "initial_node_count" are |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1964 | # specified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1965 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 1966 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1967 | # specification, under the control of the cluster master. They may have a set |
| 1968 | # of Kubernetes labels applied to them, which may be used to reference them |
| 1969 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 1970 | # the workload. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1971 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1972 | # node pool instance, if available. |
| 1973 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 1974 | # only if a valid configuration is present. |
| 1975 | # adjust the size of the node pool to the current cluster usage. |
| 1976 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 1977 | # has to enough quota to scale up the cluster. |
| 1978 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 1979 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 1980 | # max_node_count. |
| 1981 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 1982 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1983 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 1984 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 1985 | # is sufficient for this number of instances. You must also have available |
| 1986 | # firewall and routes quota. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1987 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 1988 | "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] | 1989 | # disruption caused by an upgrade. |
| 1990 | # |
| 1991 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1992 | # unavailable. |
| 1993 | # |
| 1994 | # maxSurge controls the number of additional nodes that can be added to the |
| 1995 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1996 | # available nodes. |
| 1997 | # |
| 1998 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1999 | # nodes are being upgraded at the same time). |
| 2000 | # |
| 2001 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2002 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2003 | # this holds true. (Disruption stays within the limits of |
| 2004 | # PodDisruptionBudget, if it is configured.) |
| 2005 | # |
| 2006 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2007 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2008 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2009 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2010 | # there are always at least 4 nodes available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2011 | "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] | 2012 | # the upgrade process. A node is considered available if its status is |
| 2013 | # Ready. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2014 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2015 | # of the node pool during the upgrade process. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2016 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2017 | "locations": [ # The list of Google Compute Engine |
| 2018 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2019 | # NodePool's nodes should be located. |
| 2020 | "A String", |
| 2021 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2022 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 2023 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 2024 | # associated with this node pool. |
| 2025 | "A String", |
| 2026 | ], |
| 2027 | "version": "A String", # The version of the Kubernetes of this node. |
| 2028 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 2029 | "conditions": [ # Which conditions caused the current node pool state. |
| 2030 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2031 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2032 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2033 | "message": "A String", # Human-friendly representation of the condition |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2034 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2035 | ], |
| 2036 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 2037 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2038 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2039 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2040 | # |
| 2041 | # The following scopes are recommended, but not required, and by default are |
| 2042 | # not included: |
| 2043 | # |
| 2044 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2045 | # persistent storage on your nodes. |
| 2046 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2047 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2048 | # (the [Google Container |
| 2049 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2050 | # |
| 2051 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2052 | # 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] | 2053 | "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 2054 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2055 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2056 | # |
| 2057 | # For more information, including usage and the valid values, see: |
| 2058 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2059 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2060 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2061 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2062 | # See |
| 2063 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2064 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2065 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2066 | "value": "A String", # Value for taint. |
| 2067 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2068 | }, |
| 2069 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2070 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2071 | # These will added in addition to any default label(s) that |
| 2072 | # Kubernetes may apply to the node. |
| 2073 | # In case of conflict in label keys, the applied set may differ depending on |
| 2074 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2075 | # and conflicts should be avoided. |
| 2076 | # For more information, including usage and the valid values, see: |
| 2077 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2078 | "a_key": "A String", |
| 2079 | }, |
| 2080 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2081 | # The smallest allowed disk size is 10GB. |
| 2082 | # |
| 2083 | # If unspecified, the default disk size is 100GB. |
| 2084 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2085 | # workloads on the node pool. |
| 2086 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2087 | # on the node pool. |
| 2088 | }, |
| 2089 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2090 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2091 | # support for GPUs. |
| 2092 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2093 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2094 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2095 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2096 | }, |
| 2097 | ], |
| 2098 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 2099 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 2100 | # `n1-standard-1`). |
| 2101 | # |
| 2102 | # If unspecified, the default machine type is |
| 2103 | # `n1-standard-1`. |
| 2104 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2105 | # |
| 2106 | # If unspecified, the default disk type is 'pd-standard' |
| 2107 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2108 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 2109 | # |
| 2110 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2111 | # The attestation is performed against the integrity policy baseline. This |
| 2112 | # baseline is initially derived from the implicitly trusted boot image when |
| 2113 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2114 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2115 | # |
| 2116 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2117 | # verifying the digital signature of all boot components, and halting the |
| 2118 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2119 | }, |
| 2120 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2121 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2122 | # friendly names of CPU platforms, such as |
| 2123 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2124 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2125 | # information, read [how to specify min CPU |
| 2126 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2127 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2128 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2129 | # information about preemptible VM instances. |
| 2130 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2131 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2132 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2133 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2134 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2135 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2136 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2137 | "type": "A String", # Type of the sandbox to use for the node. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2138 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2139 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 2140 | # |
| 2141 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2142 | # in length. These are reflected as part of a URL in the metadata server. |
| 2143 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2144 | # metadata keys for the project or be one of the reserved keys: |
| 2145 | # "cluster-location" |
| 2146 | # "cluster-name" |
| 2147 | # "cluster-uid" |
| 2148 | # "configure-sh" |
| 2149 | # "containerd-configure-sh" |
| 2150 | # "enable-os-login" |
| 2151 | # "gci-ensure-gke-docker" |
| 2152 | # "gci-metrics-enabled" |
| 2153 | # "gci-update-strategy" |
| 2154 | # "instance-template" |
| 2155 | # "kube-env" |
| 2156 | # "startup-script" |
| 2157 | # "user-data" |
| 2158 | # "disable-address-manager" |
| 2159 | # "windows-startup-script-ps1" |
| 2160 | # "common-psm1" |
| 2161 | # "k8s-node-setup-psm1" |
| 2162 | # "install-ssh-psm1" |
| 2163 | # "user-profile-psm1" |
| 2164 | # "serial-port-logging-enable" |
| 2165 | # |
| 2166 | # Values are free-form strings, and only have meaning as interpreted by |
| 2167 | # the image running in the instance. The only restriction placed on them is |
| 2168 | # that each value's size must be less than or equal to 32 KB. |
| 2169 | # |
| 2170 | # The total size of all keys and values must be less than 512 KB. |
| 2171 | "a_key": "A String", |
| 2172 | }, |
| 2173 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2174 | # the specified [Zonal Compute |
| 2175 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2176 | # to this node pool. |
| 2177 | # is the configuration of desired reservation which instances could take |
| 2178 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2179 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2180 | "A String", |
| 2181 | ], |
| 2182 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2183 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2184 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2185 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2186 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2187 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 2188 | # valid sources or targets for network firewalls and are specified by |
| 2189 | # the client during cluster or node pool creation. Each tag within the list |
| 2190 | # must comply with RFC1035. |
| 2191 | "A String", |
| 2192 | ], |
| 2193 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2194 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2195 | # Account is specified, the "default" service account is used. |
| 2196 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2197 | # the latest version of it will be used. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2198 | }, |
| 2199 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 2200 | # simultaneously on a node in the node pool. |
| 2201 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2202 | }, |
| 2203 | "name": "A String", # The name of the node pool. |
| 2204 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 2205 | # node pool. |
| 2206 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2207 | # the Auto Upgrades will proceed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2208 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2209 | # with the approximate start time for the upgrades, in |
| 2210 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2211 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2212 | # with the description of the upgrade. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2213 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2214 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 2215 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 2216 | # they fail health checks too many times, an automatic repair action will be |
| 2217 | # triggered. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2218 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 2219 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 2220 | # up to date with the latest release version of Kubernetes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2221 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 2222 | }, |
| 2223 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2224 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 2225 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 2226 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 2227 | "provider": "A String", # The selected network policy provider. |
| 2228 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 2229 | }, |
| 2230 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 2231 | # this cluster, in |
| 2232 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2233 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 2234 | # typically put in the last `/16` from the container CIDR. |
| 2235 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 2236 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 2237 | # the kubernetes version of the master and nodes. |
| 2238 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 2239 | # Alpha enabled clusters are automatically deleted thirty days after |
| 2240 | # creation. |
| 2241 | "description": "A String", # An optional description of this cluster. |
| 2242 | "conditions": [ # Which conditions caused the current cluster state. |
| 2243 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2244 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2245 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2246 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2247 | }, |
| 2248 | ], |
| 2249 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 2250 | # Call Kubernetes API directly to retrieve node information. |
| 2251 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2252 | # Currently available options: |
| 2253 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2254 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2255 | # service with a Kubernetes-native resource model |
| 2256 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 2257 | # longer available as of GKE 1.15). |
| 2258 | # * `none` - No metrics will be exported from the cluster. |
| 2259 | # |
| 2260 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 2261 | # 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] | 2262 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 2263 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 2264 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 2265 | "state": "A String", # Denotes the state of etcd encryption. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2266 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2267 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 2268 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 2269 | # images will be validated by Binary Authorization. |
| 2270 | }, |
| 2271 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 2272 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2273 | # notation (e.g. `1.2.3.4/29`). |
| 2274 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 2275 | # policies. |
| 2276 | # policies. |
| 2277 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 2278 | }, |
| 2279 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 2280 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2281 | # cluster resides. This field is deprecated, use location instead. |
| 2282 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 2283 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2284 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2285 | # Currently available options: |
| 2286 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2287 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 2288 | # service with a Kubernetes-native resource model |
| 2289 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 2290 | # available as of GKE 1.15). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2291 | # * `none` - no logs will be exported from the cluster. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2292 | # |
| 2293 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 2294 | # 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] | 2295 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2296 | # 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] | 2297 | # "node_pool" object, since this configuration (along with the |
| 2298 | # "initial_node_count") will be used to create a "NodePool" object with an |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2299 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2300 | # For responses, this field will be populated with the node configuration of |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2301 | # the first node pool. (For configuration of each node pool, see |
| 2302 | # `node_pool.config`) |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2303 | # |
| 2304 | # If unspecified, the defaults are used. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2305 | # This field is deprecated, use node_pool.config instead. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2306 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 2307 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2308 | # |
| 2309 | # The following scopes are recommended, but not required, and by default are |
| 2310 | # not included: |
| 2311 | # |
| 2312 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 2313 | # persistent storage on your nodes. |
| 2314 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 2315 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2316 | # (the [Google Container |
| 2317 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2318 | # |
| 2319 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 2320 | # 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] | 2321 | "A String", |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2322 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2323 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2324 | # |
| 2325 | # For more information, including usage and the valid values, see: |
| 2326 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 2327 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 2328 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 2329 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2330 | # See |
| 2331 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 2332 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2333 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2334 | "value": "A String", # Value for taint. |
| 2335 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2336 | }, |
| 2337 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2338 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 2339 | # These will added in addition to any default label(s) that |
| 2340 | # Kubernetes may apply to the node. |
| 2341 | # In case of conflict in label keys, the applied set may differ depending on |
| 2342 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 2343 | # and conflicts should be avoided. |
| 2344 | # For more information, including usage and the valid values, see: |
| 2345 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 2346 | "a_key": "A String", |
| 2347 | }, |
| 2348 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 2349 | # The smallest allowed disk size is 10GB. |
| 2350 | # |
| 2351 | # If unspecified, the default disk size is 100GB. |
| 2352 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 2353 | # workloads on the node pool. |
| 2354 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 2355 | # on the node pool. |
| 2356 | }, |
| 2357 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 2358 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 2359 | # support for GPUs. |
| 2360 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2361 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 2362 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2363 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2364 | }, |
| 2365 | ], |
| 2366 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 2367 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 2368 | # `n1-standard-1`). |
| 2369 | # |
| 2370 | # If unspecified, the default machine type is |
| 2371 | # `n1-standard-1`. |
| 2372 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 2373 | # |
| 2374 | # If unspecified, the default disk type is 'pd-standard' |
| 2375 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2376 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 2377 | # |
| 2378 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 2379 | # The attestation is performed against the integrity policy baseline. This |
| 2380 | # baseline is initially derived from the implicitly trusted boot image when |
| 2381 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2382 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 2383 | # |
| 2384 | # Secure Boot helps ensure that the system only runs authentic software by |
| 2385 | # verifying the digital signature of all boot components, and halting the |
| 2386 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2387 | }, |
| 2388 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 2389 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 2390 | # friendly names of CPU platforms, such as |
| 2391 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 2392 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 2393 | # information, read [how to specify min CPU |
| 2394 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 2395 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 2396 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 2397 | # information about preemptible VM instances. |
| 2398 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2399 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2400 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2401 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2402 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2403 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2404 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 2405 | "type": "A String", # Type of the sandbox to use for the node. |
| 2406 | }, |
| 2407 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 2408 | # |
| 2409 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 2410 | # in length. These are reflected as part of a URL in the metadata server. |
| 2411 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 2412 | # metadata keys for the project or be one of the reserved keys: |
| 2413 | # "cluster-location" |
| 2414 | # "cluster-name" |
| 2415 | # "cluster-uid" |
| 2416 | # "configure-sh" |
| 2417 | # "containerd-configure-sh" |
| 2418 | # "enable-os-login" |
| 2419 | # "gci-ensure-gke-docker" |
| 2420 | # "gci-metrics-enabled" |
| 2421 | # "gci-update-strategy" |
| 2422 | # "instance-template" |
| 2423 | # "kube-env" |
| 2424 | # "startup-script" |
| 2425 | # "user-data" |
| 2426 | # "disable-address-manager" |
| 2427 | # "windows-startup-script-ps1" |
| 2428 | # "common-psm1" |
| 2429 | # "k8s-node-setup-psm1" |
| 2430 | # "install-ssh-psm1" |
| 2431 | # "user-profile-psm1" |
| 2432 | # "serial-port-logging-enable" |
| 2433 | # |
| 2434 | # Values are free-form strings, and only have meaning as interpreted by |
| 2435 | # the image running in the instance. The only restriction placed on them is |
| 2436 | # that each value's size must be less than or equal to 32 KB. |
| 2437 | # |
| 2438 | # The total size of all keys and values must be less than 512 KB. |
| 2439 | "a_key": "A String", |
| 2440 | }, |
| 2441 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 2442 | # the specified [Zonal Compute |
| 2443 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 2444 | # to this node pool. |
| 2445 | # is the configuration of desired reservation which instances could take |
| 2446 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2447 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 2448 | "A String", |
| 2449 | ], |
| 2450 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2451 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 2452 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 2453 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2454 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2455 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 2456 | # valid sources or targets for network firewalls and are specified by |
| 2457 | # the client during cluster or node pool creation. Each tag within the list |
| 2458 | # must comply with RFC1035. |
| 2459 | "A String", |
| 2460 | ], |
| 2461 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 2462 | # Specify the email address of the Service Account; otherwise, if no Service |
| 2463 | # Account is specified, the "default" service account is used. |
| 2464 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 2465 | # the latest version of it will be used. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2466 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2467 | "status": "A String", # [Output only] The current status of this cluster. |
| 2468 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2469 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 2470 | # This makes same node pod to pod traffic visible for VPC network. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2471 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 2472 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 2473 | # cluster is connected. Example: |
| 2474 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 2475 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 2476 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2477 | # to which the cluster is connected. Example: |
| 2478 | # projects/my-project/global/networks/my-network |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2479 | }, |
| 2480 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 2481 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 2482 | # the following restrictions: |
| 2483 | # |
| 2484 | # * Lowercase letters, numbers, and hyphens only. |
| 2485 | # * Must start with a letter. |
| 2486 | # * Must end with a number or a letter. |
| 2487 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 2488 | # The endpoint can be accessed from the internet at |
| 2489 | # `https://username:password@endpoint/`. |
| 2490 | # |
| 2491 | # See the `masterAuth` property of this resource for username and |
| 2492 | # password information. |
| 2493 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 2494 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2495 | # or |
| 2496 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2497 | # in which the cluster resides. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2498 | }</pre> |
| 2499 | </div> |
| 2500 | |
| 2501 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2502 | <code class="details" id="legacyAbac">legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2503 | <pre>Enables or disables the ABAC authorization mechanism on a cluster. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2504 | |
| 2505 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2506 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 2507 | number](https://support.google.com/cloud/answer/6158840). |
| 2508 | This field has been deprecated and replaced by the name field. (required) |
| 2509 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2510 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2511 | cluster resides. This field has been deprecated and replaced by the name |
| 2512 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2513 | clusterId: string, Deprecated. The name of the cluster to update. |
| 2514 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2515 | body: object, The request body. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2516 | The object takes the form of: |
| 2517 | |
| 2518 | { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for |
| 2519 | # a cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2520 | "clusterId": "A String", # Deprecated. The name of the cluster to update. |
| 2521 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2522 | "name": "A String", # The name (project, location, cluster id) of the cluster to set legacy abac. |
| 2523 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 2524 | "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. |
| 2525 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2526 | # number](https://support.google.com/cloud/answer/6158840). |
| 2527 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2528 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2529 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2530 | # cluster resides. This field has been deprecated and replaced by the name |
| 2531 | # field. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2532 | } |
| 2533 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2534 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2535 | Allowed values |
| 2536 | 1 - v1 error format |
| 2537 | 2 - v2 error format |
| 2538 | |
| 2539 | Returns: |
| 2540 | An object of the form: |
| 2541 | |
| 2542 | { # This operation resource represents operations that may have happened or are |
| 2543 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2544 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 2545 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2546 | # (e.g., ERROR or DEGRADED). |
| 2547 | "code": "A String", # Machine-friendly representation of the condition |
| 2548 | "message": "A String", # Human-friendly representation of the condition |
| 2549 | }, |
| 2550 | ], |
| 2551 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 2552 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 2553 | # Unset for single-stage operations. |
| 2554 | "stages": [ # Substages of an operation or a stage. |
| 2555 | # Object with schema name: OperationProgress |
| 2556 | ], |
| 2557 | "metrics": [ # Progress metric bundle, for example: |
| 2558 | # metrics: [{name: "nodes done", int_value: 15}, |
| 2559 | # {name: "nodes total", int_value: 32}] |
| 2560 | # or |
| 2561 | # metrics: [{name: "progress", double_value: 0.56}, |
| 2562 | # {name: "progress scale", double_value: 1.0}] |
| 2563 | { # Progress metric is (string, int|float|string) pair. |
| 2564 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 2565 | "doubleValue": 3.14, # For metrics with floating point value. |
| 2566 | "intValue": "A String", # For metrics with integer value. |
| 2567 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 2568 | }, |
| 2569 | ], |
| 2570 | "status": "A String", # Status of an operation stage. |
| 2571 | # Unset for single-stage operations. |
| 2572 | }, |
| 2573 | "zone": "A String", # The name of the Google Compute Engine |
| 2574 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2575 | # operation is taking place. This field is deprecated, use location instead. |
| 2576 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 2577 | "selfLink": "A String", # Server-defined URL for the resource. |
| 2578 | "detail": "A String", # Detailed operation progress, if available. |
| 2579 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 2580 | "operationType": "A String", # The operation type. |
| 2581 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2582 | "name": "A String", # The server-assigned ID for the operation. |
| 2583 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2584 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 2585 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2586 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2587 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2588 | }, |
| 2589 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2590 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2591 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2592 | "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] | 2593 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2594 | # or |
| 2595 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 2596 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2597 | "startTime": "A String", # [Output only] The time the operation started, in |
| 2598 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2599 | }</pre> |
| 2600 | </div> |
| 2601 | |
| 2602 | <div class="method"> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2603 | <code class="details" id="list">list(projectId, zone, parent=None, x__xgafv=None)</code> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2604 | <pre>Lists all clusters owned by a project in either the specified zone or all |
| 2605 | zones. |
| 2606 | |
| 2607 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2608 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 2609 | number](https://support.google.com/cloud/answer/6158840). |
| 2610 | This field has been deprecated and replaced by the parent field. (required) |
| 2611 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2612 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2613 | cluster resides, or "-" for all zones. This field has been deprecated and |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2614 | replaced by the parent field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2615 | 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] | 2616 | Specified in the format `projects/*/locations/*`. |
| 2617 | Location "-" matches all zones and all regions. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2618 | x__xgafv: string, V1 error format. |
| 2619 | Allowed values |
| 2620 | 1 - v1 error format |
| 2621 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2622 | |
| 2623 | Returns: |
| 2624 | An object of the form: |
| 2625 | |
| 2626 | { # ListClustersResponse is the result of ListClustersRequest. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2627 | "clusters": [ # A list of clusters in the project in the specified zone, or |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2628 | # across all ones. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2629 | { # A Google Kubernetes Engine cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2630 | "createTime": "A String", # [Output only] The time the cluster was created, in |
| 2631 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2632 | "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in |
| 2633 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2634 | # notation (e.g. `10.96.0.0/14`). Leave blank to have |
| 2635 | # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. |
| 2636 | "autoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
| 2637 | # required by Cluster Autoscaler to automatically adjust |
| 2638 | # the size of the cluster and create/delete |
| 2639 | # node pools based on the current needs. |
| 2640 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 2641 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 2642 | # NodePool's nodes can be created by NAP. |
| 2643 | "A String", |
| 2644 | ], |
| 2645 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 2646 | # amount of resources in the cluster. |
| 2647 | { # Contains information about amount of some resource in the cluster. |
| 2648 | # For memory, value should be in GB. |
| 2649 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
| 2650 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 2651 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
| 2652 | }, |
| 2653 | ], |
| 2654 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 2655 | "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created # AutoprovisioningNodePoolDefaults contains defaults for a node pool |
| 2656 | # created by NAP. |
| 2657 | # by NAP. |
| 2658 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
| 2659 | # node pool. |
| 2660 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 2661 | # the Auto Upgrades will proceed. |
| 2662 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2663 | # with the approximate start time for the upgrades, in |
| 2664 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 2665 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 2666 | # with the description of the upgrade. |
| 2667 | }, |
| 2668 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 2669 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 2670 | # they fail health checks too many times, an automatic repair action will be |
| 2671 | # triggered. |
| 2672 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 2673 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 2674 | # up to date with the latest release version of Kubernetes. |
| 2675 | }, |
| 2676 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 2677 | # specified, service_account should be empty. |
| 2678 | "A String", |
| 2679 | ], |
| 2680 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Specifies the upgrade settings for NAP created node pools |
| 2681 | # disruption caused by an upgrade. |
| 2682 | # |
| 2683 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 2684 | # unavailable. |
| 2685 | # |
| 2686 | # maxSurge controls the number of additional nodes that can be added to the |
| 2687 | # node pool temporarily for the time of the upgrade to increase the number of |
| 2688 | # available nodes. |
| 2689 | # |
| 2690 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 2691 | # nodes are being upgraded at the same time). |
| 2692 | # |
| 2693 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 2694 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 2695 | # this holds true. (Disruption stays within the limits of |
| 2696 | # PodDisruptionBudget, if it is configured.) |
| 2697 | # |
| 2698 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 2699 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 2700 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 2701 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 2702 | # there are always at least 4 nodes available. |
| 2703 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 2704 | # the upgrade process. A node is considered available if its status is |
| 2705 | # Ready. |
| 2706 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 2707 | # of the node pool during the upgrade process. |
| 2708 | }, |
| 2709 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 2710 | # service_account is specified, scopes should be empty. |
| 2711 | }, |
| 2712 | }, |
| 2713 | "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your |
| 2714 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 2715 | # is sufficient for this number of instances. You must also have available |
| 2716 | # firewall and routes quota. |
| 2717 | # For requests, this field should only be used in lieu of a |
| 2718 | # "node_pool" object, since this configuration (along with the |
| 2719 | # "node_config") will be used to create a "NodePool" object with an |
| 2720 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 2721 | # |
| 2722 | # This field is deprecated, use node_pool.initial_node_count instead. |
| 2723 | "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. |
| 2724 | "A String", |
| 2725 | ], |
| 2726 | "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster. |
| 2727 | "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This |
| 2728 | # range will be used for assigning internal IP addresses to the master or |
| 2729 | # set of masters, as well as the ILB VIP. This range must not overlap with |
| 2730 | # any other ranges in use within the cluster's network. |
| 2731 | "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are |
| 2732 | # given only RFC 1918 private addresses and communicate with the master via |
| 2733 | # private networking. |
| 2734 | "privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. |
| 2735 | "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. |
| 2736 | "peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster. |
| 2737 | "publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. |
| 2738 | }, |
| 2739 | "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. |
| 2740 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 2741 | }, |
| 2742 | "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 2743 | # required by Vertical Pod Autoscaler to automatically adjust |
| 2744 | # the resources of pods controlled by it. |
| 2745 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 2746 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2747 | "defaultMaxPodsConstraint": { # Constraints applied to pods. # The default constraint on the maximum number of pods that can be run |
| 2748 | # simultaneously on a node in the node pool of this cluster. Only honored |
| 2749 | # if cluster created with IP Alias support. |
| 2750 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 2751 | }, |
| 2752 | "network": "A String", # The name of the Google Compute Engine |
| 2753 | # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 2754 | # to which the cluster is connected. If left unspecified, the `default` |
| 2755 | # network will be used. |
| 2756 | "labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster. |
| 2757 | "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 2758 | # containers. This is provisioned from within the `container_ipv4_cidr` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2759 | # range. This field will only be set when cluster is in route-based network |
| 2760 | # mode. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2761 | "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The configuration options for master authorized networks feature. |
| 2762 | # master authorized networks will disallow all external traffic to access |
| 2763 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 2764 | # Google Compute Engine Public IPs and Google Prod IPs. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2765 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 2766 | # Kubernetes master through HTTPS. |
| 2767 | { # CidrBlock contains an optional name and one CIDR block. |
| 2768 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 2769 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
| 2770 | }, |
| 2771 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2772 | "enabled": True or False, # Whether or not master authorized networks is enabled. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2773 | }, |
| 2774 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 2775 | # cluster, if available. |
| 2776 | "masterAuth": { # The authentication information for accessing the master endpoint. # The authentication information for accessing the master endpoint. |
| 2777 | # If unspecified, the defaults are used: |
| 2778 | # For clusters before v1.12, if master_auth is unspecified, `username` will |
| 2779 | # be set to "admin", a random password will be generated, and a client |
| 2780 | # certificate will be issued. |
| 2781 | # Authentication can be done using HTTP basic auth or using client |
| 2782 | # certificates. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2783 | "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. |
| 2784 | # Because the master endpoint is open to the Internet, you should create a |
| 2785 | # strong password. If a password is provided for cluster creation, username |
| 2786 | # must be non-empty. |
| 2787 | "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For |
| 2788 | # clusters before v1.12, if no configuration is specified, a client |
| 2789 | # certificate is issued. |
| 2790 | "issueClientCertificate": True or False, # Issue a client certificate. |
| 2791 | }, |
| 2792 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 2793 | # to the cluster endpoint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2794 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 2795 | # trust for the cluster. |
| 2796 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 2797 | # authenticate to the cluster endpoint. |
| 2798 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 2799 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 2800 | # leaving username unspecified (or setting it to the empty string). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2801 | }, |
| 2802 | "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. |
| 2803 | "enabled": True or False, # Whether this cluster should return group membership lookups |
| 2804 | # during authentication using a group of security groups. |
| 2805 | "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant |
| 2806 | # if enabled = true. |
| 2807 | }, |
| 2808 | "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. |
| 2809 | "addonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
| 2810 | # cluster, enabling additional functionality. |
| 2811 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 2812 | # is enabled or not on the Master, it does not track whether network policy |
| 2813 | # is enabled for the nodes. |
| 2814 | # is enabled or not on the Master, it does not track whether network policy |
| 2815 | # is enabled for the nodes. |
| 2816 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 2817 | }, |
| 2818 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 2819 | # managed Knative service. |
| 2820 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 2821 | }, |
| 2822 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 2823 | # increases or decreases the number of replica pods a replication controller |
| 2824 | # has based on the resource usage of the existing pods. |
| 2825 | # increases or decreases the number of replica pods a replication controller |
| 2826 | # has based on the resource usage of the existing pods. |
| 2827 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 2828 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 2829 | # Monitoring. |
| 2830 | }, |
| 2831 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
| 2832 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 2833 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
| 2834 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
| 2835 | # When enabled, it runs a small pod in the cluster that manages the load |
| 2836 | # balancers. |
| 2837 | }, |
| 2838 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
| 2839 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 2840 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 2841 | # workloads and applications. For more information, see: |
| 2842 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
| 2843 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
| 2844 | }, |
| 2845 | }, |
| 2846 | "currentNodeVersion": "A String", # [Output only] Deprecated, use |
| 2847 | # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) |
| 2848 | # instead. The current version of the node software components. If they are |
| 2849 | # currently at multiple versions because they're in the process of being |
| 2850 | # upgraded, this reflects the minimum version of all nodes. |
| 2851 | "subnetwork": "A String", # The name of the Google Compute Engine |
| 2852 | # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which |
| 2853 | # the cluster is connected. |
| 2854 | "resourceLabels": { # The resource labels for the cluster to use to annotate any related |
| 2855 | # Google Compute Engine resources. |
| 2856 | "a_key": "A String", |
| 2857 | }, |
| 2858 | "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster. |
| 2859 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2860 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 2861 | # occur in these windows. |
| 2862 | "a_key": { # Represents an arbitrary window of time. |
| 2863 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2864 | # start time. |
| 2865 | "startTime": "A String", # The time that the window first starts. |
| 2866 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2867 | }, |
| 2868 | "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] | 2869 | # maintenance to occur. The time windows may be overlapping. If no |
| 2870 | # maintenance windows are set, maintenance can occur at any time. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2871 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 2872 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 2873 | # start time. |
| 2874 | "startTime": "A String", # The time that the window first starts. |
| 2875 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2876 | "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] | 2877 | # this window reccurs. They go on for the span of time between the start and |
| 2878 | # end time. |
| 2879 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2880 | # For example, to have something repeat every weekday, you'd use: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2881 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 2882 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 2883 | # <code>FREQ=DAILY</code> |
| 2884 | # For the first weekend of every month: |
| 2885 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 2886 | # 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] | 2887 | # 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] | 2888 | # <code> |
| 2889 | # start time = 2019-01-01T09:00:00-0400 |
| 2890 | # end time = 2019-01-01T17:00:00-0400 |
| 2891 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 2892 | # </code> |
| 2893 | # Windows can span multiple days. Eg, to make the window encompass every |
| 2894 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 2895 | # <code> |
| 2896 | # start time = 2019-01-05T00:00:00Z |
| 2897 | # end time = 2019-01-07T23:59:00Z |
| 2898 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 2899 | # </code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2900 | # 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] | 2901 | # to specify duration of the window and when it first starts. |
| 2902 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2903 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2904 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 2905 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 2906 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 2907 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 2908 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 2909 | # smallest possible in the given scenario. |
| 2910 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 2911 | # format "PTnHnMnS". |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2912 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2913 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2914 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 2915 | # the policy won't accidentally undo intermediate changes (and so that users |
| 2916 | # of the API unaware of some fields won't accidentally remove other fields). |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2917 | # Make a <code>get()</code> request to the cluster to get the current |
| 2918 | # resource version and include it with requests to set the policy. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2919 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2920 | "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those |
| 2921 | # found in validMasterVersions returned by getServerConfig. The version can |
| 2922 | # be upgraded over time; such upgrades are reflected in |
| 2923 | # currentMasterVersion and currentNodeVersion. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2924 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2925 | # Users may specify either explicit versions offered by |
| 2926 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 2927 | # |
| 2928 | # - "latest": picks the highest valid Kubernetes version |
| 2929 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 2930 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 2931 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 2932 | # - "","-": picks the default Kubernetes version |
| 2933 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2934 | "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2935 | "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR |
| 2936 | # block. The secondary range will be used for pod IP |
| 2937 | # addresses. This must be an existing secondary range associated |
| 2938 | # with the cluster subnetwork. |
| 2939 | # |
| 2940 | # This field is only applicable with use_ip_aliases is true and |
| 2941 | # create_subnetwork is false. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2942 | "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then |
| 2943 | # `cluster.cluster_ipv4_cidr` must be left blank. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2944 | # |
| 2945 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2946 | # |
| 2947 | # Set to blank to have a range chosen with the default size. |
| 2948 | # |
| 2949 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2950 | # netmask. |
| 2951 | # |
| 2952 | # Set to a |
| 2953 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2954 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2955 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2956 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2957 | "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] | 2958 | # |
| 2959 | # This is applicable only if `create_subnetwork` is true. |
| 2960 | # |
| 2961 | # Set to blank to have a range chosen with the default size. |
| 2962 | # |
| 2963 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2964 | # netmask. |
| 2965 | # |
| 2966 | # Set to a |
| 2967 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2968 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2969 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2970 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2971 | "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] | 2972 | # range will be automatically chosen with the default size. |
| 2973 | # |
| 2974 | # This field is only applicable when `use_ip_aliases` is true. |
| 2975 | # |
| 2976 | # If unspecified, the range will use the default size. |
| 2977 | # |
| 2978 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 2979 | # netmask. |
| 2980 | # |
| 2981 | # Set to a |
| 2982 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 2983 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 2984 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 2985 | # to use. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2986 | "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. |
| 2987 | "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] | 2988 | # CIDR block. The secondary range will be used for service |
| 2989 | # ClusterIPs. This must be an existing secondary range associated |
| 2990 | # with the cluster subnetwork. |
| 2991 | # |
| 2992 | # This field is only applicable with use_ip_aliases is true and |
| 2993 | # create_subnetwork is false. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2994 | "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. |
| 2995 | # |
| 2996 | # This field is only applicable when `use_ip_aliases` is true. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2997 | "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If |
| 2998 | # this field is empty, then an automatic name will be chosen for the new |
| 2999 | # subnetwork. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3000 | "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. |
| 3001 | "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. |
| 3002 | "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range |
| 3003 | # will be automatically chosen with the default size. |
| 3004 | # |
| 3005 | # This field is only applicable when `use_ip_aliases` is true. |
| 3006 | # |
| 3007 | # Set to blank to have a range chosen with the default size. |
| 3008 | # |
| 3009 | # Set to /netmask (e.g. `/14`) to have a range chosen with a specific |
| 3010 | # netmask. |
| 3011 | # |
| 3012 | # Set to a |
| 3013 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3014 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 3015 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 3016 | # to use. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3017 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3018 | "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization # Configuration for the legacy ABAC authorization mode. |
| 3019 | # mode. |
| 3020 | "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, |
| 3021 | # identities in the system, including service accounts, nodes, and |
| 3022 | # controllers, will have statically granted permissions beyond those |
| 3023 | # provided by the RBAC configuration or IAM. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3024 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3025 | "resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3026 | # disabled when this config is unspecified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3027 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3028 | # daemonset will be created in the cluster to meter network egress traffic. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3029 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 3030 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3031 | # second BigQuery table will be created to hold resource consumption |
| 3032 | # records. |
| 3033 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3034 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 3035 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3036 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3037 | }, |
| 3038 | "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. |
| 3039 | "locations": [ # The list of Google Compute Engine |
| 3040 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3041 | # cluster's nodes should be located. |
| 3042 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3043 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3044 | "nodePools": [ # The node pools associated with this cluster. |
| 3045 | # This field should not be set if "node_config" or "initial_node_count" are |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3046 | # specified. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3047 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 3048 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3049 | # specification, under the control of the cluster master. They may have a set |
| 3050 | # of Kubernetes labels applied to them, which may be used to reference them |
| 3051 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 3052 | # the workload. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3053 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 3054 | # node pool instance, if available. |
| 3055 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 3056 | # only if a valid configuration is present. |
| 3057 | # adjust the size of the node pool to the current cluster usage. |
| 3058 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 3059 | # has to enough quota to scale up the cluster. |
| 3060 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 3061 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 3062 | # max_node_count. |
| 3063 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 3064 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3065 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 3066 | # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| 3067 | # is sufficient for this number of instances. You must also have available |
| 3068 | # firewall and routes quota. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3069 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3070 | "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] | 3071 | # disruption caused by an upgrade. |
| 3072 | # |
| 3073 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 3074 | # unavailable. |
| 3075 | # |
| 3076 | # maxSurge controls the number of additional nodes that can be added to the |
| 3077 | # node pool temporarily for the time of the upgrade to increase the number of |
| 3078 | # available nodes. |
| 3079 | # |
| 3080 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 3081 | # nodes are being upgraded at the same time). |
| 3082 | # |
| 3083 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 3084 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 3085 | # this holds true. (Disruption stays within the limits of |
| 3086 | # PodDisruptionBudget, if it is configured.) |
| 3087 | # |
| 3088 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 3089 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 3090 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 3091 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 3092 | # there are always at least 4 nodes available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3093 | "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] | 3094 | # the upgrade process. A node is considered available if its status is |
| 3095 | # Ready. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3096 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 3097 | # of the node pool during the upgrade process. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3098 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3099 | "locations": [ # The list of Google Compute Engine |
| 3100 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3101 | # NodePool's nodes should be located. |
| 3102 | "A String", |
| 3103 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3104 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 3105 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 3106 | # associated with this node pool. |
| 3107 | "A String", |
| 3108 | ], |
| 3109 | "version": "A String", # The version of the Kubernetes of this node. |
| 3110 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 3111 | "conditions": [ # Which conditions caused the current node pool state. |
| 3112 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3113 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3114 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3115 | "message": "A String", # Human-friendly representation of the condition |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3116 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3117 | ], |
| 3118 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| 3119 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3120 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3121 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3122 | # |
| 3123 | # The following scopes are recommended, but not required, and by default are |
| 3124 | # not included: |
| 3125 | # |
| 3126 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3127 | # persistent storage on your nodes. |
| 3128 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3129 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3130 | # (the [Google Container |
| 3131 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3132 | # |
| 3133 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3134 | # 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] | 3135 | "A String", |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 3136 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3137 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3138 | # |
| 3139 | # For more information, including usage and the valid values, see: |
| 3140 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3141 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3142 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3143 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3144 | # See |
| 3145 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3146 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3147 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3148 | "value": "A String", # Value for taint. |
| 3149 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3150 | }, |
| 3151 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3152 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3153 | # These will added in addition to any default label(s) that |
| 3154 | # Kubernetes may apply to the node. |
| 3155 | # In case of conflict in label keys, the applied set may differ depending on |
| 3156 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3157 | # and conflicts should be avoided. |
| 3158 | # For more information, including usage and the valid values, see: |
| 3159 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3160 | "a_key": "A String", |
| 3161 | }, |
| 3162 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3163 | # The smallest allowed disk size is 10GB. |
| 3164 | # |
| 3165 | # If unspecified, the default disk size is 100GB. |
| 3166 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3167 | # workloads on the node pool. |
| 3168 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3169 | # on the node pool. |
| 3170 | }, |
| 3171 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3172 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3173 | # support for GPUs. |
| 3174 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3175 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3176 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3177 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3178 | }, |
| 3179 | ], |
| 3180 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 3181 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 3182 | # `n1-standard-1`). |
| 3183 | # |
| 3184 | # If unspecified, the default machine type is |
| 3185 | # `n1-standard-1`. |
| 3186 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3187 | # |
| 3188 | # If unspecified, the default disk type is 'pd-standard' |
| 3189 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3190 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 3191 | # |
| 3192 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3193 | # The attestation is performed against the integrity policy baseline. This |
| 3194 | # baseline is initially derived from the implicitly trusted boot image when |
| 3195 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3196 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3197 | # |
| 3198 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3199 | # verifying the digital signature of all boot components, and halting the |
| 3200 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3201 | }, |
| 3202 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3203 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3204 | # friendly names of CPU platforms, such as |
| 3205 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3206 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3207 | # information, read [how to specify min CPU |
| 3208 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3209 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3210 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3211 | # information about preemptible VM instances. |
| 3212 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3213 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3214 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3215 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3216 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3217 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3218 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3219 | "type": "A String", # Type of the sandbox to use for the node. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3220 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3221 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3222 | # |
| 3223 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3224 | # in length. These are reflected as part of a URL in the metadata server. |
| 3225 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3226 | # metadata keys for the project or be one of the reserved keys: |
| 3227 | # "cluster-location" |
| 3228 | # "cluster-name" |
| 3229 | # "cluster-uid" |
| 3230 | # "configure-sh" |
| 3231 | # "containerd-configure-sh" |
| 3232 | # "enable-os-login" |
| 3233 | # "gci-ensure-gke-docker" |
| 3234 | # "gci-metrics-enabled" |
| 3235 | # "gci-update-strategy" |
| 3236 | # "instance-template" |
| 3237 | # "kube-env" |
| 3238 | # "startup-script" |
| 3239 | # "user-data" |
| 3240 | # "disable-address-manager" |
| 3241 | # "windows-startup-script-ps1" |
| 3242 | # "common-psm1" |
| 3243 | # "k8s-node-setup-psm1" |
| 3244 | # "install-ssh-psm1" |
| 3245 | # "user-profile-psm1" |
| 3246 | # "serial-port-logging-enable" |
| 3247 | # |
| 3248 | # Values are free-form strings, and only have meaning as interpreted by |
| 3249 | # the image running in the instance. The only restriction placed on them is |
| 3250 | # that each value's size must be less than or equal to 32 KB. |
| 3251 | # |
| 3252 | # The total size of all keys and values must be less than 512 KB. |
| 3253 | "a_key": "A String", |
| 3254 | }, |
| 3255 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3256 | # the specified [Zonal Compute |
| 3257 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3258 | # to this node pool. |
| 3259 | # is the configuration of desired reservation which instances could take |
| 3260 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3261 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3262 | "A String", |
| 3263 | ], |
| 3264 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3265 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3266 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3267 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3268 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3269 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3270 | # valid sources or targets for network firewalls and are specified by |
| 3271 | # the client during cluster or node pool creation. Each tag within the list |
| 3272 | # must comply with RFC1035. |
| 3273 | "A String", |
| 3274 | ], |
| 3275 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3276 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3277 | # Account is specified, the "default" service account is used. |
| 3278 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3279 | # the latest version of it will be used. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3280 | }, |
| 3281 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 3282 | # simultaneously on a node in the node pool. |
| 3283 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 3284 | }, |
| 3285 | "name": "A String", # The name of the node pool. |
| 3286 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 3287 | # node pool. |
| 3288 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 3289 | # the Auto Upgrades will proceed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3290 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3291 | # with the approximate start time for the upgrades, in |
| 3292 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3293 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 3294 | # with the description of the upgrade. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3295 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3296 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 3297 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 3298 | # they fail health checks too many times, an automatic repair action will be |
| 3299 | # triggered. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3300 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 3301 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 3302 | # up to date with the latest release version of Kubernetes. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3303 | }, |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 3304 | }, |
| 3305 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3306 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| 3307 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Configuration options for the NetworkPolicy feature. |
| 3308 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 3309 | "provider": "A String", # The selected network policy provider. |
| 3310 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 3311 | }, |
| 3312 | "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in |
| 3313 | # this cluster, in |
| 3314 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3315 | # notation (e.g. `1.2.3.4/29`). Service addresses are |
| 3316 | # typically put in the last `/16` from the container CIDR. |
| 3317 | "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha |
| 3318 | # API groups (e.g. v1alpha1) and features that may not be production ready in |
| 3319 | # the kubernetes version of the master and nodes. |
| 3320 | # The cluster has no SLA for uptime and master/node upgrades are disabled. |
| 3321 | # Alpha enabled clusters are automatically deleted thirty days after |
| 3322 | # creation. |
| 3323 | "description": "A String", # An optional description of this cluster. |
| 3324 | "conditions": [ # Which conditions caused the current cluster state. |
| 3325 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3326 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3327 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3328 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3329 | }, |
| 3330 | ], |
| 3331 | "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. |
| 3332 | # Call Kubernetes API directly to retrieve node information. |
| 3333 | "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3334 | # Currently available options: |
| 3335 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3336 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3337 | # service with a Kubernetes-native resource model |
| 3338 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 3339 | # longer available as of GKE 1.15). |
| 3340 | # * `none` - No metrics will be exported from the cluster. |
| 3341 | # |
| 3342 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 3343 | # 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] | 3344 | "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 3345 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 3346 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 3347 | "state": "A String", # Denotes the state of etcd encryption. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 3348 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3349 | "binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization. |
| 3350 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 3351 | # images will be validated by Binary Authorization. |
| 3352 | }, |
| 3353 | "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in |
| 3354 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 3355 | # notation (e.g. `1.2.3.4/29`). |
| 3356 | "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for the use of Kubernetes Service Accounts in GCP IAM |
| 3357 | # policies. |
| 3358 | # policies. |
| 3359 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 3360 | }, |
| 3361 | "zone": "A String", # [Output only] The name of the Google Compute Engine |
| 3362 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3363 | # cluster resides. This field is deprecated, use location instead. |
| 3364 | "expireTime": "A String", # [Output only] The time the cluster will be automatically |
| 3365 | # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 3366 | "loggingService": "A String", # The logging service the cluster should use to write logs. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3367 | # Currently available options: |
| 3368 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3369 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3370 | # service with a Kubernetes-native resource model |
| 3371 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3372 | # available as of GKE 1.15). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3373 | # * `none` - no logs will be exported from the cluster. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3374 | # |
| 3375 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3376 | # 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] | 3377 | "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3378 | # 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] | 3379 | # "node_pool" object, since this configuration (along with the |
| 3380 | # "initial_node_count") will be used to create a "NodePool" object with an |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3381 | # auto-generated name. Do not use this and a node_pool at the same time. |
| 3382 | # For responses, this field will be populated with the node configuration of |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3383 | # the first node pool. (For configuration of each node pool, see |
| 3384 | # `node_pool.config`) |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3385 | # |
| 3386 | # If unspecified, the defaults are used. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3387 | # This field is deprecated, use node_pool.config instead. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3388 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 3389 | # node VMs under the "default" service account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3390 | # |
| 3391 | # The following scopes are recommended, but not required, and by default are |
| 3392 | # not included: |
| 3393 | # |
| 3394 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 3395 | # persistent storage on your nodes. |
| 3396 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 3397 | # communicating with **gcr.io** |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3398 | # (the [Google Container |
| 3399 | # Registry](https://cloud.google.com/container-registry/)). |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3400 | # |
| 3401 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 3402 | # 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] | 3403 | "A String", |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3404 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3405 | "taints": [ # List of kubernetes taints to be applied to each node. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3406 | # |
| 3407 | # For more information, including usage and the valid values, see: |
| 3408 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 3409 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 3410 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 3411 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3412 | # See |
| 3413 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 3414 | # for more information, including usage and the valid values. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3415 | "effect": "A String", # Effect for taint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3416 | "value": "A String", # Value for taint. |
| 3417 | "key": "A String", # Key for taint. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3418 | }, |
| 3419 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3420 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 3421 | # These will added in addition to any default label(s) that |
| 3422 | # Kubernetes may apply to the node. |
| 3423 | # In case of conflict in label keys, the applied set may differ depending on |
| 3424 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 3425 | # and conflicts should be avoided. |
| 3426 | # For more information, including usage and the valid values, see: |
| 3427 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 3428 | "a_key": "A String", |
| 3429 | }, |
| 3430 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 3431 | # The smallest allowed disk size is 10GB. |
| 3432 | # |
| 3433 | # If unspecified, the default disk size is 100GB. |
| 3434 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 3435 | # workloads on the node pool. |
| 3436 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 3437 | # on the node pool. |
| 3438 | }, |
| 3439 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 3440 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 3441 | # support for GPUs. |
| 3442 | { # AcceleratorConfig represents a Hardware Accelerator request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3443 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 3444 | # [here](https://cloud.google.com/compute/docs/gpus) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3445 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3446 | }, |
| 3447 | ], |
| 3448 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 3449 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 3450 | # `n1-standard-1`). |
| 3451 | # |
| 3452 | # If unspecified, the default machine type is |
| 3453 | # `n1-standard-1`. |
| 3454 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| 3455 | # |
| 3456 | # If unspecified, the default disk type is 'pd-standard' |
| 3457 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3458 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 3459 | # |
| 3460 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 3461 | # The attestation is performed against the integrity policy baseline. This |
| 3462 | # baseline is initially derived from the implicitly trusted boot image when |
| 3463 | # the instance is created. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3464 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 3465 | # |
| 3466 | # Secure Boot helps ensure that the system only runs authentic software by |
| 3467 | # verifying the digital signature of all boot components, and halting the |
| 3468 | # boot process if signature verification fails. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3469 | }, |
| 3470 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 3471 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 3472 | # friendly names of CPU platforms, such as |
| 3473 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 3474 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 3475 | # information, read [how to specify min CPU |
| 3476 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 3477 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 3478 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 3479 | # information about preemptible VM instances. |
| 3480 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3481 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3482 | # The limit for this value is dependent upon the maximum number of |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3483 | # disks available on a machine per zone. See: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3484 | # https://cloud.google.com/compute/docs/disks/local-ssd |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3485 | # for more information. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3486 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 3487 | "type": "A String", # Type of the sandbox to use for the node. |
| 3488 | }, |
| 3489 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 3490 | # |
| 3491 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 3492 | # in length. These are reflected as part of a URL in the metadata server. |
| 3493 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 3494 | # metadata keys for the project or be one of the reserved keys: |
| 3495 | # "cluster-location" |
| 3496 | # "cluster-name" |
| 3497 | # "cluster-uid" |
| 3498 | # "configure-sh" |
| 3499 | # "containerd-configure-sh" |
| 3500 | # "enable-os-login" |
| 3501 | # "gci-ensure-gke-docker" |
| 3502 | # "gci-metrics-enabled" |
| 3503 | # "gci-update-strategy" |
| 3504 | # "instance-template" |
| 3505 | # "kube-env" |
| 3506 | # "startup-script" |
| 3507 | # "user-data" |
| 3508 | # "disable-address-manager" |
| 3509 | # "windows-startup-script-ps1" |
| 3510 | # "common-psm1" |
| 3511 | # "k8s-node-setup-psm1" |
| 3512 | # "install-ssh-psm1" |
| 3513 | # "user-profile-psm1" |
| 3514 | # "serial-port-logging-enable" |
| 3515 | # |
| 3516 | # Values are free-form strings, and only have meaning as interpreted by |
| 3517 | # the image running in the instance. The only restriction placed on them is |
| 3518 | # that each value's size must be less than or equal to 32 KB. |
| 3519 | # |
| 3520 | # The total size of all keys and values must be less than 512 KB. |
| 3521 | "a_key": "A String", |
| 3522 | }, |
| 3523 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 3524 | # the specified [Zonal Compute |
| 3525 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 3526 | # to this node pool. |
| 3527 | # is the configuration of desired reservation which instances could take |
| 3528 | # capacity from. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3529 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 3530 | "A String", |
| 3531 | ], |
| 3532 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3533 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 3534 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 3535 | # the key and specify the name of your reservation as its value. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3536 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3537 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 3538 | # valid sources or targets for network firewalls and are specified by |
| 3539 | # the client during cluster or node pool creation. Each tag within the list |
| 3540 | # must comply with RFC1035. |
| 3541 | "A String", |
| 3542 | ], |
| 3543 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| 3544 | # Specify the email address of the Service Account; otherwise, if no Service |
| 3545 | # Account is specified, the "default" service account is used. |
| 3546 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 3547 | # the latest version of it will be used. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 3548 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3549 | "status": "A String", # [Output only] The current status of this cluster. |
| 3550 | "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3551 | "enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. |
| 3552 | # This makes same node pod to pod traffic visible for VPC network. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3553 | "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine |
| 3554 | # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the |
| 3555 | # cluster is connected. Example: |
| 3556 | # projects/my-project/regions/us-central1/subnetworks/my-subnet |
| 3557 | "network": "A String", # Output only. The relative name of the Google Compute Engine |
| 3558 | # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) |
| 3559 | # to which the cluster is connected. Example: |
| 3560 | # projects/my-project/global/networks/my-network |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3561 | }, |
| 3562 | "name": "A String", # The name of this cluster. The name must be unique within this project |
| 3563 | # and location (e.g. zone or region), and can be up to 40 characters with |
| 3564 | # the following restrictions: |
| 3565 | # |
| 3566 | # * Lowercase letters, numbers, and hyphens only. |
| 3567 | # * Must start with a letter. |
| 3568 | # * Must end with a number or a letter. |
| 3569 | "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. |
| 3570 | # The endpoint can be accessed from the internet at |
| 3571 | # `https://username:password@endpoint/`. |
| 3572 | # |
| 3573 | # See the `masterAuth` property of this resource for username and |
| 3574 | # password information. |
| 3575 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 3576 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3577 | # or |
| 3578 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3579 | # in which the cluster resides. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3580 | }, |
| 3581 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3582 | "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] | 3583 | # may be missing those zones. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3584 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3585 | ], |
| 3586 | }</pre> |
| 3587 | </div> |
| 3588 | |
| 3589 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3590 | <code class="details" id="locations">locations(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3591 | <pre>Sets the locations for a specific cluster. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3592 | Deprecated. Use |
| 3593 | [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) |
| 3594 | instead. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3595 | |
| 3596 | Args: |
| 3597 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 3598 | number](https://support.google.com/cloud/answer/6158840). |
| 3599 | This field has been deprecated and replaced by the name field. (required) |
| 3600 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3601 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3602 | cluster resides. This field has been deprecated and replaced by the name |
| 3603 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3604 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 3605 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3606 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3607 | The object takes the form of: |
| 3608 | |
| 3609 | { # SetLocationsRequest sets the locations of the cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3610 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3611 | # This field has been deprecated and replaced by the name field. |
| 3612 | "name": "A String", # The name (project, location, cluster) of the cluster to set locations. |
| 3613 | # Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3614 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3615 | # number](https://support.google.com/cloud/answer/6158840). |
| 3616 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3617 | "locations": [ # Required. The desired list of Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3618 | # [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] | 3619 | # 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] | 3620 | # will result in nodes being either created or removed from the cluster, |
| 3621 | # depending on whether locations are being added or removed. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3622 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3623 | # This list must always include the cluster's primary zone. |
| 3624 | "A String", |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3625 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3626 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3627 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3628 | # cluster resides. This field has been deprecated and replaced by the name |
| 3629 | # field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3630 | } |
| 3631 | |
| 3632 | x__xgafv: string, V1 error format. |
| 3633 | Allowed values |
| 3634 | 1 - v1 error format |
| 3635 | 2 - v2 error format |
| 3636 | |
| 3637 | Returns: |
| 3638 | An object of the form: |
| 3639 | |
| 3640 | { # This operation resource represents operations that may have happened or are |
| 3641 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3642 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3643 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3644 | # (e.g., ERROR or DEGRADED). |
| 3645 | "code": "A String", # Machine-friendly representation of the condition |
| 3646 | "message": "A String", # Human-friendly representation of the condition |
| 3647 | }, |
| 3648 | ], |
| 3649 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3650 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3651 | # Unset for single-stage operations. |
| 3652 | "stages": [ # Substages of an operation or a stage. |
| 3653 | # Object with schema name: OperationProgress |
| 3654 | ], |
| 3655 | "metrics": [ # Progress metric bundle, for example: |
| 3656 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3657 | # {name: "nodes total", int_value: 32}] |
| 3658 | # or |
| 3659 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3660 | # {name: "progress scale", double_value: 1.0}] |
| 3661 | { # Progress metric is (string, int|float|string) pair. |
| 3662 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3663 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3664 | "intValue": "A String", # For metrics with integer value. |
| 3665 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3666 | }, |
| 3667 | ], |
| 3668 | "status": "A String", # Status of an operation stage. |
| 3669 | # Unset for single-stage operations. |
| 3670 | }, |
| 3671 | "zone": "A String", # The name of the Google Compute Engine |
| 3672 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3673 | # operation is taking place. This field is deprecated, use location instead. |
| 3674 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3675 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3676 | "detail": "A String", # Detailed operation progress, if available. |
| 3677 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3678 | "operationType": "A String", # The operation type. |
| 3679 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3680 | "name": "A String", # The server-assigned ID for the operation. |
| 3681 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3682 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3683 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3684 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3685 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3686 | }, |
| 3687 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3688 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3689 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3690 | "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] | 3691 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3692 | # or |
| 3693 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3694 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3695 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3696 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3697 | }</pre> |
| 3698 | </div> |
| 3699 | |
| 3700 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3701 | <code class="details" id="logging">logging(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3702 | <pre>Sets the logging service for a specific cluster. |
| 3703 | |
| 3704 | Args: |
| 3705 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 3706 | number](https://support.google.com/cloud/answer/6158840). |
| 3707 | This field has been deprecated and replaced by the name field. (required) |
| 3708 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3709 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3710 | cluster resides. This field has been deprecated and replaced by the name |
| 3711 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3712 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 3713 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3714 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3715 | The object takes the form of: |
| 3716 | |
| 3717 | { # SetLoggingServiceRequest sets the logging service of a cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3718 | "name": "A String", # The name (project, location, cluster) of the cluster to set logging. |
| 3719 | # Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3720 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3721 | # number](https://support.google.com/cloud/answer/6158840). |
| 3722 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3723 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3724 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3725 | # cluster resides. This field has been deprecated and replaced by the name |
| 3726 | # field. |
| 3727 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3728 | # This field has been deprecated and replaced by the name field. |
| 3729 | "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] | 3730 | # Currently available options: |
| 3731 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3732 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 3733 | # service with a Kubernetes-native resource model |
| 3734 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 3735 | # available as of GKE 1.15). |
| 3736 | # * `none` - no logs will be exported from the cluster. |
| 3737 | # |
| 3738 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 3739 | # 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] | 3740 | } |
| 3741 | |
| 3742 | x__xgafv: string, V1 error format. |
| 3743 | Allowed values |
| 3744 | 1 - v1 error format |
| 3745 | 2 - v2 error format |
| 3746 | |
| 3747 | Returns: |
| 3748 | An object of the form: |
| 3749 | |
| 3750 | { # This operation resource represents operations that may have happened or are |
| 3751 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3752 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3753 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3754 | # (e.g., ERROR or DEGRADED). |
| 3755 | "code": "A String", # Machine-friendly representation of the condition |
| 3756 | "message": "A String", # Human-friendly representation of the condition |
| 3757 | }, |
| 3758 | ], |
| 3759 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3760 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3761 | # Unset for single-stage operations. |
| 3762 | "stages": [ # Substages of an operation or a stage. |
| 3763 | # Object with schema name: OperationProgress |
| 3764 | ], |
| 3765 | "metrics": [ # Progress metric bundle, for example: |
| 3766 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3767 | # {name: "nodes total", int_value: 32}] |
| 3768 | # or |
| 3769 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3770 | # {name: "progress scale", double_value: 1.0}] |
| 3771 | { # Progress metric is (string, int|float|string) pair. |
| 3772 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3773 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3774 | "intValue": "A String", # For metrics with integer value. |
| 3775 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3776 | }, |
| 3777 | ], |
| 3778 | "status": "A String", # Status of an operation stage. |
| 3779 | # Unset for single-stage operations. |
| 3780 | }, |
| 3781 | "zone": "A String", # The name of the Google Compute Engine |
| 3782 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3783 | # operation is taking place. This field is deprecated, use location instead. |
| 3784 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3785 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3786 | "detail": "A String", # Detailed operation progress, if available. |
| 3787 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3788 | "operationType": "A String", # The operation type. |
| 3789 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3790 | "name": "A String", # The server-assigned ID for the operation. |
| 3791 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3792 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3793 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3794 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3795 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3796 | }, |
| 3797 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3798 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3799 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3800 | "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] | 3801 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3802 | # or |
| 3803 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3804 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3805 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3806 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3807 | }</pre> |
| 3808 | </div> |
| 3809 | |
| 3810 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3811 | <code class="details" id="master">master(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3812 | <pre>Updates the master for a specific cluster. |
| 3813 | |
| 3814 | Args: |
| 3815 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 3816 | number](https://support.google.com/cloud/answer/6158840). |
| 3817 | This field has been deprecated and replaced by the name field. (required) |
| 3818 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3819 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3820 | cluster resides. This field has been deprecated and replaced by the name |
| 3821 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3822 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 3823 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3824 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3825 | The object takes the form of: |
| 3826 | |
| 3827 | { # UpdateMasterRequest updates the master of the cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3828 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3829 | # number](https://support.google.com/cloud/answer/6158840). |
| 3830 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3831 | "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] | 3832 | # |
| 3833 | # Users may specify either explicit versions offered by Kubernetes Engine or |
| 3834 | # version aliases, which have the following behavior: |
| 3835 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3836 | # - "latest": picks the highest valid Kubernetes version |
| 3837 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 3838 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 3839 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 3840 | # - "-": picks the default Kubernetes version |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3841 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 3842 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3843 | # cluster resides. This field has been deprecated and replaced by the name |
| 3844 | # field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3845 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3846 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3847 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 3848 | # Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3849 | } |
| 3850 | |
| 3851 | x__xgafv: string, V1 error format. |
| 3852 | Allowed values |
| 3853 | 1 - v1 error format |
| 3854 | 2 - v2 error format |
| 3855 | |
| 3856 | Returns: |
| 3857 | An object of the form: |
| 3858 | |
| 3859 | { # This operation resource represents operations that may have happened or are |
| 3860 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3861 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3862 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3863 | # (e.g., ERROR or DEGRADED). |
| 3864 | "code": "A String", # Machine-friendly representation of the condition |
| 3865 | "message": "A String", # Human-friendly representation of the condition |
| 3866 | }, |
| 3867 | ], |
| 3868 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3869 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3870 | # Unset for single-stage operations. |
| 3871 | "stages": [ # Substages of an operation or a stage. |
| 3872 | # Object with schema name: OperationProgress |
| 3873 | ], |
| 3874 | "metrics": [ # Progress metric bundle, for example: |
| 3875 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3876 | # {name: "nodes total", int_value: 32}] |
| 3877 | # or |
| 3878 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3879 | # {name: "progress scale", double_value: 1.0}] |
| 3880 | { # Progress metric is (string, int|float|string) pair. |
| 3881 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3882 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3883 | "intValue": "A String", # For metrics with integer value. |
| 3884 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3885 | }, |
| 3886 | ], |
| 3887 | "status": "A String", # Status of an operation stage. |
| 3888 | # Unset for single-stage operations. |
| 3889 | }, |
| 3890 | "zone": "A String", # The name of the Google Compute Engine |
| 3891 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3892 | # operation is taking place. This field is deprecated, use location instead. |
| 3893 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 3894 | "selfLink": "A String", # Server-defined URL for the resource. |
| 3895 | "detail": "A String", # Detailed operation progress, if available. |
| 3896 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 3897 | "operationType": "A String", # The operation type. |
| 3898 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3899 | "name": "A String", # The server-assigned ID for the operation. |
| 3900 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3901 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3902 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3903 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3904 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3905 | }, |
| 3906 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3907 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3908 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3909 | "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] | 3910 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3911 | # or |
| 3912 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 3913 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3914 | "startTime": "A String", # [Output only] The time the operation started, in |
| 3915 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3916 | }</pre> |
| 3917 | </div> |
| 3918 | |
| 3919 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3920 | <code class="details" id="monitoring">monitoring(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3921 | <pre>Sets the monitoring service for a specific cluster. |
| 3922 | |
| 3923 | Args: |
| 3924 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 3925 | number](https://support.google.com/cloud/answer/6158840). |
| 3926 | This field has been deprecated and replaced by the name field. (required) |
| 3927 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3928 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3929 | cluster resides. This field has been deprecated and replaced by the name |
| 3930 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3931 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 3932 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3933 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3934 | The object takes the form of: |
| 3935 | |
| 3936 | { # SetMonitoringServiceRequest sets the monitoring service of a cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3937 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 3938 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3939 | "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] | 3940 | # Currently available options: |
| 3941 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3942 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3943 | # service with a Kubernetes-native resource model |
| 3944 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 3945 | # longer available as of GKE 1.15). |
| 3946 | # * `none` - No metrics will be exported from the cluster. |
| 3947 | # |
| 3948 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 3949 | # 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] | 3950 | "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. |
| 3951 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 3952 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 3953 | # number](https://support.google.com/cloud/answer/6158840). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3954 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3955 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3956 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 3957 | # cluster resides. This field has been deprecated and replaced by the name |
| 3958 | # field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3959 | } |
| 3960 | |
| 3961 | x__xgafv: string, V1 error format. |
| 3962 | Allowed values |
| 3963 | 1 - v1 error format |
| 3964 | 2 - v2 error format |
| 3965 | |
| 3966 | Returns: |
| 3967 | An object of the form: |
| 3968 | |
| 3969 | { # This operation resource represents operations that may have happened or are |
| 3970 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3971 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 3972 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 3973 | # (e.g., ERROR or DEGRADED). |
| 3974 | "code": "A String", # Machine-friendly representation of the condition |
| 3975 | "message": "A String", # Human-friendly representation of the condition |
| 3976 | }, |
| 3977 | ], |
| 3978 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 3979 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 3980 | # Unset for single-stage operations. |
| 3981 | "stages": [ # Substages of an operation or a stage. |
| 3982 | # Object with schema name: OperationProgress |
| 3983 | ], |
| 3984 | "metrics": [ # Progress metric bundle, for example: |
| 3985 | # metrics: [{name: "nodes done", int_value: 15}, |
| 3986 | # {name: "nodes total", int_value: 32}] |
| 3987 | # or |
| 3988 | # metrics: [{name: "progress", double_value: 0.56}, |
| 3989 | # {name: "progress scale", double_value: 1.0}] |
| 3990 | { # Progress metric is (string, int|float|string) pair. |
| 3991 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 3992 | "doubleValue": 3.14, # For metrics with floating point value. |
| 3993 | "intValue": "A String", # For metrics with integer value. |
| 3994 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 3995 | }, |
| 3996 | ], |
| 3997 | "status": "A String", # Status of an operation stage. |
| 3998 | # Unset for single-stage operations. |
| 3999 | }, |
| 4000 | "zone": "A String", # The name of the Google Compute Engine |
| 4001 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4002 | # operation is taking place. This field is deprecated, use location instead. |
| 4003 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4004 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4005 | "detail": "A String", # Detailed operation progress, if available. |
| 4006 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4007 | "operationType": "A String", # The operation type. |
| 4008 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4009 | "name": "A String", # The server-assigned ID for the operation. |
| 4010 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4011 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4012 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4013 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4014 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4015 | }, |
| 4016 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4017 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4018 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4019 | "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] | 4020 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4021 | # or |
| 4022 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4023 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4024 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4025 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4026 | }</pre> |
| 4027 | </div> |
| 4028 | |
| 4029 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4030 | <code class="details" id="resourceLabels">resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4031 | <pre>Sets labels on a cluster. |
| 4032 | |
| 4033 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4034 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 4035 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 4036 | This field has been deprecated and replaced by the name field. (required) |
| 4037 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4038 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4039 | cluster resides. This field has been deprecated and replaced by the name |
| 4040 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4041 | clusterId: string, Deprecated. The name of the cluster. |
| 4042 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4043 | body: object, The request body. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4044 | The object takes the form of: |
| 4045 | |
| 4046 | { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container |
| 4047 | # Engine cluster, which will in turn set them for Google Compute Engine |
| 4048 | # resources used by that cluster |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4049 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4050 | # This field has been deprecated and replaced by the name field. |
| 4051 | "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4052 | # used to detect conflicts. The fingerprint is initially generated by |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4053 | # Kubernetes Engine and changes after every request to modify or update |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4054 | # 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] | 4055 | # updating or changing labels. Make a <code>get()</code> request to the |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4056 | # resource to get the latest fingerprint. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4057 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4058 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4059 | # cluster resides. This field has been deprecated and replaced by the name |
| 4060 | # field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4061 | "name": "A String", # The name (project, location, cluster id) of the cluster to set labels. |
| 4062 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4063 | "resourceLabels": { # Required. The labels to set for that cluster. |
| 4064 | "a_key": "A String", |
| 4065 | }, |
| 4066 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4067 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4068 | # This field has been deprecated and replaced by the name field. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4069 | } |
| 4070 | |
| 4071 | x__xgafv: string, V1 error format. |
| 4072 | Allowed values |
| 4073 | 1 - v1 error format |
| 4074 | 2 - v2 error format |
| 4075 | |
| 4076 | Returns: |
| 4077 | An object of the form: |
| 4078 | |
| 4079 | { # This operation resource represents operations that may have happened or are |
| 4080 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4081 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4082 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4083 | # (e.g., ERROR or DEGRADED). |
| 4084 | "code": "A String", # Machine-friendly representation of the condition |
| 4085 | "message": "A String", # Human-friendly representation of the condition |
| 4086 | }, |
| 4087 | ], |
| 4088 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4089 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4090 | # Unset for single-stage operations. |
| 4091 | "stages": [ # Substages of an operation or a stage. |
| 4092 | # Object with schema name: OperationProgress |
| 4093 | ], |
| 4094 | "metrics": [ # Progress metric bundle, for example: |
| 4095 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4096 | # {name: "nodes total", int_value: 32}] |
| 4097 | # or |
| 4098 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4099 | # {name: "progress scale", double_value: 1.0}] |
| 4100 | { # Progress metric is (string, int|float|string) pair. |
| 4101 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4102 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4103 | "intValue": "A String", # For metrics with integer value. |
| 4104 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4105 | }, |
| 4106 | ], |
| 4107 | "status": "A String", # Status of an operation stage. |
| 4108 | # Unset for single-stage operations. |
| 4109 | }, |
| 4110 | "zone": "A String", # The name of the Google Compute Engine |
| 4111 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4112 | # operation is taking place. This field is deprecated, use location instead. |
| 4113 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4114 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4115 | "detail": "A String", # Detailed operation progress, if available. |
| 4116 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4117 | "operationType": "A String", # The operation type. |
| 4118 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4119 | "name": "A String", # The server-assigned ID for the operation. |
| 4120 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4121 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4122 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4123 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4124 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4125 | }, |
| 4126 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4127 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4128 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4129 | "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] | 4130 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4131 | # or |
| 4132 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4133 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4134 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4135 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4136 | }</pre> |
| 4137 | </div> |
| 4138 | |
| 4139 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4140 | <code class="details" id="setMaintenancePolicy">setMaintenancePolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4141 | <pre>Sets the maintenance policy for a cluster. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4142 | |
| 4143 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4144 | projectId: string, Required. The Google Developers Console [project ID or project |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4145 | number](https://support.google.com/cloud/answer/6158840). (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4146 | zone: string, Required. The name of the Google Compute Engine |
| 4147 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4148 | cluster resides. (required) |
| 4149 | clusterId: string, Required. The name of the cluster to update. (required) |
| 4150 | body: object, The request body. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4151 | The object takes the form of: |
| 4152 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4153 | { # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4154 | "name": "A String", # The name (project, location, cluster id) of the cluster to set maintenance |
| 4155 | # policy. |
| 4156 | # Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4157 | "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] | 4158 | # clears the existing maintenance policy. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4159 | "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4160 | "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not |
| 4161 | # occur in these windows. |
| 4162 | "a_key": { # Represents an arbitrary window of time. |
| 4163 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 4164 | # start time. |
| 4165 | "startTime": "A String", # The time that the window first starts. |
| 4166 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4167 | }, |
| 4168 | "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] | 4169 | # maintenance to occur. The time windows may be overlapping. If no |
| 4170 | # maintenance windows are set, maintenance can occur at any time. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4171 | "window": { # Represents an arbitrary window of time. # The window of the first recurrence. |
| 4172 | "endTime": "A String", # The time that the window ends. The end time should take place after the |
| 4173 | # start time. |
| 4174 | "startTime": "A String", # The time that the window first starts. |
| 4175 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4176 | "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] | 4177 | # this window reccurs. They go on for the span of time between the start and |
| 4178 | # end time. |
| 4179 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4180 | # For example, to have something repeat every weekday, you'd use: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4181 | # <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> |
| 4182 | # To repeat some window daily (equivalent to the DailyMaintenanceWindow): |
| 4183 | # <code>FREQ=DAILY</code> |
| 4184 | # For the first weekend of every month: |
| 4185 | # <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> |
| 4186 | # 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] | 4187 | # 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] | 4188 | # <code> |
| 4189 | # start time = 2019-01-01T09:00:00-0400 |
| 4190 | # end time = 2019-01-01T17:00:00-0400 |
| 4191 | # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR |
| 4192 | # </code> |
| 4193 | # Windows can span multiple days. Eg, to make the window encompass every |
| 4194 | # weekend from midnight Saturday till the last minute of Sunday UTC: |
| 4195 | # <code> |
| 4196 | # start time = 2019-01-05T00:00:00Z |
| 4197 | # end time = 2019-01-07T23:59:00Z |
| 4198 | # recurrence = FREQ=WEEKLY;BYDAY=SA |
| 4199 | # </code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4200 | # 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] | 4201 | # to specify duration of the window and when it first starts. |
| 4202 | # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4203 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4204 | "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. |
| 4205 | "startTime": "A String", # Time within the maintenance window to start the maintenance operations. |
| 4206 | # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 4207 | # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. |
| 4208 | "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be |
| 4209 | # smallest possible in the given scenario. |
| 4210 | # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) |
| 4211 | # format "PTnHnMnS". |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4212 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4213 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4214 | "resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of |
| 4215 | # the policy won't accidentally undo intermediate changes (and so that users |
| 4216 | # of the API unaware of some fields won't accidentally remove other fields). |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4217 | # Make a <code>get()</code> request to the cluster to get the current |
| 4218 | # resource version and include it with requests to set the policy. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4219 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4220 | "projectId": "A String", # Required. The Google Developers Console [project ID or project |
| 4221 | # number](https://support.google.com/cloud/answer/6158840). |
| 4222 | "zone": "A String", # Required. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4223 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4224 | # cluster resides. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4225 | "clusterId": "A String", # Required. The name of the cluster to update. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4226 | } |
| 4227 | |
| 4228 | x__xgafv: string, V1 error format. |
| 4229 | Allowed values |
| 4230 | 1 - v1 error format |
| 4231 | 2 - v2 error format |
| 4232 | |
| 4233 | Returns: |
| 4234 | An object of the form: |
| 4235 | |
| 4236 | { # This operation resource represents operations that may have happened or are |
| 4237 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4238 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4239 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4240 | # (e.g., ERROR or DEGRADED). |
| 4241 | "code": "A String", # Machine-friendly representation of the condition |
| 4242 | "message": "A String", # Human-friendly representation of the condition |
| 4243 | }, |
| 4244 | ], |
| 4245 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4246 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4247 | # Unset for single-stage operations. |
| 4248 | "stages": [ # Substages of an operation or a stage. |
| 4249 | # Object with schema name: OperationProgress |
| 4250 | ], |
| 4251 | "metrics": [ # Progress metric bundle, for example: |
| 4252 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4253 | # {name: "nodes total", int_value: 32}] |
| 4254 | # or |
| 4255 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4256 | # {name: "progress scale", double_value: 1.0}] |
| 4257 | { # Progress metric is (string, int|float|string) pair. |
| 4258 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4259 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4260 | "intValue": "A String", # For metrics with integer value. |
| 4261 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4262 | }, |
| 4263 | ], |
| 4264 | "status": "A String", # Status of an operation stage. |
| 4265 | # Unset for single-stage operations. |
| 4266 | }, |
| 4267 | "zone": "A String", # The name of the Google Compute Engine |
| 4268 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4269 | # operation is taking place. This field is deprecated, use location instead. |
| 4270 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4271 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4272 | "detail": "A String", # Detailed operation progress, if available. |
| 4273 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4274 | "operationType": "A String", # The operation type. |
| 4275 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4276 | "name": "A String", # The server-assigned ID for the operation. |
| 4277 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4278 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4279 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4280 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4281 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4282 | }, |
| 4283 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4284 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4285 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4286 | "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] | 4287 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4288 | # or |
| 4289 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4290 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4291 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4292 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4293 | }</pre> |
| 4294 | </div> |
| 4295 | |
| 4296 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4297 | <code class="details" id="setMasterAuth">setMasterAuth(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4298 | <pre>Sets master auth materials. Currently supports changing the admin password |
| 4299 | or a specific cluster, either via password generation or explicitly setting |
| 4300 | the password. |
| 4301 | |
| 4302 | Args: |
| 4303 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 4304 | number](https://support.google.com/cloud/answer/6158840). |
| 4305 | This field has been deprecated and replaced by the name field. (required) |
| 4306 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4307 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4308 | cluster resides. This field has been deprecated and replaced by the name |
| 4309 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4310 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 4311 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4312 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4313 | The object takes the form of: |
| 4314 | |
| 4315 | { # SetMasterAuthRequest updates the admin password of a cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4316 | "name": "A String", # The name (project, location, cluster) of the cluster to set auth. |
| 4317 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4318 | "action": "A String", # Required. The exact form of action to be taken on the master auth. |
| 4319 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4320 | # number](https://support.google.com/cloud/answer/6158840). |
| 4321 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4322 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4323 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4324 | "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] | 4325 | # Authentication can be done using HTTP basic auth or using client |
| 4326 | # certificates. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4327 | "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] | 4328 | # Because the master endpoint is open to the Internet, you should create a |
| 4329 | # strong password. If a password is provided for cluster creation, username |
| 4330 | # must be non-empty. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4331 | "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] | 4332 | # clusters before v1.12, if no configuration is specified, a client |
| 4333 | # certificate is issued. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4334 | "issueClientCertificate": True or False, # Issue a client certificate. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4335 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4336 | "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate |
| 4337 | # to the cluster endpoint. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4338 | "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of |
| 4339 | # trust for the cluster. |
| 4340 | "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to |
| 4341 | # authenticate to the cluster endpoint. |
| 4342 | "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. |
| 4343 | # For clusters v1.6.0 and later, basic authentication can be disabled by |
| 4344 | # leaving username unspecified (or setting it to the empty string). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4345 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4346 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4347 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4348 | # cluster resides. This field has been deprecated and replaced by the name |
| 4349 | # field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4350 | } |
| 4351 | |
| 4352 | x__xgafv: string, V1 error format. |
| 4353 | Allowed values |
| 4354 | 1 - v1 error format |
| 4355 | 2 - v2 error format |
| 4356 | |
| 4357 | Returns: |
| 4358 | An object of the form: |
| 4359 | |
| 4360 | { # This operation resource represents operations that may have happened or are |
| 4361 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4362 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4363 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4364 | # (e.g., ERROR or DEGRADED). |
| 4365 | "code": "A String", # Machine-friendly representation of the condition |
| 4366 | "message": "A String", # Human-friendly representation of the condition |
| 4367 | }, |
| 4368 | ], |
| 4369 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4370 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4371 | # Unset for single-stage operations. |
| 4372 | "stages": [ # Substages of an operation or a stage. |
| 4373 | # Object with schema name: OperationProgress |
| 4374 | ], |
| 4375 | "metrics": [ # Progress metric bundle, for example: |
| 4376 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4377 | # {name: "nodes total", int_value: 32}] |
| 4378 | # or |
| 4379 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4380 | # {name: "progress scale", double_value: 1.0}] |
| 4381 | { # Progress metric is (string, int|float|string) pair. |
| 4382 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4383 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4384 | "intValue": "A String", # For metrics with integer value. |
| 4385 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4386 | }, |
| 4387 | ], |
| 4388 | "status": "A String", # Status of an operation stage. |
| 4389 | # Unset for single-stage operations. |
| 4390 | }, |
| 4391 | "zone": "A String", # The name of the Google Compute Engine |
| 4392 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4393 | # operation is taking place. This field is deprecated, use location instead. |
| 4394 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4395 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4396 | "detail": "A String", # Detailed operation progress, if available. |
| 4397 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4398 | "operationType": "A String", # The operation type. |
| 4399 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4400 | "name": "A String", # The server-assigned ID for the operation. |
| 4401 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4402 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4403 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4404 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4405 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4406 | }, |
| 4407 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4408 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4409 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4410 | "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] | 4411 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4412 | # or |
| 4413 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4414 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4415 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4416 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4417 | }</pre> |
| 4418 | </div> |
| 4419 | |
| 4420 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4421 | <code class="details" id="setNetworkPolicy">setNetworkPolicy(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4422 | <pre>Enables or disables Network Policy for a cluster. |
| 4423 | |
| 4424 | Args: |
| 4425 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 4426 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 4427 | This field has been deprecated and replaced by the name field. (required) |
| 4428 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4429 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4430 | cluster resides. This field has been deprecated and replaced by the name |
| 4431 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4432 | clusterId: string, Deprecated. The name of the cluster. |
| 4433 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4434 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4435 | The object takes the form of: |
| 4436 | |
| 4437 | { # SetNetworkPolicyRequest enables/disables network policy for a cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4438 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4439 | # This field has been deprecated and replaced by the name field. |
| 4440 | "networkPolicy": { # Configuration options for the NetworkPolicy feature. # Required. Configuration options for the NetworkPolicy feature. |
| 4441 | # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ |
| 4442 | "provider": "A String", # The selected network policy provider. |
| 4443 | "enabled": True or False, # Whether network policy is enabled on the cluster. |
| 4444 | }, |
| 4445 | "name": "A String", # The name (project, location, cluster id) of the cluster to set networking |
| 4446 | # policy. Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4447 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4448 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4449 | # This field has been deprecated and replaced by the name field. |
| 4450 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
| 4451 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4452 | # cluster resides. This field has been deprecated and replaced by the name |
| 4453 | # field. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4454 | } |
| 4455 | |
| 4456 | x__xgafv: string, V1 error format. |
| 4457 | Allowed values |
| 4458 | 1 - v1 error format |
| 4459 | 2 - v2 error format |
| 4460 | |
| 4461 | Returns: |
| 4462 | An object of the form: |
| 4463 | |
| 4464 | { # This operation resource represents operations that may have happened or are |
| 4465 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4466 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4467 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4468 | # (e.g., ERROR or DEGRADED). |
| 4469 | "code": "A String", # Machine-friendly representation of the condition |
| 4470 | "message": "A String", # Human-friendly representation of the condition |
| 4471 | }, |
| 4472 | ], |
| 4473 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4474 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4475 | # Unset for single-stage operations. |
| 4476 | "stages": [ # Substages of an operation or a stage. |
| 4477 | # Object with schema name: OperationProgress |
| 4478 | ], |
| 4479 | "metrics": [ # Progress metric bundle, for example: |
| 4480 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4481 | # {name: "nodes total", int_value: 32}] |
| 4482 | # or |
| 4483 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4484 | # {name: "progress scale", double_value: 1.0}] |
| 4485 | { # Progress metric is (string, int|float|string) pair. |
| 4486 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4487 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4488 | "intValue": "A String", # For metrics with integer value. |
| 4489 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4490 | }, |
| 4491 | ], |
| 4492 | "status": "A String", # Status of an operation stage. |
| 4493 | # Unset for single-stage operations. |
| 4494 | }, |
| 4495 | "zone": "A String", # The name of the Google Compute Engine |
| 4496 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4497 | # operation is taking place. This field is deprecated, use location instead. |
| 4498 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4499 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4500 | "detail": "A String", # Detailed operation progress, if available. |
| 4501 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4502 | "operationType": "A String", # The operation type. |
| 4503 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4504 | "name": "A String", # The server-assigned ID for the operation. |
| 4505 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4506 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4507 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4508 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4509 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4510 | }, |
| 4511 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4512 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4513 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4514 | "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] | 4515 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4516 | # or |
| 4517 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4518 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4519 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4520 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4521 | }</pre> |
| 4522 | </div> |
| 4523 | |
| 4524 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4525 | <code class="details" id="startIpRotation">startIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4526 | <pre>Starts master IP rotation. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4527 | |
| 4528 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4529 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 4530 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 4531 | This field has been deprecated and replaced by the name field. (required) |
| 4532 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4533 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4534 | cluster resides. This field has been deprecated and replaced by the name |
| 4535 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4536 | clusterId: string, Deprecated. The name of the cluster. |
| 4537 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4538 | body: object, The request body. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4539 | The object takes the form of: |
| 4540 | |
| 4541 | { # StartIPRotationRequest creates a new IP for the cluster and then performs |
| 4542 | # a node upgrade on each node pool to point to the new IP. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4543 | "name": "A String", # The name (project, location, cluster id) of the cluster to start IP |
| 4544 | # rotation. Specified in the format `projects/*/locations/*/clusters/*`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4545 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4546 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 4547 | # This field has been deprecated and replaced by the name field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4548 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4549 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4550 | # cluster resides. This field has been deprecated and replaced by the name |
| 4551 | # field. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4552 | "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4553 | "clusterId": "A String", # Deprecated. The name of the cluster. |
| 4554 | # This field has been deprecated and replaced by the name field. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4555 | } |
| 4556 | |
| 4557 | x__xgafv: string, V1 error format. |
| 4558 | Allowed values |
| 4559 | 1 - v1 error format |
| 4560 | 2 - v2 error format |
| 4561 | |
| 4562 | Returns: |
| 4563 | An object of the form: |
| 4564 | |
| 4565 | { # This operation resource represents operations that may have happened or are |
| 4566 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4567 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4568 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4569 | # (e.g., ERROR or DEGRADED). |
| 4570 | "code": "A String", # Machine-friendly representation of the condition |
| 4571 | "message": "A String", # Human-friendly representation of the condition |
| 4572 | }, |
| 4573 | ], |
| 4574 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4575 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4576 | # Unset for single-stage operations. |
| 4577 | "stages": [ # Substages of an operation or a stage. |
| 4578 | # Object with schema name: OperationProgress |
| 4579 | ], |
| 4580 | "metrics": [ # Progress metric bundle, for example: |
| 4581 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4582 | # {name: "nodes total", int_value: 32}] |
| 4583 | # or |
| 4584 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4585 | # {name: "progress scale", double_value: 1.0}] |
| 4586 | { # Progress metric is (string, int|float|string) pair. |
| 4587 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4588 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4589 | "intValue": "A String", # For metrics with integer value. |
| 4590 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4591 | }, |
| 4592 | ], |
| 4593 | "status": "A String", # Status of an operation stage. |
| 4594 | # Unset for single-stage operations. |
| 4595 | }, |
| 4596 | "zone": "A String", # The name of the Google Compute Engine |
| 4597 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4598 | # operation is taking place. This field is deprecated, use location instead. |
| 4599 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4600 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4601 | "detail": "A String", # Detailed operation progress, if available. |
| 4602 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4603 | "operationType": "A String", # The operation type. |
| 4604 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4605 | "name": "A String", # The server-assigned ID for the operation. |
| 4606 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4607 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4608 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4609 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4610 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4611 | }, |
| 4612 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4613 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4614 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4615 | "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] | 4616 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4617 | # or |
| 4618 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4619 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4620 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4621 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4622 | }</pre> |
| 4623 | </div> |
| 4624 | |
| 4625 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4626 | <code class="details" id="update">update(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 4627 | <pre>Updates the settings of a specific cluster. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4628 | |
| 4629 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4630 | projectId: string, Deprecated. The Google Developers Console [project ID or project |
| 4631 | number](https://support.google.com/cloud/answer/6158840). |
| 4632 | This field has been deprecated and replaced by the name field. (required) |
| 4633 | zone: string, Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4634 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4635 | cluster resides. This field has been deprecated and replaced by the name |
| 4636 | field. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4637 | clusterId: string, Deprecated. The name of the cluster to upgrade. |
| 4638 | This field has been deprecated and replaced by the name field. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4639 | body: object, The request body. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4640 | The object takes the form of: |
| 4641 | |
Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 4642 | { # UpdateClusterRequest updates the settings of a cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4643 | "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can # Required. A description of the update. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4644 | # be applied to a cluster with each request, so at most one field can be |
| 4645 | # provided. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4646 | "desiredImageType": "A String", # The desired image type for the node pool. |
| 4647 | # NOTE: Set the "desired_node_pool" field as well. |
| 4648 | "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM # Configuration for Workload Identity. |
| 4649 | # policies. |
| 4650 | "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. |
| 4651 | }, |
| 4652 | "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if |
| 4653 | # "desired_node_version", "desired_image_family" or |
| 4654 | # "desired_node_pool_autoscaling" is specified and there is more than one |
| 4655 | # node pool on the cluster. |
| 4656 | "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. |
| 4657 | # |
| 4658 | # Users may specify either explicit versions offered by |
| 4659 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 4660 | # |
| 4661 | # - "latest": picks the highest valid Kubernetes version |
| 4662 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4663 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4664 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4665 | # - "-": picks the default Kubernetes version |
| 4666 | "desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes. |
| 4667 | "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. |
| 4668 | }, |
| 4669 | "desiredLoggingService": "A String", # The logging service the cluster should use to write logs. |
| 4670 | # Currently available options: |
| 4671 | # |
| 4672 | # * `logging.googleapis.com/kubernetes` - The Cloud Logging |
| 4673 | # service with a Kubernetes-native resource model |
| 4674 | # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer |
| 4675 | # available as of GKE 1.15). |
| 4676 | # * `none` - no logs will be exported from the cluster. |
| 4677 | # |
| 4678 | # If left as an empty string,`logging.googleapis.com/kubernetes` will be |
| 4679 | # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. |
| 4680 | "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information # Cluster-level Vertical Pod Autoscaling configuration. |
| 4681 | # required by Vertical Pod Autoscaler to automatically adjust |
| 4682 | # the resources of pods controlled by it. |
| 4683 | "enabled": True or False, # Enables vertical pod autoscaling. |
| 4684 | }, |
| 4685 | "desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature. |
| 4686 | "enabled": True or False, # Enable Binary Authorization for this cluster. If enabled, all container |
| 4687 | # images will be validated by Binary Authorization. |
| 4688 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4689 | "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the # Configurations for the various addons available to run in the cluster. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4690 | # cluster, enabling additional functionality. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4691 | "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon # Configuration for NetworkPolicy. This only tracks whether the addon |
| 4692 | # is enabled or not on the Master, it does not track whether network policy |
| 4693 | # is enabled for the nodes. |
| 4694 | # is enabled or not on the Master, it does not track whether network policy |
| 4695 | # is enabled for the nodes. |
| 4696 | "disabled": True or False, # Whether NetworkPolicy is enabled for this cluster. |
| 4697 | }, |
| 4698 | "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a |
| 4699 | # managed Knative service. |
| 4700 | "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. |
| 4701 | }, |
| 4702 | "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which # Configuration for the horizontal pod autoscaling feature, which |
| 4703 | # increases or decreases the number of replica pods a replication controller |
| 4704 | # has based on the resource usage of the existing pods. |
| 4705 | # increases or decreases the number of replica pods a replication controller |
| 4706 | # has based on the resource usage of the existing pods. |
| 4707 | "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. |
| 4708 | # When enabled, it ensures that metrics are collected into Stackdriver |
| 4709 | # Monitoring. |
| 4710 | }, |
| 4711 | "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, # Configuration for the HTTP (L7) load balancing controller addon, which |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4712 | # makes it easy to set up HTTP load balancers for services in a cluster. |
| 4713 | # which makes it easy to set up HTTP load balancers for services in a cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4714 | "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4715 | # When enabled, it runs a small pod in the cluster that manages the load |
| 4716 | # balancers. |
| 4717 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4718 | "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4719 | # This addon is deprecated, and will be disabled in 1.15. It is recommended |
| 4720 | # to use the Cloud Console to manage and monitor your Kubernetes clusters, |
| 4721 | # workloads and applications. For more information, see: |
| 4722 | # https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4723 | "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4724 | }, |
| 4725 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4726 | "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an |
| 4727 | # upgrade). |
| 4728 | # |
| 4729 | # Users may specify either explicit versions offered by |
| 4730 | # Kubernetes Engine or version aliases, which have the following behavior: |
| 4731 | # |
| 4732 | # - "latest": picks the highest valid Kubernetes version |
| 4733 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 4734 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 4735 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 4736 | # - "-": picks the Kubernetes master version |
| 4737 | "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node # The desired config of Intra-node visibility. |
| 4738 | # visibility on this cluster. |
| 4739 | "enabled": True or False, # Enables intra node visibility for this cluster. |
| 4740 | }, |
| 4741 | "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information # Cluster-level autoscaling configuration. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4742 | # required by Cluster Autoscaler to automatically adjust |
| 4743 | # the size of the cluster and create/delete |
| 4744 | # node pools based on the current needs. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4745 | "autoprovisioningLocations": [ # The list of Google Compute Engine |
| 4746 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4747 | # NodePool's nodes can be created by NAP. |
| 4748 | "A String", |
| 4749 | ], |
| 4750 | "resourceLimits": [ # Contains global constraints regarding minimum and maximum |
| 4751 | # amount of resources in the cluster. |
| 4752 | { # Contains information about amount of some resource in the cluster. |
| 4753 | # For memory, value should be in GB. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4754 | "minimum": "A String", # Minimum amount of the resource in the cluster. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4755 | "maximum": "A String", # Maximum amount of the resource in the cluster. |
| 4756 | "resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4757 | }, |
| 4758 | ], |
| 4759 | "enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion. |
| 4760 | "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] | 4761 | # created by NAP. |
| 4762 | # by NAP. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4763 | "management": { # NodeManagement defines the set of node management services turned on for the # Specifies the node management options for NAP created node-pools. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4764 | # node pool. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4765 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4766 | # the Auto Upgrades will proceed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4767 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4768 | # with the approximate start time for the upgrades, in |
| 4769 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4770 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 4771 | # with the description of the upgrade. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4772 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4773 | "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| 4774 | # pool. If enabled, the nodes in this node pool will be monitored and, if |
| 4775 | # they fail health checks too many times, an automatic repair action will be |
| 4776 | # triggered. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4777 | "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| 4778 | # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| 4779 | # up to date with the latest release version of Kubernetes. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4780 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4781 | "oauthScopes": [ # Scopes that are used by NAP when creating node pools. If oauth_scopes are |
| 4782 | # specified, service_account should be empty. |
| 4783 | "A String", |
| 4784 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4785 | "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] | 4786 | # disruption caused by an upgrade. |
| 4787 | # |
| 4788 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 4789 | # unavailable. |
| 4790 | # |
| 4791 | # maxSurge controls the number of additional nodes that can be added to the |
| 4792 | # node pool temporarily for the time of the upgrade to increase the number of |
| 4793 | # available nodes. |
| 4794 | # |
| 4795 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 4796 | # nodes are being upgraded at the same time). |
| 4797 | # |
| 4798 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 4799 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 4800 | # this holds true. (Disruption stays within the limits of |
| 4801 | # PodDisruptionBudget, if it is configured.) |
| 4802 | # |
| 4803 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 4804 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 4805 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 4806 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 4807 | # there are always at least 4 nodes available. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4808 | "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] | 4809 | # the upgrade process. A node is considered available if its status is |
| 4810 | # Ready. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4811 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 4812 | # of the node pool during the upgrade process. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4813 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4814 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| 4815 | # service_account is specified, scopes should be empty. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4816 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4817 | }, |
| 4818 | "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. |
| 4819 | "keyName": "A String", # Name of CloudKMS key to use for the encryption of secrets in etcd. |
| 4820 | # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key |
| 4821 | "state": "A String", # Denotes the state of etcd encryption. |
| 4822 | }, |
| 4823 | "desiredMasterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled # The desired configuration options for master authorized networks feature. |
| 4824 | # master authorized networks will disallow all external traffic to access |
| 4825 | # Kubernetes master through HTTPS except traffic from the given CIDR blocks, |
| 4826 | # Google Compute Engine Public IPs and Google Prod IPs. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4827 | "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access |
| 4828 | # Kubernetes master through HTTPS. |
| 4829 | { # CidrBlock contains an optional name and one CIDR block. |
| 4830 | "displayName": "A String", # display_name is an optional field for users to identify CIDR blocks. |
| 4831 | "cidrBlock": "A String", # cidr_block must be specified in CIDR notation. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4832 | }, |
| 4833 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4834 | "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] | 4835 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4836 | "desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage. |
| 4837 | "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a |
| 4838 | # daemonset will be created in the cluster to meter network egress traffic. |
| 4839 | "consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering. |
| 4840 | "enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a |
| 4841 | # second BigQuery table will be created to hold resource consumption |
| 4842 | # records. |
| 4843 | }, |
| 4844 | "bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination. |
| 4845 | "datasetId": "A String", # The ID of a BigQuery Dataset. |
| 4846 | }, |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4847 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4848 | "desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for the node pool specified in |
| 4849 | # desired_node_pool_id. If there is only one pool in the |
| 4850 | # cluster and desired_node_pool_id is not provided then |
| 4851 | # the change applies to that single node pool. |
| 4852 | # 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] | 4853 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 4854 | # has to enough quota to scale up the cluster. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4855 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4856 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 4857 | # max_node_count. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4858 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4859 | }, |
| 4860 | "desiredLocations": [ # The desired list of Google Compute Engine |
| 4861 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4862 | # cluster's nodes should be located. Changing the locations a cluster is in |
| 4863 | # will result in nodes being either created or removed from the cluster, |
| 4864 | # depending on whether locations are being added or removed. |
| 4865 | # |
| 4866 | # This list must always include the cluster's primary zone. |
| 4867 | "A String", |
| 4868 | ], |
| 4869 | "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4870 | # Currently available options: |
| 4871 | # |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4872 | # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4873 | # service with a Kubernetes-native resource model |
| 4874 | # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no |
| 4875 | # longer available as of GKE 1.15). |
| 4876 | # * `none` - No metrics will be exported from the cluster. |
| 4877 | # |
| 4878 | # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be |
| 4879 | # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4880 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4881 | "name": "A String", # The name (project, location, cluster) of the cluster to update. |
| 4882 | # Specified in the format `projects/*/locations/*/clusters/*`. |
| 4883 | "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project |
| 4884 | # number](https://support.google.com/cloud/answer/6158840). |
| 4885 | # This field has been deprecated and replaced by the name field. |
| 4886 | "zone": "A String", # Deprecated. The name of the Google Compute Engine |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4887 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4888 | # cluster resides. This field has been deprecated and replaced by the name |
| 4889 | # field. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4890 | "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. |
| 4891 | # This field has been deprecated and replaced by the name field. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4892 | } |
| 4893 | |
| 4894 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4895 | Allowed values |
| 4896 | 1 - v1 error format |
| 4897 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4898 | |
| 4899 | Returns: |
| 4900 | An object of the form: |
| 4901 | |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 4902 | { # This operation resource represents operations that may have happened or are |
| 4903 | # happening on the cluster. All fields are output only. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4904 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 4905 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4906 | # (e.g., ERROR or DEGRADED). |
| 4907 | "code": "A String", # Machine-friendly representation of the condition |
| 4908 | "message": "A String", # Human-friendly representation of the condition |
| 4909 | }, |
| 4910 | ], |
| 4911 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| 4912 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 4913 | # Unset for single-stage operations. |
| 4914 | "stages": [ # Substages of an operation or a stage. |
| 4915 | # Object with schema name: OperationProgress |
| 4916 | ], |
| 4917 | "metrics": [ # Progress metric bundle, for example: |
| 4918 | # metrics: [{name: "nodes done", int_value: 15}, |
| 4919 | # {name: "nodes total", int_value: 32}] |
| 4920 | # or |
| 4921 | # metrics: [{name: "progress", double_value: 0.56}, |
| 4922 | # {name: "progress scale", double_value: 1.0}] |
| 4923 | { # Progress metric is (string, int|float|string) pair. |
| 4924 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 4925 | "doubleValue": 3.14, # For metrics with floating point value. |
| 4926 | "intValue": "A String", # For metrics with integer value. |
| 4927 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| 4928 | }, |
| 4929 | ], |
| 4930 | "status": "A String", # Status of an operation stage. |
| 4931 | # Unset for single-stage operations. |
| 4932 | }, |
| 4933 | "zone": "A String", # The name of the Google Compute Engine |
| 4934 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 4935 | # operation is taking place. This field is deprecated, use location instead. |
| 4936 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| 4937 | "selfLink": "A String", # Server-defined URL for the resource. |
| 4938 | "detail": "A String", # Detailed operation progress, if available. |
| 4939 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 4940 | "operationType": "A String", # The operation type. |
| 4941 | "status": "A String", # The current status of the operation. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4942 | "name": "A String", # The server-assigned ID for the operation. |
| 4943 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4944 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 4945 | # (e.g., ERROR or DEGRADED). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4946 | "code": "A String", # Machine-friendly representation of the condition |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4947 | "message": "A String", # Human-friendly representation of the condition |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4948 | }, |
| 4949 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4950 | "endTime": "A String", # [Output only] The time the operation completed, in |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4951 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4952 | "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] | 4953 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4954 | # or |
| 4955 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 4956 | # in which the cluster resides. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4957 | "startTime": "A String", # [Output only] The time the operation started, in |
| 4958 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4959 | }</pre> |
| 4960 | </div> |
| 4961 | |
| 4962 | </body></html> |