1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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_v1.html">Google Container Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.clusters.html">clusters</a> . <a href="container_v1.projects.zones.clusters.nodePools.html">nodePools</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a node pool for a cluster.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a node pool from a cluster.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves the node pool requested.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(projectId, zone, clusterId, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the node pools for a cluster.</p> 89<p class="toc_element"> 90 <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 91<p class="firstline">Roll back the previously Aborted or Failed NodePool upgrade.</p> 92<p class="toc_element"> 93 <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Sets the NodeManagement options for a node pool.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(projectId, zone, clusterId, body, x__xgafv=None)</code> 98 <pre>Creates a node pool for a cluster. 99 100Args: 101 projectId: string, The Google Developers Console [project ID or project 102number](https://developers.google.com/console/help/new/#projectnumber). (required) 103 zone: string, The name of the Google Compute Engine 104[zone](/compute/docs/zones#available) in which the cluster 105resides. (required) 106 clusterId: string, The name of the cluster. (required) 107 body: object, The request body. (required) 108 The object takes the form of: 109 110{ # CreateNodePoolRequest creates a node pool for a cluster. 111 "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # The node pool to create. 112 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 113 # specification, under the control of the cluster master. They may have a set 114 # of Kubernetes labels applied to them, which may be used to reference them 115 # during pod scheduling. They may also be resized up or down, to accommodate 116 # the workload. 117 "status": "A String", # [Output only] The status of the nodes in this pool instance. 118 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 119 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 120 # node pool. 121 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 122 # pool. If enabled, the nodes in this node pool will be monitored and, if 123 # they fail health checks too many times, an automatic repair action will be 124 # triggered. 125 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 126 # the Auto Upgrades will proceed. 127 "description": "A String", # [Output only] This field is set when upgrades are about to commence 128 # with the description of the upgrade. 129 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 130 # with the approximate start time for the upgrades, in 131 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 132 }, 133 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 134 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 135 # up to date with the latest release version of Kubernetes. 136 }, 137 "name": "A String", # The name of the node pool. 138 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance 139 # groups](/compute/docs/instance-groups/) associated with this 140 # node pool. 141 "A String", 142 ], 143 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 144 # only if a valid configuration is present. 145 # adjust the size of the node pool to the current cluster usage. 146 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 147 # max_node_count. 148 "enabled": True or False, # Is autoscaling enabled for this node pool. 149 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 150 # has to enough quota to scale up the cluster. 151 }, 152 "version": "A String", # [Output only] The version of the Kubernetes of this node. 153 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 154 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 155 # is sufficient for this number of instances. You must also have available 156 # firewall and routes quota. 157 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 158 "machineType": "A String", # The name of a Google Compute Engine [machine 159 # type](/compute/docs/machine-types) (e.g. 160 # `n1-standard-1`). 161 # 162 # If unspecified, the default machine type is 163 # `n1-standard-1`. 164 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 165 # valid sources or targets for network firewalls and are specified by 166 # the client during cluster or node pool creation. Each tag within the list 167 # must comply with RFC1035. 168 "A String", 169 ], 170 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 171 # https://cloud.google.com/compute/docs/instances/preemptible for more 172 # inforamtion about preemptible VM instances. 173 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 174 # These will added in addition to any default label(s) that 175 # Kubernetes may apply to the node. 176 # In case of conflict in label keys, the applied set may differ depending on 177 # the Kubernetes version -- it's best to assume the behavior is undefined 178 # and conflicts should be avoided. 179 # For more information, including usage and the valid values, see: 180 # http://kubernetes.io/v1.1/docs/user-guide/labels.html 181 "a_key": "A String", 182 }, 183 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 184 # no Service Account is specified, the "default" service account is used. 185 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 186 # node VMs under the "default" service account. 187 # 188 # The following scopes are recommended, but not required, and by default are 189 # not included: 190 # 191 # * `https://www.googleapis.com/auth/compute` is required for mounting 192 # persistent storage on your nodes. 193 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 194 # communicating with **gcr.io** 195 # (the [Google Container Registry](/container-registry/)). 196 # 197 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 198 # Monitoring are enabled, in which case their required scopes will be added. 199 "A String", 200 ], 201 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 202 # The smallest allowed disk size is 10GB. 203 # 204 # If unspecified, the default disk size is 100GB. 205 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 206 # 207 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 208 # in length. These are reflected as part of a URL in the metadata server. 209 # Additionally, to avoid ambiguity, keys must not conflict with any other 210 # metadata keys for the project or be one of the four reserved keys: 211 # "instance-template", "kube-env", "startup-script", and "user-data" 212 # 213 # Values are free-form strings, and only have meaning as interpreted by 214 # the image running in the instance. The only restriction placed on them is 215 # that each value's size must be less than or equal to 32 KB. 216 # 217 # The total size of all keys and values must be less than 512 KB. 218 "a_key": "A String", 219 }, 220 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 221 # the latest version of it will be used. 222 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 223 # 224 # The limit for this value is dependant upon the maximum number of 225 # disks available on a machine per zone. See: 226 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 227 # for more information. 228 }, 229 "statusMessage": "A String", # [Output only] Additional information about the current status of this 230 # node pool instance, if available. 231 }, 232 } 233 234 x__xgafv: string, V1 error format. 235 Allowed values 236 1 - v1 error format 237 2 - v2 error format 238 239Returns: 240 An object of the form: 241 242 { # This operation resource represents operations that may have happened or are 243 # happening on the cluster. All fields are output only. 244 "status": "A String", # The current status of the operation. 245 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 246 "name": "A String", # The server-assigned ID for the operation. 247 "zone": "A String", # The name of the Google Compute Engine 248 # [zone](/compute/docs/zones#available) in which the operation 249 # is taking place. 250 "detail": "A String", # Detailed operation progress, if available. 251 "targetLink": "A String", # Server-defined URL for the target of the operation. 252 "operationType": "A String", # The operation type. 253 "selfLink": "A String", # Server-defined URL for the resource. 254 }</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> 259 <pre>Deletes a node pool from a cluster. 260 261Args: 262 projectId: string, The Google Developers Console [project ID or project 263number](https://developers.google.com/console/help/new/#projectnumber). (required) 264 zone: string, The name of the Google Compute Engine 265[zone](/compute/docs/zones#available) in which the cluster 266resides. (required) 267 clusterId: string, The name of the cluster. (required) 268 nodePoolId: string, The name of the node pool to delete. (required) 269 x__xgafv: string, V1 error format. 270 Allowed values 271 1 - v1 error format 272 2 - v2 error format 273 274Returns: 275 An object of the form: 276 277 { # This operation resource represents operations that may have happened or are 278 # happening on the cluster. All fields are output only. 279 "status": "A String", # The current status of the operation. 280 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 281 "name": "A String", # The server-assigned ID for the operation. 282 "zone": "A String", # The name of the Google Compute Engine 283 # [zone](/compute/docs/zones#available) in which the operation 284 # is taking place. 285 "detail": "A String", # Detailed operation progress, if available. 286 "targetLink": "A String", # Server-defined URL for the target of the operation. 287 "operationType": "A String", # The operation type. 288 "selfLink": "A String", # Server-defined URL for the resource. 289 }</pre> 290</div> 291 292<div class="method"> 293 <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> 294 <pre>Retrieves the node pool requested. 295 296Args: 297 projectId: string, The Google Developers Console [project ID or project 298number](https://developers.google.com/console/help/new/#projectnumber). (required) 299 zone: string, The name of the Google Compute Engine 300[zone](/compute/docs/zones#available) in which the cluster 301resides. (required) 302 clusterId: string, The name of the cluster. (required) 303 nodePoolId: string, The name of the node pool. (required) 304 x__xgafv: string, V1 error format. 305 Allowed values 306 1 - v1 error format 307 2 - v2 error format 308 309Returns: 310 An object of the form: 311 312 { # NodePool contains the name and configuration for a cluster's node pool. 313 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 314 # specification, under the control of the cluster master. They may have a set 315 # of Kubernetes labels applied to them, which may be used to reference them 316 # during pod scheduling. They may also be resized up or down, to accommodate 317 # the workload. 318 "status": "A String", # [Output only] The status of the nodes in this pool instance. 319 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 320 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 321 # node pool. 322 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 323 # pool. If enabled, the nodes in this node pool will be monitored and, if 324 # they fail health checks too many times, an automatic repair action will be 325 # triggered. 326 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 327 # the Auto Upgrades will proceed. 328 "description": "A String", # [Output only] This field is set when upgrades are about to commence 329 # with the description of the upgrade. 330 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 331 # with the approximate start time for the upgrades, in 332 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 333 }, 334 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 335 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 336 # up to date with the latest release version of Kubernetes. 337 }, 338 "name": "A String", # The name of the node pool. 339 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance 340 # groups](/compute/docs/instance-groups/) associated with this 341 # node pool. 342 "A String", 343 ], 344 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 345 # only if a valid configuration is present. 346 # adjust the size of the node pool to the current cluster usage. 347 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 348 # max_node_count. 349 "enabled": True or False, # Is autoscaling enabled for this node pool. 350 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 351 # has to enough quota to scale up the cluster. 352 }, 353 "version": "A String", # [Output only] The version of the Kubernetes of this node. 354 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 355 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 356 # is sufficient for this number of instances. You must also have available 357 # firewall and routes quota. 358 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 359 "machineType": "A String", # The name of a Google Compute Engine [machine 360 # type](/compute/docs/machine-types) (e.g. 361 # `n1-standard-1`). 362 # 363 # If unspecified, the default machine type is 364 # `n1-standard-1`. 365 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 366 # valid sources or targets for network firewalls and are specified by 367 # the client during cluster or node pool creation. Each tag within the list 368 # must comply with RFC1035. 369 "A String", 370 ], 371 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 372 # https://cloud.google.com/compute/docs/instances/preemptible for more 373 # inforamtion about preemptible VM instances. 374 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 375 # These will added in addition to any default label(s) that 376 # Kubernetes may apply to the node. 377 # In case of conflict in label keys, the applied set may differ depending on 378 # the Kubernetes version -- it's best to assume the behavior is undefined 379 # and conflicts should be avoided. 380 # For more information, including usage and the valid values, see: 381 # http://kubernetes.io/v1.1/docs/user-guide/labels.html 382 "a_key": "A String", 383 }, 384 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 385 # no Service Account is specified, the "default" service account is used. 386 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 387 # node VMs under the "default" service account. 388 # 389 # The following scopes are recommended, but not required, and by default are 390 # not included: 391 # 392 # * `https://www.googleapis.com/auth/compute` is required for mounting 393 # persistent storage on your nodes. 394 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 395 # communicating with **gcr.io** 396 # (the [Google Container Registry](/container-registry/)). 397 # 398 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 399 # Monitoring are enabled, in which case their required scopes will be added. 400 "A String", 401 ], 402 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 403 # The smallest allowed disk size is 10GB. 404 # 405 # If unspecified, the default disk size is 100GB. 406 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 407 # 408 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 409 # in length. These are reflected as part of a URL in the metadata server. 410 # Additionally, to avoid ambiguity, keys must not conflict with any other 411 # metadata keys for the project or be one of the four reserved keys: 412 # "instance-template", "kube-env", "startup-script", and "user-data" 413 # 414 # Values are free-form strings, and only have meaning as interpreted by 415 # the image running in the instance. The only restriction placed on them is 416 # that each value's size must be less than or equal to 32 KB. 417 # 418 # The total size of all keys and values must be less than 512 KB. 419 "a_key": "A String", 420 }, 421 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 422 # the latest version of it will be used. 423 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 424 # 425 # The limit for this value is dependant upon the maximum number of 426 # disks available on a machine per zone. See: 427 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 428 # for more information. 429 }, 430 "statusMessage": "A String", # [Output only] Additional information about the current status of this 431 # node pool instance, if available. 432 }</pre> 433</div> 434 435<div class="method"> 436 <code class="details" id="list">list(projectId, zone, clusterId, x__xgafv=None)</code> 437 <pre>Lists the node pools for a cluster. 438 439Args: 440 projectId: string, The Google Developers Console [project ID or project 441number](https://developers.google.com/console/help/new/#projectnumber). (required) 442 zone: string, The name of the Google Compute Engine 443[zone](/compute/docs/zones#available) in which the cluster 444resides. (required) 445 clusterId: string, The name of the cluster. (required) 446 x__xgafv: string, V1 error format. 447 Allowed values 448 1 - v1 error format 449 2 - v2 error format 450 451Returns: 452 An object of the form: 453 454 { # ListNodePoolsResponse is the result of ListNodePoolsRequest. 455 "nodePools": [ # A list of node pools for a cluster. 456 { # NodePool contains the name and configuration for a cluster's node pool. 457 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 458 # specification, under the control of the cluster master. They may have a set 459 # of Kubernetes labels applied to them, which may be used to reference them 460 # during pod scheduling. They may also be resized up or down, to accommodate 461 # the workload. 462 "status": "A String", # [Output only] The status of the nodes in this pool instance. 463 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 464 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 465 # node pool. 466 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 467 # pool. If enabled, the nodes in this node pool will be monitored and, if 468 # they fail health checks too many times, an automatic repair action will be 469 # triggered. 470 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 471 # the Auto Upgrades will proceed. 472 "description": "A String", # [Output only] This field is set when upgrades are about to commence 473 # with the description of the upgrade. 474 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 475 # with the approximate start time for the upgrades, in 476 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 477 }, 478 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 479 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 480 # up to date with the latest release version of Kubernetes. 481 }, 482 "name": "A String", # The name of the node pool. 483 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance 484 # groups](/compute/docs/instance-groups/) associated with this 485 # node pool. 486 "A String", 487 ], 488 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 489 # only if a valid configuration is present. 490 # adjust the size of the node pool to the current cluster usage. 491 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 492 # max_node_count. 493 "enabled": True or False, # Is autoscaling enabled for this node pool. 494 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 495 # has to enough quota to scale up the cluster. 496 }, 497 "version": "A String", # [Output only] The version of the Kubernetes of this node. 498 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 499 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 500 # is sufficient for this number of instances. You must also have available 501 # firewall and routes quota. 502 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 503 "machineType": "A String", # The name of a Google Compute Engine [machine 504 # type](/compute/docs/machine-types) (e.g. 505 # `n1-standard-1`). 506 # 507 # If unspecified, the default machine type is 508 # `n1-standard-1`. 509 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 510 # valid sources or targets for network firewalls and are specified by 511 # the client during cluster or node pool creation. Each tag within the list 512 # must comply with RFC1035. 513 "A String", 514 ], 515 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 516 # https://cloud.google.com/compute/docs/instances/preemptible for more 517 # inforamtion about preemptible VM instances. 518 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 519 # These will added in addition to any default label(s) that 520 # Kubernetes may apply to the node. 521 # In case of conflict in label keys, the applied set may differ depending on 522 # the Kubernetes version -- it's best to assume the behavior is undefined 523 # and conflicts should be avoided. 524 # For more information, including usage and the valid values, see: 525 # http://kubernetes.io/v1.1/docs/user-guide/labels.html 526 "a_key": "A String", 527 }, 528 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 529 # no Service Account is specified, the "default" service account is used. 530 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 531 # node VMs under the "default" service account. 532 # 533 # The following scopes are recommended, but not required, and by default are 534 # not included: 535 # 536 # * `https://www.googleapis.com/auth/compute` is required for mounting 537 # persistent storage on your nodes. 538 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 539 # communicating with **gcr.io** 540 # (the [Google Container Registry](/container-registry/)). 541 # 542 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 543 # Monitoring are enabled, in which case their required scopes will be added. 544 "A String", 545 ], 546 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 547 # The smallest allowed disk size is 10GB. 548 # 549 # If unspecified, the default disk size is 100GB. 550 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 551 # 552 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 553 # in length. These are reflected as part of a URL in the metadata server. 554 # Additionally, to avoid ambiguity, keys must not conflict with any other 555 # metadata keys for the project or be one of the four reserved keys: 556 # "instance-template", "kube-env", "startup-script", and "user-data" 557 # 558 # Values are free-form strings, and only have meaning as interpreted by 559 # the image running in the instance. The only restriction placed on them is 560 # that each value's size must be less than or equal to 32 KB. 561 # 562 # The total size of all keys and values must be less than 512 KB. 563 "a_key": "A String", 564 }, 565 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 566 # the latest version of it will be used. 567 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 568 # 569 # The limit for this value is dependant upon the maximum number of 570 # disks available on a machine per zone. See: 571 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 572 # for more information. 573 }, 574 "statusMessage": "A String", # [Output only] Additional information about the current status of this 575 # node pool instance, if available. 576 }, 577 ], 578 }</pre> 579</div> 580 581<div class="method"> 582 <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 583 <pre>Roll back the previously Aborted or Failed NodePool upgrade. 584This will be an no-op if the last upgrade successfully completed. 585 586Args: 587 projectId: string, The Google Developers Console [project ID or project 588number](https://support.google.com/cloud/answer/6158840). (required) 589 zone: string, The name of the Google Compute Engine 590[zone](/compute/docs/zones#available) in which the cluster 591resides. (required) 592 clusterId: string, The name of the cluster to rollback. (required) 593 nodePoolId: string, The name of the node pool to rollback. (required) 594 body: object, The request body. (required) 595 The object takes the form of: 596 597{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed 598 # NodePool upgrade. This will be an no-op if the last upgrade successfully 599 # completed. 600 } 601 602 x__xgafv: string, V1 error format. 603 Allowed values 604 1 - v1 error format 605 2 - v2 error format 606 607Returns: 608 An object of the form: 609 610 { # This operation resource represents operations that may have happened or are 611 # happening on the cluster. All fields are output only. 612 "status": "A String", # The current status of the operation. 613 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 614 "name": "A String", # The server-assigned ID for the operation. 615 "zone": "A String", # The name of the Google Compute Engine 616 # [zone](/compute/docs/zones#available) in which the operation 617 # is taking place. 618 "detail": "A String", # Detailed operation progress, if available. 619 "targetLink": "A String", # Server-defined URL for the target of the operation. 620 "operationType": "A String", # The operation type. 621 "selfLink": "A String", # Server-defined URL for the resource. 622 }</pre> 623</div> 624 625<div class="method"> 626 <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 627 <pre>Sets the NodeManagement options for a node pool. 628 629Args: 630 projectId: string, The Google Developers Console [project ID or project 631number](https://support.google.com/cloud/answer/6158840). (required) 632 zone: string, The name of the Google Compute Engine 633[zone](/compute/docs/zones#available) in which the cluster 634resides. (required) 635 clusterId: string, The name of the cluster to update. (required) 636 nodePoolId: string, The name of the node pool to update. (required) 637 body: object, The request body. (required) 638 The object takes the form of: 639 640{ # SetNodePoolManagementRequest sets the node management properties of a node 641 # pool. 642 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for the node pool. 643 # node pool. 644 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 645 # pool. If enabled, the nodes in this node pool will be monitored and, if 646 # they fail health checks too many times, an automatic repair action will be 647 # triggered. 648 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 649 # the Auto Upgrades will proceed. 650 "description": "A String", # [Output only] This field is set when upgrades are about to commence 651 # with the description of the upgrade. 652 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 653 # with the approximate start time for the upgrades, in 654 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 655 }, 656 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 657 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 658 # up to date with the latest release version of Kubernetes. 659 }, 660 } 661 662 x__xgafv: string, V1 error format. 663 Allowed values 664 1 - v1 error format 665 2 - v2 error format 666 667Returns: 668 An object of the form: 669 670 { # This operation resource represents operations that may have happened or are 671 # happening on the cluster. All fields are output only. 672 "status": "A String", # The current status of the operation. 673 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 674 "name": "A String", # The server-assigned ID for the operation. 675 "zone": "A String", # The name of the Google Compute Engine 676 # [zone](/compute/docs/zones#available) in which the operation 677 # is taking place. 678 "detail": "A String", # Detailed operation progress, if available. 679 "targetLink": "A String", # Server-defined URL for the target of the operation. 680 "operationType": "A String", # The operation type. 681 "selfLink": "A String", # Server-defined URL for the resource. 682 }</pre> 683</div> 684 685</body></html>