Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Method Details

autoscaling(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)

Sets the autoscaling settings of a specific node pool.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
  "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool.
    "autoprovisioned": True or False, # Can this node pool be deleted automatically.
    "enabled": True or False, # Is autoscaling enabled for this node pool.
    "locationPolicy": "A String", # Location policy used when scaling up a nodepool.
    "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
    "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
    "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
    "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
  },
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

close()

Close httplib2 connections.

create(projectId, zone, clusterId, body=None, x__xgafv=None)

Creates a node pool for a cluster.

{ # CreateNodePoolRequest creates a node pool for a cluster.
"clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
"nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
"minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
"totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
"totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
"minProvisionNodes": 42, # Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
},
"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
},
"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
"a_key": "A String",
},
"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
"values": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
"A String",
],
"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
},
"parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.
"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"detail": "A String", # Output only. Detailed operation progress, if available.
"endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"operationType": "A String", # Output only. The operation type.
"progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
"intValue": "A String", # For metrics with integer value.
"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
},
],
"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
"stages": [ # Substages of an operation or a stage.
# Object with schema name: OperationProgress
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
"selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
"startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
"targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
"zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)

Deletes a node pool from a cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
  nodePoolId: string, Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
  name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

Fetch upgrade information of a specific nodepool.

Args:
  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
  version: string, API request version that initiates this operation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # NodePoolUpgradeInfo contains the upgrade information of a nodepool.
  "autoUpgradeStatus": [ # The auto upgrade status.
    "A String",
  ],
  "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp.
  "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp.
  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
  "pausedReason": [ # The auto upgrade paused reason.
    "A String",
  ],
  "upgradeDetails": [ # The list of past auto upgrades.
    { # UpgradeDetails contains detailed information of each individual upgrade operation.
      "endTime": "A String", # The end timestamp of the upgrade.
      "initialVersion": "A String", # The version before the upgrade.
      "startTime": "A String", # The start timestamp of the upgrade.
      "state": "A String", # Output only. The state of the upgrade.
      "targetVersion": "A String", # The version after the upgrade.
    },
  ],
}

get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)

Retrieves the requested node pool.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
nodePoolId: string, Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
"minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
"totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
"totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
"minProvisionNodes": 42, # Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
},
"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
},
"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
"a_key": "A String",
},
"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
"values": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
"A String",
],
"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
}

list(projectId, zone, clusterId, parent=None, x__xgafv=None)

Lists the node pools for a cluster.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest.
"nodePools": [ # A list of node pools for a cluster.
{ # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
"minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
"totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
"totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
"minProvisionNodes": 42, # Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
},
"bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
"diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
},
"labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
},
"localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
"a_key": "A String",
},
"minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
"values": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
"A String",
],
"taints": [ # List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
},
],
}

rollback(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
  nodePoolId: string, Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

setManagement(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)

Sets the NodeManagement options for a node pool.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
  nodePoolId: string, Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetNodePoolManagementRequest sets the node management properties of a node pool.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
  "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Required. NodeManagement configuration for the node pool.
    "autoRepair": True or False, # Whether the nodes will be automatically repaired.
    "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
    "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
      "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
      "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
    },
  },
  "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

setSize(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)

SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
  nodePoolId: string, Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetNodePoolSizeRequest sets the size of a node pool.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  "nodeCount": 42, # Required. The desired node count for the pool.
  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

update(projectId, zone, clusterId, nodePoolId, body=None, x__xgafv=None)

Updates the version and/or image type of a specific node pool.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
body: object, The request body.
The object takes the form of:

{ # SetNodePoolVersionRequest updates the version of a node pool.
"accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # The desired containerd config for nodes in the node pool. Initiates an upgrade operation that recreates the nodes with the new config.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": "A String", # Optional. The desired disk size for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.
"diskType": "A String", # Optional. The desired disk type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.
"etag": "A String", # The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS config.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
},
"labels": { # Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels). # The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be *replaced* with the provided labels.
"labels": { # Map of node label keys and node label values.
"a_key": "A String",
},
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
"A String",
],
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # Optional. The desired machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
"nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"resourceLabels": { # Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"labels": { # Map of node label keys and node label values.
"a_key": "A String",
},
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
"tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
"a_key": "A String",
},
},
"storagePools": [ # List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.
"A String",
],
"tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags.
"tags": [ # List of network tags.
"A String",
],
},
"taints": { # Collection of Kubernetes [node taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration). # The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be *replaced* with the provided taints.
"taints": [ # List of node taints.
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
},
"upgradeSettings": { # These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

Kubernetes Engine API . projects . zones . clusters . nodePools

Instance Methods

Method Details