| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.clusters.html">clusters</a> . <a href="container_v1beta1.projects.zones.clusters.nodePools.html">nodePools</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Sets the autoscaling settings of a specific node pool.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(projectId, zone, clusterId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a node pool for a cluster.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a node pool from a cluster.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves the requested node pool.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Lists the node pools for a cluster.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Sets the NodeManagement options for a node pool.</p> |
| 98 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#setSize">setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Sets the size for a specific node pool.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#update">update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Updates the version and/or image type of a specific node pool.</p> |
| 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 106 | <code class="details" id="autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | <pre>Sets the autoscaling settings of a specific node pool. |
| 108 | |
| 109 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | number](https://support.google.com/cloud/answer/6158840). |
| 112 | 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] | 113 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 114 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 115 | cluster resides. This field has been deprecated and replaced by the name |
| 116 | field. (required) |
| 117 | clusterId: string, Required. Deprecated. The name of the cluster to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | 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] | 119 | nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | 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] | 121 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | The object takes the form of: |
| 123 | |
| 124 | { # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Required. Autoscaling configuration for the node pool. |
| 126 | # adjust the size of the node pool to the current cluster usage. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 127 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 128 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 129 | # max_node_count. |
| 130 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 131 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 132 | # has to enough quota to scale up the cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 134 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 135 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 136 | # cluster resides. This field has been deprecated and replaced by the name |
| 137 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 139 | # number](https://support.google.com/cloud/answer/6158840). |
| 140 | # This field has been deprecated and replaced by the name field. |
| 141 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 142 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 143 | "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set |
| 144 | # autoscaler settings. Specified in the format |
| 145 | # `projects/*/locations/*/clusters/*/nodePools/*`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. |
| 147 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | x__xgafv: string, V1 error format. |
| 151 | Allowed values |
| 152 | 1 - v1 error format |
| 153 | 2 - v2 error format |
| 154 | |
| 155 | Returns: |
| 156 | An object of the form: |
| 157 | |
| 158 | { # This operation resource represents operations that may have happened or are |
| 159 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 160 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 161 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 163 | "stages": [ # Substages of an operation or a stage. |
| 164 | # Object with schema name: OperationProgress |
| 165 | ], |
| 166 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 167 | # Unset for single-stage operations. |
| 168 | "status": "A String", # Status of an operation stage. |
| 169 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "metrics": [ # Progress metric bundle, for example: |
| 171 | # metrics: [{name: "nodes done", int_value: 15}, |
| 172 | # {name: "nodes total", int_value: 32}] |
| 173 | # or |
| 174 | # metrics: [{name: "progress", double_value: 0.56}, |
| 175 | # {name: "progress scale", double_value: 1.0}] |
| 176 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 177 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 179 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 180 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | }, |
| 182 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 183 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 184 | "selfLink": "A String", # Server-defined URL for the resource. |
| 185 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 186 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 187 | # or |
| 188 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 189 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | "zone": "A String", # The name of the Google Compute Engine |
| 191 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 192 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 193 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 194 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 195 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 196 | "name": "A String", # The server-assigned ID for the operation. |
| 197 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 198 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 199 | # (e.g., ERROR or DEGRADED). |
| 200 | "code": "A String", # Machine-friendly representation of the condition |
| 201 | "message": "A String", # Human-friendly representation of the condition |
| 202 | }, |
| 203 | ], |
| 204 | "startTime": "A String", # [Output only] The time the operation started, in |
| 205 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 206 | "detail": "A String", # Detailed operation progress, if available. |
| 207 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 208 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 209 | # (e.g., ERROR or DEGRADED). |
| 210 | "code": "A String", # Machine-friendly representation of the condition |
| 211 | "message": "A String", # Human-friendly representation of the condition |
| 212 | }, |
| 213 | ], |
| 214 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 215 | }</pre> |
| 216 | </div> |
| 217 | |
| 218 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 219 | <code class="details" id="create">create(projectId, zone, clusterId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 220 | <pre>Creates a node pool for a cluster. |
| 221 | |
| 222 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 223 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 224 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 225 | This field has been deprecated and replaced by the parent field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 226 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 227 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 228 | cluster resides. This field has been deprecated and replaced by the parent |
| 229 | field. (required) |
| 230 | clusterId: string, Required. Deprecated. The name of the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 231 | This field has been deprecated and replaced by the parent field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 232 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 233 | The object takes the form of: |
| 234 | |
| 235 | { # CreateNodePoolRequest creates a node pool for a cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 237 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 238 | # cluster resides. This field has been deprecated and replaced by the parent |
| 239 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 240 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 241 | # number](https://developers.google.com/console/help/new/#projectnumber). |
| 242 | # This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # Required. The node pool to create. |
| 244 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 245 | # specification, under the control of the cluster master. They may have a set |
| 246 | # of Kubernetes labels applied to them, which may be used to reference them |
| 247 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 248 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 249 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 250 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 251 | # disruption caused by an upgrade. |
| 252 | # |
| 253 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 254 | # unavailable. |
| 255 | # |
| 256 | # maxSurge controls the number of additional nodes that can be added to the |
| 257 | # node pool temporarily for the time of the upgrade to increase the number of |
| 258 | # available nodes. |
| 259 | # |
| 260 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 261 | # nodes are being upgraded at the same time). |
| 262 | # |
| 263 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 264 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 265 | # this holds true. (Disruption stays within the limits of |
| 266 | # PodDisruptionBudget, if it is configured.) |
| 267 | # |
| 268 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 269 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 270 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 271 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 272 | # there are always at least 4 nodes available. |
| 273 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 274 | # the upgrade process. A node is considered available if its status is |
| 275 | # Ready. |
| 276 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 277 | # of the node pool during the upgrade process. |
| 278 | }, |
| 279 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 280 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 281 | # associated with this node pool. |
| 282 | "A String", |
| 283 | ], |
| 284 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 285 | # only if a valid configuration is present. |
| 286 | # adjust the size of the node pool to the current cluster usage. |
| 287 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 288 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 289 | # max_node_count. |
| 290 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 291 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 292 | # has to enough quota to scale up the cluster. |
| 293 | }, |
| 294 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 295 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 296 | # is sufficient for this number of instances. You must also have available |
| 297 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 299 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 300 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 301 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 302 | # The following scopes are recommended, but not required, and by default are |
| 303 | # not included: |
| 304 | # |
| 305 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 306 | # persistent storage on your nodes. |
| 307 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 308 | # communicating with **gcr.io** |
| 309 | # (the [Google Container |
| 310 | # Registry](https://cloud.google.com/container-registry/)). |
| 311 | # |
| 312 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 313 | # Monitoring are enabled, in which case their required scopes will be added. |
| 314 | "A String", |
| 315 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 316 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 317 | # |
| 318 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 319 | # in length. These are reflected as part of a URL in the metadata server. |
| 320 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 321 | # metadata keys for the project or be one of the reserved keys: |
| 322 | # "cluster-location" |
| 323 | # "cluster-name" |
| 324 | # "cluster-uid" |
| 325 | # "configure-sh" |
| 326 | # "containerd-configure-sh" |
| 327 | # "enable-oslogin" |
| 328 | # "gci-ensure-gke-docker" |
| 329 | # "gci-metrics-enabled" |
| 330 | # "gci-update-strategy" |
| 331 | # "instance-template" |
| 332 | # "kube-env" |
| 333 | # "startup-script" |
| 334 | # "user-data" |
| 335 | # "disable-address-manager" |
| 336 | # "windows-startup-script-ps1" |
| 337 | # "common-psm1" |
| 338 | # "k8s-node-setup-psm1" |
| 339 | # "install-ssh-psm1" |
| 340 | # "user-profile-psm1" |
| 341 | # "serial-port-logging-enable" |
| 342 | # Values are free-form strings, and only have meaning as interpreted by |
| 343 | # the image running in the instance. The only restriction placed on them is |
| 344 | # that each value's size must be less than or equal to 32 KB. |
| 345 | # |
| 346 | # The total size of all keys and values must be less than 512 KB. |
| 347 | "a_key": "A String", |
| 348 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 349 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 350 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 351 | # `n1-standard-1`). |
| 352 | # |
| 353 | # If unspecified, the default machine type is |
| 354 | # `n1-standard-1`. |
| 355 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 356 | # pool to run on the specified node group. This is useful for running |
| 357 | # workloads on [sole tenant |
| 358 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 359 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 360 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 361 | # |
| 362 | # Secure Boot helps ensure that the system only runs authentic software by |
| 363 | # verifying the digital signature of all boot components, and halting the |
| 364 | # boot process if signature verification fails. |
| 365 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 366 | # |
| 367 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 368 | # The attestation is performed against the integrity policy baseline. This |
| 369 | # baseline is initially derived from the implicitly trusted boot image when |
| 370 | # the instance is created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 371 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 373 | # Specify the email address of the Service Account; otherwise, if no Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 374 | # Account is specified, the "default" service account is used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 375 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 376 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 377 | # on the nodes. |
| 378 | # |
| 379 | # The following parameters are supported. |
| 380 | # |
| 381 | # net.core.netdev_max_backlog |
| 382 | # net.core.rmem_max |
| 383 | # net.core.wmem_default |
| 384 | # net.core.wmem_max |
| 385 | # net.core.optmem_max |
| 386 | # net.core.somaxconn |
| 387 | # net.ipv4.tcp_rmem |
| 388 | # net.ipv4.tcp_wmem |
| 389 | # net.ipv4.tcp_tw_reuse |
| 390 | "a_key": "A String", |
| 391 | }, |
| 392 | }, |
| 393 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 394 | "type": "A String", # Type of the sandbox to use for the node. |
| 395 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 396 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 397 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 398 | # |
| 399 | # For more information, including usage and the valid values, see: |
| 400 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 401 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 402 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 403 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 404 | # See |
| 405 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 406 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 407 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 408 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 409 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 410 | }, |
| 411 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 412 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 413 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 414 | # |
| 415 | # The string must be a sequence of decimal numbers, each with optional |
| 416 | # fraction and a unit suffix, such as "300ms". |
| 417 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 418 | # The value must be a positive duration. |
| 419 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 420 | # |
| 421 | # If this option is enabled, kubelet uses CFS quota |
| 422 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 423 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 424 | # all. |
| 425 | # |
| 426 | # Disable this option to mitigate CPU throttling problems while still having |
| 427 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 428 | # |
| 429 | # The default value is 'true' if unspecified. |
| 430 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 431 | # See |
| 432 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 433 | # |
| 434 | # The following values are allowed. |
| 435 | # - "none": the default, which represents the existing scheduling behavior. |
| 436 | # - "static": allows pods with certain resource characteristics to be |
| 437 | # granted increased CPU affinity and exclusivity on the node. |
| 438 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 439 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 440 | # These will added in addition to any default label(s) that |
| 441 | # Kubernetes may apply to the node. |
| 442 | # In case of conflict in label keys, the applied set may differ depending on |
| 443 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 444 | # and conflicts should be avoided. |
| 445 | # For more information, including usage and the valid values, see: |
| 446 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 447 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 448 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 449 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 450 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 451 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 452 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 453 | # workloads on the node pool. |
| 454 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 455 | # workloads running on the node. |
| 456 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 457 | # on the node pool. |
| 458 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 459 | "bootDiskKmsKey": "A String", # |
| 460 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 461 | # to each node in the node pool. This should be of the form |
| 462 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 463 | # For more information about protecting resources with Cloud KMS Keys please |
| 464 | # see: |
| 465 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 466 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 467 | # The smallest allowed disk size is 10GB. |
| 468 | # |
| 469 | # If unspecified, the default disk size is 100GB. |
| 470 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 471 | # the specified [Zonal Compute |
| 472 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 473 | # to this node pool. |
| 474 | # is the configuration of desired reservation which instances could take |
| 475 | # capacity from. |
| 476 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 477 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 478 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 479 | # the key and specify the name of your reservation as its value. |
| 480 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 481 | "A String", |
| 482 | ], |
| 483 | }, |
| 484 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 485 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 486 | # inforamtion about preemptible VM instances. |
| 487 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 488 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 489 | # friendly names of CPU platforms, such as |
| 490 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 491 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 492 | # information, read [how to specify min CPU |
| 493 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 494 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 495 | # valid sources or targets for network firewalls and are specified by |
| 496 | # the client during cluster or node pool creation. Each tag within the list |
| 497 | # must comply with RFC1035. |
| 498 | "A String", |
| 499 | ], |
| 500 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 501 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 502 | # support for GPUs. |
| 503 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 504 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 505 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 506 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 507 | }, |
| 508 | ], |
| 509 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 510 | # |
| 511 | # The limit for this value is dependent upon the maximum number of |
| 512 | # disks available on a machine per zone. See: |
| 513 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 514 | # for more information. |
| 515 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 516 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 517 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 518 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 519 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 520 | # node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 521 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 522 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 523 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 524 | # the Auto Upgrades will proceed. |
| 525 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 526 | # with the description of the upgrade. |
| 527 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 528 | # with the approximate start time for the upgrades, in |
| 529 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 530 | }, |
| 531 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 532 | "name": "A String", # The name of the node pool. |
| 533 | "version": "A String", # The version of the Kubernetes of this node. |
| 534 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 535 | # simultaneously on a node in the node pool. |
| 536 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 537 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 538 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 539 | # node pool instance, if available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 540 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 541 | "conditions": [ # Which conditions caused the current node pool state. |
| 542 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 543 | # (e.g., ERROR or DEGRADED). |
| 544 | "code": "A String", # Machine-friendly representation of the condition |
| 545 | "message": "A String", # Human-friendly representation of the condition |
| 546 | }, |
| 547 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 548 | "locations": [ # The list of Google Compute Engine |
| 549 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 550 | # NodePool's nodes should be located. |
| 551 | "A String", |
| 552 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 553 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 554 | "clusterId": "A String", # Required. Deprecated. The name of the cluster. |
| 555 | # This field has been deprecated and replaced by the parent field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 556 | "parent": "A String", # The parent (project, location, cluster id) where the node pool will be |
| 557 | # created. Specified in the format |
| 558 | # `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 559 | } |
| 560 | |
| 561 | x__xgafv: string, V1 error format. |
| 562 | Allowed values |
| 563 | 1 - v1 error format |
| 564 | 2 - v2 error format |
| 565 | |
| 566 | Returns: |
| 567 | An object of the form: |
| 568 | |
| 569 | { # This operation resource represents operations that may have happened or are |
| 570 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 571 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 572 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 574 | "stages": [ # Substages of an operation or a stage. |
| 575 | # Object with schema name: OperationProgress |
| 576 | ], |
| 577 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 578 | # Unset for single-stage operations. |
| 579 | "status": "A String", # Status of an operation stage. |
| 580 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "metrics": [ # Progress metric bundle, for example: |
| 582 | # metrics: [{name: "nodes done", int_value: 15}, |
| 583 | # {name: "nodes total", int_value: 32}] |
| 584 | # or |
| 585 | # metrics: [{name: "progress", double_value: 0.56}, |
| 586 | # {name: "progress scale", double_value: 1.0}] |
| 587 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 588 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 589 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 590 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 591 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | }, |
| 593 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 594 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 595 | "selfLink": "A String", # Server-defined URL for the resource. |
| 596 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 597 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 598 | # or |
| 599 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 600 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 601 | "zone": "A String", # The name of the Google Compute Engine |
| 602 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 603 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 604 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 605 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 607 | "name": "A String", # The server-assigned ID for the operation. |
| 608 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 609 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 610 | # (e.g., ERROR or DEGRADED). |
| 611 | "code": "A String", # Machine-friendly representation of the condition |
| 612 | "message": "A String", # Human-friendly representation of the condition |
| 613 | }, |
| 614 | ], |
| 615 | "startTime": "A String", # [Output only] The time the operation started, in |
| 616 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 617 | "detail": "A String", # Detailed operation progress, if available. |
| 618 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 619 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 620 | # (e.g., ERROR or DEGRADED). |
| 621 | "code": "A String", # Machine-friendly representation of the condition |
| 622 | "message": "A String", # Human-friendly representation of the condition |
| 623 | }, |
| 624 | ], |
| 625 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 626 | }</pre> |
| 627 | </div> |
| 628 | |
| 629 | <div class="method"> |
| 630 | <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code> |
| 631 | <pre>Deletes a node pool from a cluster. |
| 632 | |
| 633 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 634 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 635 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 636 | 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] | 637 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 638 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 639 | cluster resides. This field has been deprecated and replaced by the name |
| 640 | field. (required) |
| 641 | clusterId: string, Required. Deprecated. The name of the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 642 | 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] | 643 | nodePoolId: string, Required. Deprecated. The name of the node pool to delete. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 644 | This field has been deprecated and replaced by the name field. (required) |
| 645 | name: string, The name (project, location, cluster, node pool id) of the node pool to |
| 646 | delete. Specified in the format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 647 | `projects/*/locations/*/clusters/*/nodePools/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 648 | x__xgafv: string, V1 error format. |
| 649 | Allowed values |
| 650 | 1 - v1 error format |
| 651 | 2 - v2 error format |
| 652 | |
| 653 | Returns: |
| 654 | An object of the form: |
| 655 | |
| 656 | { # This operation resource represents operations that may have happened or are |
| 657 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 658 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 659 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 660 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 661 | "stages": [ # Substages of an operation or a stage. |
| 662 | # Object with schema name: OperationProgress |
| 663 | ], |
| 664 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 665 | # Unset for single-stage operations. |
| 666 | "status": "A String", # Status of an operation stage. |
| 667 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 668 | "metrics": [ # Progress metric bundle, for example: |
| 669 | # metrics: [{name: "nodes done", int_value: 15}, |
| 670 | # {name: "nodes total", int_value: 32}] |
| 671 | # or |
| 672 | # metrics: [{name: "progress", double_value: 0.56}, |
| 673 | # {name: "progress scale", double_value: 1.0}] |
| 674 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 675 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 676 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 677 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 678 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 679 | }, |
| 680 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 681 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 682 | "selfLink": "A String", # Server-defined URL for the resource. |
| 683 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 684 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 685 | # or |
| 686 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 687 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 688 | "zone": "A String", # The name of the Google Compute Engine |
| 689 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 690 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 691 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 692 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 693 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 694 | "name": "A String", # The server-assigned ID for the operation. |
| 695 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 696 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 697 | # (e.g., ERROR or DEGRADED). |
| 698 | "code": "A String", # Machine-friendly representation of the condition |
| 699 | "message": "A String", # Human-friendly representation of the condition |
| 700 | }, |
| 701 | ], |
| 702 | "startTime": "A String", # [Output only] The time the operation started, in |
| 703 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 704 | "detail": "A String", # Detailed operation progress, if available. |
| 705 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 706 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 707 | # (e.g., ERROR or DEGRADED). |
| 708 | "code": "A String", # Machine-friendly representation of the condition |
| 709 | "message": "A String", # Human-friendly representation of the condition |
| 710 | }, |
| 711 | ], |
| 712 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 713 | }</pre> |
| 714 | </div> |
| 715 | |
| 716 | <div class="method"> |
| 717 | <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code> |
| 718 | <pre>Retrieves the requested node pool. |
| 719 | |
| 720 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 721 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 722 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 723 | 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] | 724 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 725 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 726 | cluster resides. This field has been deprecated and replaced by the name |
| 727 | field. (required) |
| 728 | clusterId: string, Required. Deprecated. The name of the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 729 | 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] | 730 | nodePoolId: string, Required. Deprecated. The name of the node pool. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 731 | This field has been deprecated and replaced by the name field. (required) |
| 732 | name: string, The name (project, location, cluster, node pool id) of the node pool to |
| 733 | get. Specified in the format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 734 | `projects/*/locations/*/clusters/*/nodePools/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 735 | x__xgafv: string, V1 error format. |
| 736 | Allowed values |
| 737 | 1 - v1 error format |
| 738 | 2 - v2 error format |
| 739 | |
| 740 | Returns: |
| 741 | An object of the form: |
| 742 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 743 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 744 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 745 | # specification, under the control of the cluster master. They may have a set |
| 746 | # of Kubernetes labels applied to them, which may be used to reference them |
| 747 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 748 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 750 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 751 | # disruption caused by an upgrade. |
| 752 | # |
| 753 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 754 | # unavailable. |
| 755 | # |
| 756 | # maxSurge controls the number of additional nodes that can be added to the |
| 757 | # node pool temporarily for the time of the upgrade to increase the number of |
| 758 | # available nodes. |
| 759 | # |
| 760 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 761 | # nodes are being upgraded at the same time). |
| 762 | # |
| 763 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 764 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 765 | # this holds true. (Disruption stays within the limits of |
| 766 | # PodDisruptionBudget, if it is configured.) |
| 767 | # |
| 768 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 769 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 770 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 771 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 772 | # there are always at least 4 nodes available. |
| 773 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 774 | # the upgrade process. A node is considered available if its status is |
| 775 | # Ready. |
| 776 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 777 | # of the node pool during the upgrade process. |
| 778 | }, |
| 779 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 780 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 781 | # associated with this node pool. |
| 782 | "A String", |
| 783 | ], |
| 784 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 785 | # only if a valid configuration is present. |
| 786 | # adjust the size of the node pool to the current cluster usage. |
| 787 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 788 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 789 | # max_node_count. |
| 790 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 791 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 792 | # has to enough quota to scale up the cluster. |
| 793 | }, |
| 794 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 795 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 796 | # is sufficient for this number of instances. You must also have available |
| 797 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 798 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 799 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 800 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 801 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 802 | # The following scopes are recommended, but not required, and by default are |
| 803 | # not included: |
| 804 | # |
| 805 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 806 | # persistent storage on your nodes. |
| 807 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 808 | # communicating with **gcr.io** |
| 809 | # (the [Google Container |
| 810 | # Registry](https://cloud.google.com/container-registry/)). |
| 811 | # |
| 812 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 813 | # Monitoring are enabled, in which case their required scopes will be added. |
| 814 | "A String", |
| 815 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 816 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 817 | # |
| 818 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 819 | # in length. These are reflected as part of a URL in the metadata server. |
| 820 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 821 | # metadata keys for the project or be one of the reserved keys: |
| 822 | # "cluster-location" |
| 823 | # "cluster-name" |
| 824 | # "cluster-uid" |
| 825 | # "configure-sh" |
| 826 | # "containerd-configure-sh" |
| 827 | # "enable-oslogin" |
| 828 | # "gci-ensure-gke-docker" |
| 829 | # "gci-metrics-enabled" |
| 830 | # "gci-update-strategy" |
| 831 | # "instance-template" |
| 832 | # "kube-env" |
| 833 | # "startup-script" |
| 834 | # "user-data" |
| 835 | # "disable-address-manager" |
| 836 | # "windows-startup-script-ps1" |
| 837 | # "common-psm1" |
| 838 | # "k8s-node-setup-psm1" |
| 839 | # "install-ssh-psm1" |
| 840 | # "user-profile-psm1" |
| 841 | # "serial-port-logging-enable" |
| 842 | # Values are free-form strings, and only have meaning as interpreted by |
| 843 | # the image running in the instance. The only restriction placed on them is |
| 844 | # that each value's size must be less than or equal to 32 KB. |
| 845 | # |
| 846 | # The total size of all keys and values must be less than 512 KB. |
| 847 | "a_key": "A String", |
| 848 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 849 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 850 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 851 | # `n1-standard-1`). |
| 852 | # |
| 853 | # If unspecified, the default machine type is |
| 854 | # `n1-standard-1`. |
| 855 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 856 | # pool to run on the specified node group. This is useful for running |
| 857 | # workloads on [sole tenant |
| 858 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 859 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 860 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 861 | # |
| 862 | # Secure Boot helps ensure that the system only runs authentic software by |
| 863 | # verifying the digital signature of all boot components, and halting the |
| 864 | # boot process if signature verification fails. |
| 865 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 866 | # |
| 867 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 868 | # The attestation is performed against the integrity policy baseline. This |
| 869 | # baseline is initially derived from the implicitly trusted boot image when |
| 870 | # the instance is created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 871 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 872 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 873 | # Specify the email address of the Service Account; otherwise, if no Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 874 | # Account is specified, the "default" service account is used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 875 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 876 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 877 | # on the nodes. |
| 878 | # |
| 879 | # The following parameters are supported. |
| 880 | # |
| 881 | # net.core.netdev_max_backlog |
| 882 | # net.core.rmem_max |
| 883 | # net.core.wmem_default |
| 884 | # net.core.wmem_max |
| 885 | # net.core.optmem_max |
| 886 | # net.core.somaxconn |
| 887 | # net.ipv4.tcp_rmem |
| 888 | # net.ipv4.tcp_wmem |
| 889 | # net.ipv4.tcp_tw_reuse |
| 890 | "a_key": "A String", |
| 891 | }, |
| 892 | }, |
| 893 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 894 | "type": "A String", # Type of the sandbox to use for the node. |
| 895 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 896 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 897 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 898 | # |
| 899 | # For more information, including usage and the valid values, see: |
| 900 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 901 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 902 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 903 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | # See |
| 905 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 906 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 907 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 908 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 909 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 910 | }, |
| 911 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 912 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 913 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 914 | # |
| 915 | # The string must be a sequence of decimal numbers, each with optional |
| 916 | # fraction and a unit suffix, such as "300ms". |
| 917 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 918 | # The value must be a positive duration. |
| 919 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 920 | # |
| 921 | # If this option is enabled, kubelet uses CFS quota |
| 922 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 923 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 924 | # all. |
| 925 | # |
| 926 | # Disable this option to mitigate CPU throttling problems while still having |
| 927 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 928 | # |
| 929 | # The default value is 'true' if unspecified. |
| 930 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 931 | # See |
| 932 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 933 | # |
| 934 | # The following values are allowed. |
| 935 | # - "none": the default, which represents the existing scheduling behavior. |
| 936 | # - "static": allows pods with certain resource characteristics to be |
| 937 | # granted increased CPU affinity and exclusivity on the node. |
| 938 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 939 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 940 | # These will added in addition to any default label(s) that |
| 941 | # Kubernetes may apply to the node. |
| 942 | # In case of conflict in label keys, the applied set may differ depending on |
| 943 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 944 | # and conflicts should be avoided. |
| 945 | # For more information, including usage and the valid values, see: |
| 946 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 947 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 948 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 949 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 950 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 951 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 952 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 953 | # workloads on the node pool. |
| 954 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 955 | # workloads running on the node. |
| 956 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 957 | # on the node pool. |
| 958 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 959 | "bootDiskKmsKey": "A String", # |
| 960 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 961 | # to each node in the node pool. This should be of the form |
| 962 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 963 | # For more information about protecting resources with Cloud KMS Keys please |
| 964 | # see: |
| 965 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 966 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 967 | # The smallest allowed disk size is 10GB. |
| 968 | # |
| 969 | # If unspecified, the default disk size is 100GB. |
| 970 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 971 | # the specified [Zonal Compute |
| 972 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 973 | # to this node pool. |
| 974 | # is the configuration of desired reservation which instances could take |
| 975 | # capacity from. |
| 976 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 977 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 978 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 979 | # the key and specify the name of your reservation as its value. |
| 980 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 981 | "A String", |
| 982 | ], |
| 983 | }, |
| 984 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 985 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 986 | # inforamtion about preemptible VM instances. |
| 987 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 988 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 989 | # friendly names of CPU platforms, such as |
| 990 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 991 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 992 | # information, read [how to specify min CPU |
| 993 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 994 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 995 | # valid sources or targets for network firewalls and are specified by |
| 996 | # the client during cluster or node pool creation. Each tag within the list |
| 997 | # must comply with RFC1035. |
| 998 | "A String", |
| 999 | ], |
| 1000 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1001 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1002 | # support for GPUs. |
| 1003 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 1004 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 1005 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1006 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 1007 | }, |
| 1008 | ], |
| 1009 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 1010 | # |
| 1011 | # The limit for this value is dependent upon the maximum number of |
| 1012 | # disks available on a machine per zone. See: |
| 1013 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 1014 | # for more information. |
| 1015 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1016 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1017 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1018 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1019 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 1020 | # node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1021 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1022 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1023 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1024 | # the Auto Upgrades will proceed. |
| 1025 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1026 | # with the description of the upgrade. |
| 1027 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1028 | # with the approximate start time for the upgrades, in |
| 1029 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1030 | }, |
| 1031 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1032 | "name": "A String", # The name of the node pool. |
| 1033 | "version": "A String", # The version of the Kubernetes of this node. |
| 1034 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 1035 | # simultaneously on a node in the node pool. |
| 1036 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1037 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1038 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1039 | # node pool instance, if available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1040 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 1041 | "conditions": [ # Which conditions caused the current node pool state. |
| 1042 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1043 | # (e.g., ERROR or DEGRADED). |
| 1044 | "code": "A String", # Machine-friendly representation of the condition |
| 1045 | "message": "A String", # Human-friendly representation of the condition |
| 1046 | }, |
| 1047 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1048 | "locations": [ # The list of Google Compute Engine |
| 1049 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1050 | # NodePool's nodes should be located. |
| 1051 | "A String", |
| 1052 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1053 | }</pre> |
| 1054 | </div> |
| 1055 | |
| 1056 | <div class="method"> |
| 1057 | <code class="details" id="list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</code> |
| 1058 | <pre>Lists the node pools for a cluster. |
| 1059 | |
| 1060 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1061 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1062 | number](https://developers.google.com/console/help/new/#projectnumber). |
| 1063 | This field has been deprecated and replaced by the parent field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1064 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1065 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1066 | cluster resides. This field has been deprecated and replaced by the parent |
| 1067 | field. (required) |
| 1068 | clusterId: string, Required. Deprecated. The name of the cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1069 | This field has been deprecated and replaced by the parent field. (required) |
| 1070 | parent: string, The parent (project, location, cluster id) where the node pools will be |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1071 | listed. Specified in the format `projects/*/locations/*/clusters/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1072 | x__xgafv: string, V1 error format. |
| 1073 | Allowed values |
| 1074 | 1 - v1 error format |
| 1075 | 2 - v2 error format |
| 1076 | |
| 1077 | Returns: |
| 1078 | An object of the form: |
| 1079 | |
| 1080 | { # ListNodePoolsResponse is the result of ListNodePoolsRequest. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1081 | "nodePools": [ # A list of node pools for a cluster. |
| 1082 | { # NodePool contains the name and configuration for a cluster's node pool. |
| 1083 | # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1084 | # specification, under the control of the cluster master. They may have a set |
| 1085 | # of Kubernetes labels applied to them, which may be used to reference them |
| 1086 | # during pod scheduling. They may also be resized up or down, to accommodate |
| 1087 | # the workload. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1088 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1089 | "upgradeSettings": { # These upgrade settings control the level of parallelism and the level of # Upgrade settings control disruption and speed of the upgrade. |
| 1090 | # disruption caused by an upgrade. |
| 1091 | # |
| 1092 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1093 | # unavailable. |
| 1094 | # |
| 1095 | # maxSurge controls the number of additional nodes that can be added to the |
| 1096 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1097 | # available nodes. |
| 1098 | # |
| 1099 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1100 | # nodes are being upgraded at the same time). |
| 1101 | # |
| 1102 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1103 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1104 | # this holds true. (Disruption stays within the limits of |
| 1105 | # PodDisruptionBudget, if it is configured.) |
| 1106 | # |
| 1107 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1108 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1109 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1110 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1111 | # there are always at least 4 nodes available. |
| 1112 | "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during |
| 1113 | # the upgrade process. A node is considered available if its status is |
| 1114 | # Ready. |
| 1115 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1116 | # of the node pool during the upgrade process. |
| 1117 | }, |
| 1118 | "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance |
| 1119 | # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) |
| 1120 | # associated with this node pool. |
| 1121 | "A String", |
| 1122 | ], |
| 1123 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| 1124 | # only if a valid configuration is present. |
| 1125 | # adjust the size of the node pool to the current cluster usage. |
| 1126 | "autoprovisioned": True or False, # Can this node pool be deleted automatically. |
| 1127 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| 1128 | # max_node_count. |
| 1129 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 1130 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| 1131 | # has to enough quota to scale up the cluster. |
| 1132 | }, |
| 1133 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| 1134 | # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) |
| 1135 | # is sufficient for this number of instances. You must also have available |
| 1136 | # firewall and routes quota. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1137 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1138 | "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| 1139 | # node VMs under the "default" service account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1140 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1141 | # The following scopes are recommended, but not required, and by default are |
| 1142 | # not included: |
| 1143 | # |
| 1144 | # * `https://www.googleapis.com/auth/compute` is required for mounting |
| 1145 | # persistent storage on your nodes. |
| 1146 | # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| 1147 | # communicating with **gcr.io** |
| 1148 | # (the [Google Container |
| 1149 | # Registry](https://cloud.google.com/container-registry/)). |
| 1150 | # |
| 1151 | # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| 1152 | # Monitoring are enabled, in which case their required scopes will be added. |
| 1153 | "A String", |
| 1154 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1155 | "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| 1156 | # |
| 1157 | # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| 1158 | # in length. These are reflected as part of a URL in the metadata server. |
| 1159 | # Additionally, to avoid ambiguity, keys must not conflict with any other |
| 1160 | # metadata keys for the project or be one of the reserved keys: |
| 1161 | # "cluster-location" |
| 1162 | # "cluster-name" |
| 1163 | # "cluster-uid" |
| 1164 | # "configure-sh" |
| 1165 | # "containerd-configure-sh" |
| 1166 | # "enable-oslogin" |
| 1167 | # "gci-ensure-gke-docker" |
| 1168 | # "gci-metrics-enabled" |
| 1169 | # "gci-update-strategy" |
| 1170 | # "instance-template" |
| 1171 | # "kube-env" |
| 1172 | # "startup-script" |
| 1173 | # "user-data" |
| 1174 | # "disable-address-manager" |
| 1175 | # "windows-startup-script-ps1" |
| 1176 | # "common-psm1" |
| 1177 | # "k8s-node-setup-psm1" |
| 1178 | # "install-ssh-psm1" |
| 1179 | # "user-profile-psm1" |
| 1180 | # "serial-port-logging-enable" |
| 1181 | # Values are free-form strings, and only have meaning as interpreted by |
| 1182 | # the image running in the instance. The only restriction placed on them is |
| 1183 | # that each value's size must be less than or equal to 32 KB. |
| 1184 | # |
| 1185 | # The total size of all keys and values must be less than 512 KB. |
| 1186 | "a_key": "A String", |
| 1187 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1188 | "machineType": "A String", # The name of a Google Compute Engine [machine |
| 1189 | # type](https://cloud.google.com/compute/docs/machine-types) (e.g. |
| 1190 | # `n1-standard-1`). |
| 1191 | # |
| 1192 | # If unspecified, the default machine type is |
| 1193 | # `n1-standard-1`. |
| 1194 | "nodeGroup": "A String", # Setting this field will assign instances of this |
| 1195 | # pool to run on the specified node group. This is useful for running |
| 1196 | # workloads on [sole tenant |
| 1197 | # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). |
| 1198 | "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options. |
| 1199 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. |
| 1200 | # |
| 1201 | # Secure Boot helps ensure that the system only runs authentic software by |
| 1202 | # verifying the digital signature of all boot components, and halting the |
| 1203 | # boot process if signature verification fails. |
| 1204 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. |
| 1205 | # |
| 1206 | # Enables monitoring and attestation of the boot integrity of the instance. |
| 1207 | # The attestation is performed against the integrity policy baseline. This |
| 1208 | # baseline is initially derived from the implicitly trusted boot image when |
| 1209 | # the instance is created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1210 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1211 | "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1212 | # Specify the email address of the Service Account; otherwise, if no Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1213 | # Account is specified, the "default" service account is used. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1214 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 1215 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 1216 | # on the nodes. |
| 1217 | # |
| 1218 | # The following parameters are supported. |
| 1219 | # |
| 1220 | # net.core.netdev_max_backlog |
| 1221 | # net.core.rmem_max |
| 1222 | # net.core.wmem_default |
| 1223 | # net.core.wmem_max |
| 1224 | # net.core.optmem_max |
| 1225 | # net.core.somaxconn |
| 1226 | # net.ipv4.tcp_rmem |
| 1227 | # net.ipv4.tcp_wmem |
| 1228 | # net.ipv4.tcp_tw_reuse |
| 1229 | "a_key": "A String", |
| 1230 | }, |
| 1231 | }, |
| 1232 | "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node. |
| 1233 | "type": "A String", # Type of the sandbox to use for the node. |
| 1234 | "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor') |
| 1235 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1236 | "taints": [ # List of kubernetes taints to be applied to each node. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1237 | # |
| 1238 | # For more information, including usage and the valid values, see: |
| 1239 | # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
| 1240 | { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect |
| 1241 | # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. |
| 1242 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1243 | # See |
| 1244 | # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) |
| 1245 | # for more information, including usage and the valid values. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1246 | "effect": "A String", # Effect for taint. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1247 | "key": "A String", # Key for taint. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1248 | "value": "A String", # Value for taint. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1249 | }, |
| 1250 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1251 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 1252 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 1253 | # |
| 1254 | # The string must be a sequence of decimal numbers, each with optional |
| 1255 | # fraction and a unit suffix, such as "300ms". |
| 1256 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 1257 | # The value must be a positive duration. |
| 1258 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 1259 | # |
| 1260 | # If this option is enabled, kubelet uses CFS quota |
| 1261 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 1262 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 1263 | # all. |
| 1264 | # |
| 1265 | # Disable this option to mitigate CPU throttling problems while still having |
| 1266 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 1267 | # |
| 1268 | # The default value is 'true' if unspecified. |
| 1269 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 1270 | # See |
| 1271 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 1272 | # |
| 1273 | # The following values are allowed. |
| 1274 | # - "none": the default, which represents the existing scheduling behavior. |
| 1275 | # - "static": allows pods with certain resource characteristics to be |
| 1276 | # granted increased CPU affinity and exclusivity on the node. |
| 1277 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1278 | "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| 1279 | # These will added in addition to any default label(s) that |
| 1280 | # Kubernetes may apply to the node. |
| 1281 | # In case of conflict in label keys, the applied set may differ depending on |
| 1282 | # the Kubernetes version -- it's best to assume the behavior is undefined |
| 1283 | # and conflicts should be avoided. |
| 1284 | # For more information, including usage and the valid values, see: |
| 1285 | # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| 1286 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1287 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1288 | "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1289 | # |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1290 | # If unspecified, the default disk type is 'pd-standard' |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1291 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node. |
| 1292 | # workloads on the node pool. |
| 1293 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 1294 | # workloads running on the node. |
| 1295 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1296 | # on the node pool. |
| 1297 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1298 | "bootDiskKmsKey": "A String", # |
| 1299 | # The Customer Managed Encryption Key used to encrypt the boot disk attached |
| 1300 | # to each node in the node pool. This should be of the form |
| 1301 | # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. |
| 1302 | # For more information about protecting resources with Cloud KMS Keys please |
| 1303 | # see: |
| 1304 | # https://cloud.google.com/compute/docs/disks/customer-managed-encryption |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1305 | "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| 1306 | # The smallest allowed disk size is 10GB. |
| 1307 | # |
| 1308 | # If unspecified, the default disk size is 100GB. |
| 1309 | "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) # The optional reservation affinity. Setting this field will apply |
| 1310 | # the specified [Zonal Compute |
| 1311 | # Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) |
| 1312 | # to this node pool. |
| 1313 | # is the configuration of desired reservation which instances could take |
| 1314 | # capacity from. |
| 1315 | "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. |
| 1316 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a |
| 1317 | # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as |
| 1318 | # the key and specify the name of your reservation as its value. |
| 1319 | "values": [ # Corresponds to the label value(s) of reservation resource(s). |
| 1320 | "A String", |
| 1321 | ], |
| 1322 | }, |
| 1323 | "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| 1324 | # https://cloud.google.com/compute/docs/instances/preemptible for more |
| 1325 | # inforamtion about preemptible VM instances. |
| 1326 | "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be |
| 1327 | # scheduled on the specified or newer CPU platform. Applicable values are the |
| 1328 | # friendly names of CPU platforms, such as |
| 1329 | # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or |
| 1330 | # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more |
| 1331 | # information, read [how to specify min CPU |
| 1332 | # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) |
| 1333 | "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| 1334 | # valid sources or targets for network firewalls and are specified by |
| 1335 | # the client during cluster or node pool creation. Each tag within the list |
| 1336 | # must comply with RFC1035. |
| 1337 | "A String", |
| 1338 | ], |
| 1339 | "accelerators": [ # A list of hardware accelerators to be attached to each node. |
| 1340 | # See https://cloud.google.com/compute/docs/gpus for more information about |
| 1341 | # support for GPUs. |
| 1342 | { # AcceleratorConfig represents a Hardware Accelerator request. |
| 1343 | "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. |
| 1344 | "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators |
| 1345 | # [here](https://cloud.google.com/compute/docs/gpus) |
| 1346 | }, |
| 1347 | ], |
| 1348 | "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| 1349 | # |
| 1350 | # The limit for this value is dependent upon the maximum number of |
| 1351 | # disks available on a machine per zone. See: |
| 1352 | # https://cloud.google.com/compute/docs/disks/local-ssd |
| 1353 | # for more information. |
| 1354 | "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| 1355 | # the latest version of it will be used. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1356 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1357 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1358 | "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| 1359 | # node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1360 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1361 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1362 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1363 | # the Auto Upgrades will proceed. |
| 1364 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1365 | # with the description of the upgrade. |
| 1366 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1367 | # with the approximate start time for the upgrades, in |
| 1368 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1369 | }, |
| 1370 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1371 | "name": "A String", # The name of the node pool. |
| 1372 | "version": "A String", # The version of the Kubernetes of this node. |
| 1373 | "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run |
| 1374 | # simultaneously on a node in the node pool. |
| 1375 | "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. |
| 1376 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1377 | "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| 1378 | # node pool instance, if available. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1379 | "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. |
| 1380 | "conditions": [ # Which conditions caused the current node pool state. |
| 1381 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1382 | # (e.g., ERROR or DEGRADED). |
| 1383 | "code": "A String", # Machine-friendly representation of the condition |
| 1384 | "message": "A String", # Human-friendly representation of the condition |
| 1385 | }, |
| 1386 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1387 | "locations": [ # The list of Google Compute Engine |
| 1388 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1389 | # NodePool's nodes should be located. |
| 1390 | "A String", |
| 1391 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1392 | }, |
| 1393 | ], |
| 1394 | }</pre> |
| 1395 | </div> |
| 1396 | |
| 1397 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1398 | <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1399 | <pre>Rolls back a previously Aborted or Failed NodePool upgrade. |
| 1400 | This makes no changes if the last upgrade successfully completed. |
| 1401 | |
| 1402 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1403 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1404 | number](https://support.google.com/cloud/answer/6158840). |
| 1405 | 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] | 1406 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1407 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1408 | cluster resides. This field has been deprecated and replaced by the name |
| 1409 | field. (required) |
| 1410 | clusterId: string, Required. Deprecated. The name of the cluster to rollback. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1411 | 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] | 1412 | nodePoolId: string, Required. Deprecated. The name of the node pool to rollback. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1413 | 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] | 1414 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1415 | The object takes the form of: |
| 1416 | |
| 1417 | { # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed |
| 1418 | # NodePool upgrade. This will be an no-op if the last upgrade successfully |
| 1419 | # completed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1420 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1421 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1422 | # cluster resides. This field has been deprecated and replaced by the name |
| 1423 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1424 | "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to |
| 1425 | # rollback upgrade. |
| 1426 | # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. |
| 1427 | "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to rollback. |
| 1428 | # This field has been deprecated and replaced by the name field. |
| 1429 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 1430 | # number](https://support.google.com/cloud/answer/6158840). |
| 1431 | # This field has been deprecated and replaced by the name field. |
| 1432 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to rollback. |
| 1433 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1434 | } |
| 1435 | |
| 1436 | x__xgafv: string, V1 error format. |
| 1437 | Allowed values |
| 1438 | 1 - v1 error format |
| 1439 | 2 - v2 error format |
| 1440 | |
| 1441 | Returns: |
| 1442 | An object of the form: |
| 1443 | |
| 1444 | { # This operation resource represents operations that may have happened or are |
| 1445 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1446 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1447 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1448 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1449 | "stages": [ # Substages of an operation or a stage. |
| 1450 | # Object with schema name: OperationProgress |
| 1451 | ], |
| 1452 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1453 | # Unset for single-stage operations. |
| 1454 | "status": "A String", # Status of an operation stage. |
| 1455 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1456 | "metrics": [ # Progress metric bundle, for example: |
| 1457 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1458 | # {name: "nodes total", int_value: 32}] |
| 1459 | # or |
| 1460 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1461 | # {name: "progress scale", double_value: 1.0}] |
| 1462 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1463 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1464 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1465 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1466 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1467 | }, |
| 1468 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1469 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1470 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1471 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1472 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1473 | # or |
| 1474 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1475 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1476 | "zone": "A String", # The name of the Google Compute Engine |
| 1477 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1478 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1479 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1480 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1481 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1482 | "name": "A String", # The server-assigned ID for the operation. |
| 1483 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1484 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1485 | # (e.g., ERROR or DEGRADED). |
| 1486 | "code": "A String", # Machine-friendly representation of the condition |
| 1487 | "message": "A String", # Human-friendly representation of the condition |
| 1488 | }, |
| 1489 | ], |
| 1490 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1491 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1492 | "detail": "A String", # Detailed operation progress, if available. |
| 1493 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1494 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1495 | # (e.g., ERROR or DEGRADED). |
| 1496 | "code": "A String", # Machine-friendly representation of the condition |
| 1497 | "message": "A String", # Human-friendly representation of the condition |
| 1498 | }, |
| 1499 | ], |
| 1500 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1501 | }</pre> |
| 1502 | </div> |
| 1503 | |
| 1504 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1505 | <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1506 | <pre>Sets the NodeManagement options for a node pool. |
| 1507 | |
| 1508 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1509 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1510 | number](https://support.google.com/cloud/answer/6158840). |
| 1511 | 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] | 1512 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1513 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1514 | cluster resides. This field has been deprecated and replaced by the name |
| 1515 | field. (required) |
| 1516 | clusterId: string, Required. Deprecated. The name of the cluster to update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1517 | 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] | 1518 | nodePoolId: string, Required. Deprecated. The name of the node pool to update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1519 | 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] | 1520 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1521 | The object takes the form of: |
| 1522 | |
| 1523 | { # SetNodePoolManagementRequest sets the node management properties of a node |
| 1524 | # pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1525 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1526 | # number](https://support.google.com/cloud/answer/6158840). |
| 1527 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1528 | "management": { # NodeManagement defines the set of node management services turned on for the # Required. NodeManagement configuration for the node pool. |
| 1529 | # node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1530 | "autoRepair": True or False, # Whether the nodes will be automatically repaired. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1531 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1532 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| 1533 | # the Auto Upgrades will proceed. |
| 1534 | "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1535 | # with the description of the upgrade. |
| 1536 | "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| 1537 | # with the approximate start time for the upgrades, in |
| 1538 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1539 | }, |
| 1540 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1541 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 1542 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1543 | # cluster resides. This field has been deprecated and replaced by the name |
| 1544 | # field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1545 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. |
| 1546 | # This field has been deprecated and replaced by the name field. |
| 1547 | "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set |
| 1548 | # management properties. Specified in the format |
| 1549 | # `projects/*/locations/*/clusters/*/nodePools/*`. |
| 1550 | "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. |
| 1551 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1552 | } |
| 1553 | |
| 1554 | x__xgafv: string, V1 error format. |
| 1555 | Allowed values |
| 1556 | 1 - v1 error format |
| 1557 | 2 - v2 error format |
| 1558 | |
| 1559 | Returns: |
| 1560 | An object of the form: |
| 1561 | |
| 1562 | { # This operation resource represents operations that may have happened or are |
| 1563 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1564 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1565 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1566 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1567 | "stages": [ # Substages of an operation or a stage. |
| 1568 | # Object with schema name: OperationProgress |
| 1569 | ], |
| 1570 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1571 | # Unset for single-stage operations. |
| 1572 | "status": "A String", # Status of an operation stage. |
| 1573 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1574 | "metrics": [ # Progress metric bundle, for example: |
| 1575 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1576 | # {name: "nodes total", int_value: 32}] |
| 1577 | # or |
| 1578 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1579 | # {name: "progress scale", double_value: 1.0}] |
| 1580 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1581 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1582 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1583 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1584 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1585 | }, |
| 1586 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1587 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1588 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1589 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1590 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1591 | # or |
| 1592 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1593 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1594 | "zone": "A String", # The name of the Google Compute Engine |
| 1595 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1596 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1597 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1598 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1599 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1600 | "name": "A String", # The server-assigned ID for the operation. |
| 1601 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1602 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1603 | # (e.g., ERROR or DEGRADED). |
| 1604 | "code": "A String", # Machine-friendly representation of the condition |
| 1605 | "message": "A String", # Human-friendly representation of the condition |
| 1606 | }, |
| 1607 | ], |
| 1608 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1609 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1610 | "detail": "A String", # Detailed operation progress, if available. |
| 1611 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1612 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1613 | # (e.g., ERROR or DEGRADED). |
| 1614 | "code": "A String", # Machine-friendly representation of the condition |
| 1615 | "message": "A String", # Human-friendly representation of the condition |
| 1616 | }, |
| 1617 | ], |
| 1618 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1619 | }</pre> |
| 1620 | </div> |
| 1621 | |
| 1622 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1623 | <code class="details" id="setSize">setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1624 | <pre>Sets the size for a specific node pool. |
| 1625 | |
| 1626 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1627 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1628 | number](https://support.google.com/cloud/answer/6158840). |
| 1629 | 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] | 1630 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1631 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1632 | cluster resides. This field has been deprecated and replaced by the name |
| 1633 | field. (required) |
| 1634 | clusterId: string, Required. Deprecated. The name of the cluster to update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1635 | 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] | 1636 | nodePoolId: string, Required. Deprecated. The name of the node pool to update. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1637 | 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] | 1638 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1639 | The object takes the form of: |
| 1640 | |
| 1641 | { # SetNodePoolSizeRequest sets the size a node |
| 1642 | # pool. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1643 | "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set |
| 1644 | # size. |
| 1645 | # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. |
| 1646 | "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1647 | # This field has been deprecated and replaced by the name field. |
| 1648 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. |
| 1649 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1650 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| 1651 | # number](https://support.google.com/cloud/answer/6158840). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1652 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1653 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1654 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1655 | # cluster resides. This field has been deprecated and replaced by the name |
| 1656 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1657 | "nodeCount": 42, # Required. The desired node count for the pool. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1658 | } |
| 1659 | |
| 1660 | x__xgafv: string, V1 error format. |
| 1661 | Allowed values |
| 1662 | 1 - v1 error format |
| 1663 | 2 - v2 error format |
| 1664 | |
| 1665 | Returns: |
| 1666 | An object of the form: |
| 1667 | |
| 1668 | { # This operation resource represents operations that may have happened or are |
| 1669 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1670 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1671 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1672 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1673 | "stages": [ # Substages of an operation or a stage. |
| 1674 | # Object with schema name: OperationProgress |
| 1675 | ], |
| 1676 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1677 | # Unset for single-stage operations. |
| 1678 | "status": "A String", # Status of an operation stage. |
| 1679 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1680 | "metrics": [ # Progress metric bundle, for example: |
| 1681 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1682 | # {name: "nodes total", int_value: 32}] |
| 1683 | # or |
| 1684 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1685 | # {name: "progress scale", double_value: 1.0}] |
| 1686 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1687 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1688 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1689 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1690 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1691 | }, |
| 1692 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1693 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1694 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1695 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1696 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1697 | # or |
| 1698 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1699 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1700 | "zone": "A String", # The name of the Google Compute Engine |
| 1701 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1702 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1703 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1704 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1705 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1706 | "name": "A String", # The server-assigned ID for the operation. |
| 1707 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1708 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1709 | # (e.g., ERROR or DEGRADED). |
| 1710 | "code": "A String", # Machine-friendly representation of the condition |
| 1711 | "message": "A String", # Human-friendly representation of the condition |
| 1712 | }, |
| 1713 | ], |
| 1714 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1715 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1716 | "detail": "A String", # Detailed operation progress, if available. |
| 1717 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1718 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1719 | # (e.g., ERROR or DEGRADED). |
| 1720 | "code": "A String", # Machine-friendly representation of the condition |
| 1721 | "message": "A String", # Human-friendly representation of the condition |
| 1722 | }, |
| 1723 | ], |
| 1724 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1725 | }</pre> |
| 1726 | </div> |
| 1727 | |
| 1728 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1729 | <code class="details" id="update">update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1730 | <pre>Updates the version and/or image type of a specific node pool. |
| 1731 | |
| 1732 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1733 | projectId: string, Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1734 | number](https://support.google.com/cloud/answer/6158840). |
| 1735 | 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] | 1736 | zone: string, Required. Deprecated. The name of the Google Compute Engine |
| 1737 | [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1738 | cluster resides. This field has been deprecated and replaced by the name |
| 1739 | field. (required) |
| 1740 | clusterId: string, Required. Deprecated. The name of the cluster to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1741 | 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] | 1742 | nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1743 | 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] | 1744 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1745 | The object takes the form of: |
| 1746 | |
| 1747 | { # SetNodePoolVersionRequest updates the version of a node pool. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1748 | "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1749 | # number](https://support.google.com/cloud/answer/6158840). |
| 1750 | # This field has been deprecated and replaced by the name field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1751 | "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] | 1752 | # disruption caused by an upgrade. |
| 1753 | # |
| 1754 | # maxUnavailable controls the number of nodes that can be simultaneously |
| 1755 | # unavailable. |
| 1756 | # |
| 1757 | # maxSurge controls the number of additional nodes that can be added to the |
| 1758 | # node pool temporarily for the time of the upgrade to increase the number of |
| 1759 | # available nodes. |
| 1760 | # |
| 1761 | # (maxUnavailable + maxSurge) determines the level of parallelism (how many |
| 1762 | # nodes are being upgraded at the same time). |
| 1763 | # |
| 1764 | # Note: upgrades inevitably introduce some disruption since workloads need to |
| 1765 | # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, |
| 1766 | # this holds true. (Disruption stays within the limits of |
| 1767 | # PodDisruptionBudget, if it is configured.) |
| 1768 | # |
| 1769 | # Consider a hypothetical node pool with 5 nodes having maxSurge=2, |
| 1770 | # maxUnavailable=1. This means the upgrade process upgrades 3 nodes |
| 1771 | # simultaneously. It creates 2 additional (upgraded) nodes, then it brings |
| 1772 | # down 3 old (not yet upgraded) nodes at the same time. This ensures that |
| 1773 | # there are always at least 4 nodes available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1774 | "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] | 1775 | # the upgrade process. A node is considered available if its status is |
| 1776 | # Ready. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1777 | "maxSurge": 42, # The maximum number of nodes that can be created beyond the current size |
| 1778 | # of the node pool during the upgrade process. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1779 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1780 | "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. |
| 1781 | # This field has been deprecated and replaced by the name field. |
| 1782 | "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. |
| 1783 | # This field has been deprecated and replaced by the name field. |
| 1784 | "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an |
| 1785 | # upgrade). |
| 1786 | # |
| 1787 | # Users may specify either explicit versions offered by Kubernetes Engine or |
| 1788 | # version aliases, which have the following behavior: |
| 1789 | # |
| 1790 | # - "latest": picks the highest valid Kubernetes version |
| 1791 | # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version |
| 1792 | # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version |
| 1793 | # - "1.X.Y-gke.N": picks an explicit Kubernetes version |
| 1794 | # - "-": picks the Kubernetes master version |
| 1795 | "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine |
| 1796 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1797 | # cluster resides. This field has been deprecated and replaced by the name |
| 1798 | # field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1799 | "locations": [ # The desired list of Google Compute Engine |
| 1800 | # [zones](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1801 | # node pool's nodes should be located. Changing the locations for a node pool |
| 1802 | # will result in nodes being either created or removed from the node pool, |
| 1803 | # depending on whether locations are being added or removed. |
| 1804 | "A String", |
| 1805 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1806 | "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. |
| 1807 | "cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. |
| 1808 | # |
| 1809 | # The string must be a sequence of decimal numbers, each with optional |
| 1810 | # fraction and a unit suffix, such as "300ms". |
| 1811 | # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". |
| 1812 | # The value must be a positive duration. |
| 1813 | "cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. |
| 1814 | # |
| 1815 | # If this option is enabled, kubelet uses CFS quota |
| 1816 | # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to |
| 1817 | # enforce container CPU limits. Otherwise, CPU limits will not be enforced at |
| 1818 | # all. |
| 1819 | # |
| 1820 | # Disable this option to mitigate CPU throttling problems while still having |
| 1821 | # your pods to be in Guaranteed QoS class by specifying the CPU limits. |
| 1822 | # |
| 1823 | # The default value is 'true' if unspecified. |
| 1824 | "cpuManagerPolicy": "A String", # Control the CPU management policy on the node. |
| 1825 | # See |
| 1826 | # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ |
| 1827 | # |
| 1828 | # The following values are allowed. |
| 1829 | # - "none": the default, which represents the existing scheduling behavior. |
| 1830 | # - "static": allows pods with certain resource characteristics to be |
| 1831 | # granted increased CPU affinity and exclusivity on the node. |
| 1832 | }, |
| 1833 | "imageType": "A String", # Required. The desired image type for the node pool. |
| 1834 | "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired workload metadata config for the node pool. |
| 1835 | # workloads on the node pool. |
| 1836 | "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the |
| 1837 | # workloads running on the node. |
| 1838 | "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running |
| 1839 | # on the node pool. |
| 1840 | }, |
| 1841 | "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes. |
| 1842 | "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running |
| 1843 | # on the nodes. |
| 1844 | # |
| 1845 | # The following parameters are supported. |
| 1846 | # |
| 1847 | # net.core.netdev_max_backlog |
| 1848 | # net.core.rmem_max |
| 1849 | # net.core.wmem_default |
| 1850 | # net.core.wmem_max |
| 1851 | # net.core.optmem_max |
| 1852 | # net.core.somaxconn |
| 1853 | # net.ipv4.tcp_rmem |
| 1854 | # net.ipv4.tcp_wmem |
| 1855 | # net.ipv4.tcp_tw_reuse |
| 1856 | "a_key": "A String", |
| 1857 | }, |
| 1858 | }, |
| 1859 | "name": "A String", # The name (project, location, cluster, node pool) of the node pool to |
| 1860 | # update. Specified in the format |
| 1861 | # `projects/*/locations/*/clusters/*/nodePools/*`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1862 | } |
| 1863 | |
| 1864 | x__xgafv: string, V1 error format. |
| 1865 | Allowed values |
| 1866 | 1 - v1 error format |
| 1867 | 2 - v2 error format |
| 1868 | |
| 1869 | Returns: |
| 1870 | An object of the form: |
| 1871 | |
| 1872 | { # This operation resource represents operations that may have happened or are |
| 1873 | # happening on the cluster. All fields are output only. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1874 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1875 | "operationType": "A String", # The operation type. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1876 | "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1877 | "stages": [ # Substages of an operation or a stage. |
| 1878 | # Object with schema name: OperationProgress |
| 1879 | ], |
| 1880 | "name": "A String", # A non-parameterized string describing an operation stage. |
| 1881 | # Unset for single-stage operations. |
| 1882 | "status": "A String", # Status of an operation stage. |
| 1883 | # Unset for single-stage operations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1884 | "metrics": [ # Progress metric bundle, for example: |
| 1885 | # metrics: [{name: "nodes done", int_value: 15}, |
| 1886 | # {name: "nodes total", int_value: 32}] |
| 1887 | # or |
| 1888 | # metrics: [{name: "progress", double_value: 0.56}, |
| 1889 | # {name: "progress scale", double_value: 1.0}] |
| 1890 | { # Progress metric is (string, int|float|string) pair. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1891 | "doubleValue": 3.14, # For metrics with floating point value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1892 | "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1893 | "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done". |
| 1894 | "intValue": "A String", # For metrics with integer value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1895 | }, |
| 1896 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1897 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1898 | "selfLink": "A String", # Server-defined URL for the resource. |
| 1899 | "location": "A String", # [Output only] The name of the Google Compute Engine |
| 1900 | # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1901 | # or |
| 1902 | # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) |
| 1903 | # in which the cluster resides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1904 | "zone": "A String", # The name of the Google Compute Engine |
| 1905 | # [zone](https://cloud.google.com/compute/docs/zones#available) in which the |
| 1906 | # operation is taking place. This field is deprecated, use location instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1907 | "endTime": "A String", # [Output only] The time the operation completed, in |
| 1908 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1909 | "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1910 | "name": "A String", # The server-assigned ID for the operation. |
| 1911 | "clusterConditions": [ # Which conditions caused the current cluster state. |
| 1912 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1913 | # (e.g., ERROR or DEGRADED). |
| 1914 | "code": "A String", # Machine-friendly representation of the condition |
| 1915 | "message": "A String", # Human-friendly representation of the condition |
| 1916 | }, |
| 1917 | ], |
| 1918 | "startTime": "A String", # [Output only] The time the operation started, in |
| 1919 | # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| 1920 | "detail": "A String", # Detailed operation progress, if available. |
| 1921 | "nodepoolConditions": [ # Which conditions caused the current node pool state. |
| 1922 | { # StatusCondition describes why a cluster or a node pool has a certain status |
| 1923 | # (e.g., ERROR or DEGRADED). |
| 1924 | "code": "A String", # Machine-friendly representation of the condition |
| 1925 | "message": "A String", # Human-friendly representation of the condition |
| 1926 | }, |
| 1927 | ], |
| 1928 | "status": "A String", # The current status of the operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1929 | }</pre> |
| 1930 | </div> |
| 1931 | |
| 1932 | </body></html> |