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