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