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