Package Classes (2.55.0)

Summary of entries of Classes for container.

Classes

ClusterManagerAsyncClient

Google Kubernetes Engine Cluster Manager v1

ClusterManagerClient

Google Kubernetes Engine Cluster Manager v1

ListUsableSubnetworksAsyncPager

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial ListUsableSubnetworksResponse object, and provides an __aiter__ method to iterate through its subnetworks field.

If there are more pages, the __aiter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableSubnetworksPager

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial ListUsableSubnetworksResponse object, and provides an __iter__ method to iterate through its subnetworks field.

If there are more pages, the __iter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalNodeNetworkConfig

AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message

AdditionalPodNetworkConfig

AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalPodRangesConfig

AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.

AddonsConfig

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

AdvancedDatapathObservabilityConfig

AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

AutoUpgradeOptions

AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.

Autopilot

Autopilot is the configuration for Autopilot settings on the cluster.

AutopilotCompatibilityIssue

AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BlueGreenSettings

Settings for blue-green upgrade.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StandardRolloutPolicy

Standard rollout policy is the default policy for blue-green.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CancelOperationRequest

CancelOperationRequest cancels a single operation.

CheckAutopilotCompatibilityRequest

CheckAutopilotCompatibilityRequest requests getting the blockers for the given operation in the cluster.

CheckAutopilotCompatibilityResponse

CheckAutopilotCompatibilityResponse has a list of compatibility issues.

ClientCertificateConfig

Configuration for client certificates on the cluster.

CloudRunConfig

Configuration options for the Cloud Run feature.

LoadBalancerType

Load balancer type of ingress service of Cloud Run.

Cluster

A Google Kubernetes Engine cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceLabelsEntry

The abstract base class for a message.

Status

The current status of the cluster.

ClusterAutoscaling

ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.

AutoscalingProfile

Defines possible options for autoscaling_profile field.

ClusterUpdate

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

CompleteNodePoolUpgradeRequest

CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.

CompliancePostureConfig

CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ComplianceStandard

Defines the details of a compliance standard.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Mode

Mode defines enablement mode for Compliance Posture.

ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.

ConfigConnectorConfig

Configuration options for the Config Connector add-on.

ContainerdConfig

ContainerdConfig contains configuration to customize containerd.

PrivateRegistryAccessConfig

PrivateRegistryAccessConfig contains access configuration for private container registries.

CertificateAuthorityDomainConfig

CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GCPSecretManagerCertificateConfig

GCPSecretManagerCertificateConfig configures a secret from Google Secret Manager <https://cloud.google.com/secret-manager>__.

ControlPlaneEndpointsConfig

Configuration for all of the cluster's control plane endpoints.

DNSEndpointConfig

Describes the configuration of a DNS endpoint.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IPEndpointsConfig

IP endpoints configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CostManagementConfig

Configuration for fine-grained cost management feature.

CreateClusterRequest

CreateClusterRequest creates a cluster.

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster.

DNSConfig

DNSConfig contains the desired set of options for configuring clusterDNS.

DNSScope

DNSScope lists the various scopes of access to cluster DNS records.

Provider

Provider lists the various in-cluster DNS providers.

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

DatabaseEncryption

Configuration of etcd encryption.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CurrentState

Current State of etcd encryption.

OperationError

OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.

State

State of etcd encryption.

DatapathProvider

The datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy enforcement.

DefaultSnatStatus

DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.

DeleteClusterRequest

DeleteClusterRequest deletes a cluster.

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster.

DesiredEnterpriseConfig

DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.

DnsCacheConfig

Configuration for NodeLocal DNSCache

EnterpriseConfig

EnterpriseConfig is the cluster enterprise configuration.

ClusterTier

Premium tiers for GKE Cluster.

EphemeralStorageLocalSsdConfig

EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.

FastSocket

Configuration of Fast Socket feature.

Fleet

Fleet is the fleet configuration for the cluster.

GPUDriverInstallationConfig

GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GPUDriverVersion

The GPU driver version to install.

GPUSharingConfig

GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GPUSharingStrategy

The type of GPU sharing strategy currently provided.

GatewayAPIConfig

GatewayAPIConfig contains the desired config of Gateway API on this cluster.

Channel

Channel describes if/how Gateway API should be installed and implemented in a cluster.

GcePersistentDiskCsiDriverConfig

Configuration for the Compute Engine PD CSI driver.

GcfsConfig

GcfsConfig contains configurations of Google Container File System (image streaming).

GcpFilestoreCsiDriverConfig

Configuration for the GCP Filestore CSI driver.

GcsFuseCsiDriverConfig

Configuration for the Cloud Storage Fuse CSI driver.

GetClusterRequest

GetClusterRequest gets the settings of a cluster.

GetJSONWebKeysRequest

GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.

GetJSONWebKeysResponse

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster.

GetOpenIDConfigRequest

GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOpenIDConfigResponse

GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOperationRequest

GetOperationRequest gets a single operation.

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration.

GkeBackupAgentConfig

Configuration for the Backup for GKE Agent.

HorizontalPodAutoscaling

Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

HttpLoadBalancing

Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster.

IPv6AccessType

Possible values for IPv6 access type

IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API

InTransitEncryptionConfig

Options for in-transit encryption.

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.

Jwk

Jwk is a JSON Web Key as specified in RFC 7517

K8sBetaAPIConfig

K8sBetaAPIConfig , configuration for beta APIs

KubernetesDashboard

Configuration for the Kubernetes Dashboard.

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode.

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CgroupMode

Possible cgroup modes that can be used.

HugepagesConfig

Hugepages amount in both 2m and 1g size

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SysctlsEntry

The abstract base class for a message.

ListClustersRequest

ListClustersRequest lists clusters.

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest.

ListNodePoolsRequest

ListNodePoolsRequest lists the node pool(s) for a cluster.

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest.

ListOperationsRequest

ListOperationsRequest lists operations.

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest.

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

LocalNvmeSsdBlockConfig

LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs

LoggingComponentConfig

LoggingComponentConfig is cluster logging component configuration.

Component

GKE components exposing logs

LoggingConfig

LoggingConfig is cluster logging configuration.

LoggingVariantConfig

LoggingVariantConfig specifies the behaviour of the logging component.

Variant

Logging component variants.

MaintenanceExclusionOptions

Represents the Maintenance exclusion option.

Scope

Scope of exclusion.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MaintenanceExclusionsEntry

The abstract base class for a message.

ManagedPrometheusConfig

ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.

MasterAuth

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

MasterAuthorizedNetworksConfig

Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CidrBlock

CidrBlock contains an optional name and one CIDR block.

MaxPodsConstraint

Constraints applied to pods.

MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

MonitoringComponentConfig

MonitoringComponentConfig is cluster monitoring component configuration.

Component

GKE components exposing metrics

MonitoringConfig

MonitoringConfig is cluster monitoring configuration.

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ClusterNetworkPerformanceConfig

Configuration of network bandwidth tiers

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Tier

Node network tier

NetworkPolicy

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Provider

Allowed Network Policy providers.

NetworkPolicyConfig

Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.

NodeConfig

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults][google.container.v1.AutoprovisioningNodePoolDefaults] instead.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EffectiveCgroupMode

Possible effective cgroup modes for the node.

LabelsEntry

The abstract base class for a message.

LocalSsdEncryptionMode

LocalSsdEncryptionMode specifies the method used for encrypting the Local SSDs attached to the node.

MetadataEntry

The abstract base class for a message.

ResourceLabelsEntry

The abstract base class for a message.

NodeConfigDefaults

Subset of NodeConfig message that has defaults.

NodeKubeletConfig

Node kubelet configs.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodeLabels

Collection of node-level Kubernetes labels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels>__.

LabelsEntry

The abstract base class for a message.

NodeManagement

NodeManagement defines the set of node management services turned on for the node pool.

NodeNetworkConfig

Parameters for node pool-level network config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NetworkPerformanceConfig

Configuration of all network bandwidth tiers

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Tier

Node network tier

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.

PlacementPolicy

PlacementPolicy defines the placement policy used by the node pool.

Type

Type defines the type of placement policy.

QueuedProvisioning

QueuedProvisioning defines the queued provisioning used by the node pool.

Status

The current status of the node pool instance.

UpdateInfo

UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.

BlueGreenInfo

Information relevant to blue-green upgrade.

Phase

Phase represents the different stages blue-green upgrade is running in.

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 ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade.

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 controls the number of nodes that can be simultaneously unavailable.
(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.

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.
node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

LocationPolicy

Location policy specifies how zones are picked when scaling up the nodepool.

NodePoolDefaults

Subset of Nodepool message that has defaults.

NodePoolLoggingConfig

NodePoolLoggingConfig specifies logging configuration for nodepools.

NodePoolUpdateStrategy

Strategy used for node pool update.

NodeTaint

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

Possible values for Effect in taint.

NodeTaints

Collection of Kubernetes node taints <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__.

NotificationConfig

NotificationConfig is the configuration of notifications.

EventType

Types of notifications currently supported. Can be used to filter what notifications are sent.

Filter

Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent

PubSub

Pub/Sub specific notification config.

Operation

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Status

Current status of the operation.

Type

Operation type categorizes the operation.

    In the event of the operation failing, the cluster will
    enter the `ERROR state][Cluster.Status.ERROR]` and eventually
    be deleted.
DELETE_CLUSTER (2):
    The cluster is being deleted. The cluster should be assumed
    to be unusable as soon as this operation starts.

    In the event of the operation failing, the cluster will
    enter the `ERROR state][Cluster.Status.ERROR]` and the
    deletion will be automatically retried until completed.
UPGRADE_MASTER (3):
    The [cluster
    version][google.container.v1.ClusterUpdate.desired_master_version]
    is being updated. Note that this includes "upgrades" to the
    same version, which are simply a recreation. This also
    includes
    `auto-upgrades <https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically>`__.
    For more details, see `documentation on cluster
    upgrades <https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades>`__.
UPGRADE_NODES (4):
    A node pool is being updated. Despite calling this an
    "upgrade", this includes most forms of updates to node
    pools. This also includes
    `auto-upgrades <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades>`__.

    This operation sets the
    `progress][google.container.v1.Operation.progress]` field and
    may be
    `canceled][google.container.v1.ClusterManager.CancelOperation]`.

    The upgrade strategy depends on `node pool
    configuration <https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies>`__.
    The nodes are generally still usable during this operation.
REPAIR_CLUSTER (5):
    A problem has been detected with the control plane and is
    being repaired. This operation type is initiated by GKE. For
    more details, see `documentation on
    repairs <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs>`__.
UPDATE_CLUSTER (6):
    The cluster is being updated. This is a broad category of
    operations and includes operations that only change metadata
    as well as those that must recreate the entire cluster. If
    the control plane must be recreated, this will cause
    temporary downtime for zonal clusters.

    Some features require recreating the nodes as well. Those
    will be recreated as separate operations and the update may
    not be completely functional until the node pools
    recreations finish. Node recreations will generally follow
    `maintenance
    policies <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions>`__.

    Some GKE-initiated operations use this type. This includes
    certain types of auto-upgrades and incident mitigations.
CREATE_NODE_POOL (7):
    A node pool is being created. The node pool should be
    assumed to be unusable until this operation finishes. In the
    event of an error, the node pool may be partially created.

    If enabled, `node
    autoprovisioning <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning>`__
    may have automatically initiated such operations.
DELETE_NODE_POOL (8):
    The node pool is being deleted. The node pool
    should be assumed to be unusable as soon as this
    operation starts.
SET_NODE_POOL_MANAGEMENT (9):
    The node pool's
    `manamagent][google.container.v1.NodePool.management]` field
    is being updated. These operations only update metadata and
    may be concurrent with most other operations.
AUTO_REPAIR_NODES (10):
    A problem has been detected with nodes and `they are being
    repaired <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair>`__.
    This operation type is initiated by GKE, typically
    automatically. This operation may be concurrent with other
    operations and there may be multiple repairs occurring on
    the same node pool.
AUTO_UPGRADE_NODES (11):
    Unused. Automatic node upgrade uses
    `UPGRADE_NODES][google.container.v1.Operation.Type.UPGRADE_NODES]`.
SET_LABELS (12):
    Unused. Updating labels uses
    `UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER]`.
SET_MASTER_AUTH (13):
    Unused. Updating master auth uses
    `UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER]`.
SET_NODE_POOL_SIZE (14):
    The node pool is being resized. With the
    exception of resizing to or from size zero, the
    node pool is generally usable during this
    operation.
SET_NETWORK_POLICY (15):
    Unused. Updating network policy uses
    `UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER]`.
SET_MAINTENANCE_POLICY (16):
    Unused. Updating maintenance policy uses
    `UPDATE_CLUSTER][google.container.v1.Operation.Type.UPDATE_CLUSTER]`.
RESIZE_CLUSTER (18):
    The control plane is being resized. This operation type is
    initiated by GKE. These operations are often performed
    preemptively to ensure that the control plane has sufficient
    resources and is not typically an indication of issues. For
    more details, see `documentation on
    resizes <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs>`__.
FLEET_FEATURE_UPGRADE (19):
    Fleet features of GKE Enterprise are being
    upgraded. The cluster should be assumed to be
    blocked for other upgrades until the operation
    finishes.

OperationProgress

Information about operation (or operation stage) progress.

Metric

Progress metric is (string, int|float|string) pair.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ParallelstoreCsiDriverConfig

Configuration for the Cloud Storage Parallelstore CSI driver.

PodCIDROverprovisionConfig

[PRIVATE FIELD] Config for pod CIDR size overprovisioning.

PrivateClusterConfig

Configuration options for private clusters.

PrivateClusterMasterGlobalAccessConfig

Configuration for controlling master global access settings.

PrivateIPv6GoogleAccess

PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.

RBACBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RangeInfo

RangeInfo contains the range name and the range utilization by this cluster.

RayClusterLoggingConfig

RayClusterLoggingConfig specifies configuration of Ray logging.

RayClusterMonitoringConfig

RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.

RayOperatorConfig

Configuration options for the Ray Operator add-on.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

ReleaseChannel

ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk.

When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.

Channel

Possible values for 'channel'.

    WARNING: Versions available in the RAPID Channel
    may be subject to unresolved issues with no
    known workaround and are not subject to any
    SLAs.
REGULAR (2):
    Clusters subscribed to REGULAR receive
    versions that are considered GA quality. REGULAR
    is intended for production users who want to
    take advantage of new features.
STABLE (3):
    Clusters subscribed to STABLE receive
    versions that are known to be stable and
    reliable in production.
EXTENDED (4):
    Clusters subscribed to EXTENDED receive
    extended support and availability for versions
    which are known to be stable and reliable in
    production.

ReservationAffinity

ReservationAffinity <https://cloud.google.com/compute/docs/instances/reserving-zonal-resources>__ is the configuration of desired reservation which instances could take capacity from.

Type

Indicates whether to consume capacity from a reservation or not.

ResourceLabels

Collection of GCP labels <https://cloud.google.com/resource-manager/docs/creating-managing-labels>__.

LabelsEntry

The abstract base class for a message.

ResourceLimit

Contains information about amount of some resource in the cluster. For memory, value should be in GB.

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.

TagsEntry

The abstract base class for a message.

ResourceUsageExportConfig

Configuration for exporting cluster resource usages.

BigQueryDestination

Parameters for using BigQuery as the destination of resource usage export.

ConsumptionMeteringConfig

Parameters for controlling consumption metering.

RollbackNodePoolUpgradeRequest

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

SandboxConfig

SandboxConfig contains configurations of the sandbox to use for the node.

Type

Possible types of sandboxes.

SecondaryBootDisk

SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.

Mode

Mode specifies how the secondary boot disk will be used. This triggers mode-specified logic in the control plane.

SecondaryBootDiskUpdateStrategy

SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.

SecretManagerConfig

SecretManagerConfig is config for secret manager enablement.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SecurityBulletinEvent

SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.

SecurityPostureConfig

SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Mode

Mode defines enablement mode for GKE Security posture features.

VulnerabilityMode

VulnerabilityMode defines enablement mode for vulnerability scanning.

ServerConfig

Kubernetes Engine service configuration.

ReleaseChannelConfig

ReleaseChannelConfig exposes configuration for a release channel.

ServiceExternalIPsConfig

Config to block services with externalIPs field.

SetAddonsConfigRequest

SetAddonsConfigRequest sets the addons associated with the cluster.

SetLabelsRequest

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

ResourceLabelsEntry

The abstract base class for a message.

SetLegacyAbacRequest

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster.

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of a cluster.

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster.

Action

Operation type: what type update to perform.

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of a cluster.

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for a cluster.

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node management properties of a node pool.

SetNodePoolSizeRequest

SetNodePoolSizeRequest sets the size of a node pool.

ShieldedInstanceConfig

A set of Shielded Instance options.

ShieldedNodes

Configuration of Shielded Nodes feature.

SoleTenantConfig

SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.

NodeAffinity

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>__.

Operator

Operator allows user to specify affinity or anti-affinity for the given key values.

StackType

Possible values for IP stack type

StartIPRotationRequest

StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

StatefulHAConfig

Configuration for the Stateful HA add-on.

StatusCondition

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Code

Code for each condition

TimeWindow

Represents an arbitrary window of time.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateClusterRequest

UpdateClusterRequest updates the settings of a cluster.

UpdateMasterRequest

UpdateMasterRequest updates the master of the cluster.

UpdateNodePoolRequest

UpdateNodePoolRequests update a node pool's image and/or version.

UpgradeAvailableEvent

UpgradeAvailableEvent is a notification sent to customers when a new available version is released.

UpgradeEvent

UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.

UpgradeInfoEvent

UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.

State

The state of the upgrade.

UpgradeResourceType

UpgradeResourceType is the resource type that is upgrading. It is used in upgrade notifications.

UsableSubnetwork

UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.

Status

Status shows the current usage of a secondary IP range.

UserManagedKeysConfig

UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.

VerticalPodAutoscaling

VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.

VirtualNIC

Configuration of gVNIC feature.

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

OSVersion

Possible OS version that can be used.

WorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

WorkloadMetadataConfig

WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.

Mode

Mode is the configuration for how to expose metadata to workloads running on the node.

WorkloadPolicyConfig

WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ClusterManagerAsyncClient

Google Kubernetes Engine Cluster Manager v1beta1

ClusterManagerClient

Google Kubernetes Engine Cluster Manager v1beta1

ListUsableSubnetworksAsyncPager

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial ListUsableSubnetworksResponse object, and provides an __aiter__ method to iterate through its subnetworks field.

If there are more pages, the __aiter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableSubnetworksPager

A pager for iterating through list_usable_subnetworks requests.

This class thinly wraps an initial ListUsableSubnetworksResponse object, and provides an __iter__ method to iterate through its subnetworks field.

If there are more pages, the __iter__ method will make additional ListUsableSubnetworks requests and continue to iterate through the subnetworks field on the corresponding responses.

All the usual ListUsableSubnetworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalNodeNetworkConfig

AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message

AdditionalPodNetworkConfig

AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalPodRangesConfig

AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.

AddonsConfig

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

AdvancedDatapathObservabilityConfig

AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RelayMode

Supported Relay modes

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

AutoUpgradeOptions

AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.

Autopilot

Autopilot is the configuration for Autopilot settings on the cluster.

AutopilotCompatibilityIssue

AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.

IssueType

The type of the reported issue.

AutopilotConversionStatus

AutopilotConversionStatus represents conversion status.

State

The current state of the conversion.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BestEffortProvisioning

Best effort provisioning.

BinaryAuthorization

Configuration for Binary Authorization.

EvaluationMode

Binary Authorization mode of operation.

PolicyBinding

Binauthz policy that applies to this cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BlueGreenSettings

Settings for blue-green upgrade.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutoscaledRolloutPolicy

Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools.

StandardRolloutPolicy

Standard rollout policy is the default policy for blue-green.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CancelOperationRequest

CancelOperationRequest cancels a single operation.

CheckAutopilotCompatibilityRequest

CheckAutopilotCompatibilityRequest requests getting the blockers for the given operation in the cluster.

CheckAutopilotCompatibilityResponse

CheckAutopilotCompatibilityResponse has a list of compatibility issues.

ClientCertificateConfig

Configuration for client certificates on the cluster.

CloudRunConfig

Configuration options for the Cloud Run feature.

LoadBalancerType

Load balancer type of ingress service of Cloud Run.

Cluster

A Google Kubernetes Engine cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ResourceLabelsEntry

The abstract base class for a message.

Status

The current status of the cluster.

ClusterAutoscaling

ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.

AutoscalingProfile

Defines possible options for autoscaling_profile field.

ClusterTelemetry

Telemetry integration for the cluster.

Type

Type of the integration.

ClusterUpdate

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

CompleteNodePoolUpgradeRequest

CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.

CompliancePostureConfig

CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ComplianceStandard

Defines the details of a compliance standard.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Mode

Mode defines enablement mode for Compliance Posture.

ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.

ConfigConnectorConfig

Configuration options for the Config Connector add-on.

ContainerdConfig

ContainerdConfig contains configuration to customize containerd.

PrivateRegistryAccessConfig

PrivateRegistryAccessConfig contains access configuration for private container registries.

CertificateAuthorityDomainConfig

CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GCPSecretManagerCertificateConfig

GCPSecretManagerCertificateConfig configures a secret from Google Secret Manager <https://cloud.google.com/secret-manager>__.

CostManagementConfig

Configuration for fine-grained cost management feature.

CreateClusterRequest

CreateClusterRequest creates a cluster.

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster.

DNSConfig

DNSConfig contains the desired set of options for configuring clusterDNS.

DNSScope

DNSScope lists the various scopes of access to cluster DNS records.

Provider

Provider lists the various in-cluster DNS providers.

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

DatabaseEncryption

Configuration of etcd encryption.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CurrentState

Current State of etcd encryption.

OperationError

OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.

State

State of etcd encryption.

DatapathProvider

The datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy enforcement.

DefaultSnatStatus

DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.

DeleteClusterRequest

DeleteClusterRequest deletes a cluster.

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster.

DnsCacheConfig

Configuration for NodeLocal DNSCache

EnterpriseConfig

EnterpriseConfig is the cluster enterprise configuration.

ClusterTier

Premium tiers for GKE Cluster.

EphemeralStorageConfig

EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.

EphemeralStorageLocalSsdConfig

EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.

FastSocket

Configuration of Fast Socket feature.

Fleet

Fleet is the fleet configuration for the cluster.

GPUDriverInstallationConfig

GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GPUDriverVersion

The GPU driver version to install.

GPUSharingConfig

GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GPUSharingStrategy

The type of GPU sharing strategy currently provided.

GatewayAPIConfig

GatewayAPIConfig contains the desired config of Gateway API on this cluster.

Channel

Channel describes if/how Gateway API should be installed and implemented in a cluster.

GcePersistentDiskCsiDriverConfig

Configuration for the Compute Engine PD CSI driver.

GcfsConfig

GcfsConfig contains configurations of Google Container File System.

GcpFilestoreCsiDriverConfig

Configuration for the GCP Filestore CSI driver.

GcsFuseCsiDriverConfig

Configuration for the Cloud Storage Fuse CSI driver.

GetClusterRequest

GetClusterRequest gets the settings of a cluster.

GetJSONWebKeysRequest

GetJSONWebKeysResponse

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster.

GetOpenIDConfigRequest

GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOpenIDConfigResponse

GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GetOperationRequest

GetOperationRequest gets a single operation.

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration.

GkeBackupAgentConfig

Configuration for the Backup for GKE Agent.

HorizontalPodAutoscaling

HostMaintenancePolicy

HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MaintenanceInterval

Allows selecting how infrastructure upgrades should be applied to the cluster or node pool.

OpportunisticMaintenanceStrategy

Strategy that will trigger maintenance on behalf of the customer.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HttpLoadBalancing

Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster.

IPv6AccessType

IPv6 access type

StackType

Possible values for IP stack type

IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API

InTransitEncryptionConfig

Options for in-transit encryption.

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.

IstioConfig

Configuration options for Istio addon.

IstioAuthMode

Istio auth mode, https://istio.io/docs/concepts/security/mutual-tls.html

Jwk

Jwk is a JSON Web Key as specified in RFC 7517

K8sBetaAPIConfig

Kubernetes open source beta apis enabled on the cluster.

KalmConfig

Configuration options for the KALM addon.

KubernetesDashboard

Configuration for the Kubernetes Dashboard.

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode.

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CgroupMode

Possible cgroup modes that can be used.

HugepagesConfig

Hugepages amount in both 2m and 1g size

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SysctlsEntry

The abstract base class for a message.

ListClustersRequest

ListClustersRequest lists clusters.

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest.

ListLocationsRequest

ListLocationsRequest is used to request the locations that offer GKE.

ListLocationsResponse

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

ListNodePoolsRequest

ListNodePoolsRequest lists the node pool(s) for a cluster.

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest.

ListOperationsRequest

ListOperationsRequest lists operations.

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest.

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters.

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

LocalNvmeSsdBlockConfig

LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs

Location

Location returns the location name, and if the location is recommended for GKE cluster scheduling.

LocationType

LocationType is the type of GKE location, regional or zonal.

LoggingComponentConfig

LoggingComponentConfig is cluster logging component configuration.

Component

GKE components exposing logs

LoggingConfig

LoggingConfig is cluster logging configuration.

LoggingVariantConfig

LoggingVariantConfig specifies the behaviour of the logging component.

Variant

Logging component variants.

MaintenanceExclusionOptions

Represents the Maintenance exclusion option.

Scope

Scope of exclusion.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MaintenanceExclusionsEntry

The abstract base class for a message.

ManagedPrometheusConfig

ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.

Master

Master is the configuration for components on master.

MasterAuth

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

MasterAuthorizedNetworksConfig

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CidrBlock

CidrBlock contains an optional name and one CIDR block.

MaxPodsConstraint

Constraints applied to pods.

MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

MonitoringComponentConfig

MonitoringComponentConfig is cluster monitoring component configuration.

Component

GKE components exposing metrics

MonitoringConfig

MonitoringConfig is cluster monitoring configuration.

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ClusterNetworkPerformanceConfig

Configuration of all network bandwidth tiers

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Tier

Node network tier

NetworkPolicy

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Provider

Allowed Network Policy providers.

NetworkPolicyConfig

Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

NetworkTags

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>`__).

NodeConfig

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults][google.container.v1beta1.AutoprovisioningNodePoolDefaults] instead.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

MetadataEntry

The abstract base class for a message.

ResourceLabelsEntry

The abstract base class for a message.

NodeConfigDefaults

Subset of NodeConfig message that has defaults.

NodeKubeletConfig

Node kubelet configs.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodeLabels

Collection of node-level Kubernetes labels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels>__.

LabelsEntry

The abstract base class for a message.

NodeManagement

NodeManagement defines the set of node management services turned on for the node pool.

NodeNetworkConfig

Parameters for node pool-level network config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NetworkPerformanceConfig

Configuration of all network bandwidth tiers

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Tier

Node network tier

NodePool

PlacementPolicy

PlacementPolicy defines the placement policy used by the node pool.

Type

Type defines the type of placement policy.

QueuedProvisioning

QueuedProvisioning defines the queued provisioning used by the node pool.

Status

The current status of the node pool instance.

UpdateInfo

UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.

BlueGreenInfo

Information relevant to blue-green upgrade.

Phase

Phase represents the different stages blue-green upgrade is running in.

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).

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.

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 controls the number of nodes that can be simultaneously unavailable.
(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.

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.
node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodePoolAutoConfig

node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters

NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

LocationPolicy

Location policy specifies how zones are picked when scaling up the nodepool.

NodePoolDefaults

Subset of Nodepool message that has defaults.

NodePoolLoggingConfig

NodePoolLoggingConfig specifies logging configuration for nodepools.

NodePoolUpdateStrategy

Strategy used for node pool update.

NodeTaint

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

Possible values for Effect in taint.

NodeTaints

Collection of Kubernetes node taints <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__.

NotificationConfig

NotificationConfig is the configuration of notifications.

EventType

Types of notifications currently supported. Can be used to filter what notifications are sent.

Filter

PubSub

Pub/Sub specific notification config.

Operation

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Status

Current status of the operation.

Type

Operation type categorizes the operation.

    In the event of the operation failing, the cluster will
    enter the `ERROR state][Cluster.Status.ERROR]` and eventually
    be deleted.
DELETE_CLUSTER (2):
    The cluster is being deleted. The cluster should be assumed
    to be unusable as soon as this operation starts.

    In the event of the operation failing, the cluster will
    enter the `ERROR state][Cluster.Status.ERROR]` and the
    deletion will be automatically retried until completed.
UPGRADE_MASTER (3):
    The [cluster
    version][google.container.v1beta1.ClusterUpdate.desired_master_version]
    is being updated. Note that this includes "upgrades" to the
    same version, which are simply a recreation. This also
    includes
    `auto-upgrades <https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically>`__.
    For more details, see `documentation on cluster
    upgrades <https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades>`__.
UPGRADE_NODES (4):
    A node pool is being updated. Despite calling this an
    "upgrade", this includes most forms of updates to node
    pools. This also includes
    `auto-upgrades <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades>`__.

    This operation sets the
    `progress][google.container.v1beta1.Operation.progress]`
    field and may be
    `canceled][google.container.v1beta1.ClusterManager.CancelOperation]`.

    The upgrade strategy depends on `node pool
    configuration <https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies>`__.
    The nodes are generally still usable during this operation.
REPAIR_CLUSTER (5):
    A problem has been detected with the control plane and is
    being repaired. This operation type is initiated by GKE. For
    more details, see `documentation on
    repairs <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs>`__.
UPDATE_CLUSTER (6):
    The cluster is being updated. This is a broad category of
    operations and includes operations that only change metadata
    as well as those that must recreate the entire cluster. If
    the control plane must be recreated, this will cause
    temporary downtime for zonal clusters.

    Some features require recreating the nodes as well. Those
    will be recreated as separate operations and the update may
    not be completely functional until the node pools
    recreations finish. Node recreations will generally follow
    `maintenance
    policies <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions>`__.

    Some GKE-initiated operations use this type. This includes
    certain types of auto-upgrades and incident mitigations.
CREATE_NODE_POOL (7):
    A node pool is being created. The node pool should be
    assumed to be unusable until this operation finishes. In the
    event of an error, the node pool may be partially created.

    If enabled, `node
    autoprovisioning <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning>`__
    may have automatically initiated such operations.
DELETE_NODE_POOL (8):
    The node pool is being deleted. The node pool
    should be assumed to be unusable as soon as this
    operation starts.
SET_NODE_POOL_MANAGEMENT (9):
    The node pool's
    `manamagent][google.container.v1beta1.NodePool.management]`
    field is being updated. These operations only update
    metadata and may be concurrent with most other operations.
AUTO_REPAIR_NODES (10):
    A problem has been detected with nodes and `they are being
    repaired <https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair>`__.
    This operation type is initiated by GKE, typically
    automatically. This operation may be concurrent with other
    operations and there may be multiple repairs occurring on
    the same node pool.
AUTO_UPGRADE_NODES (11):
    Unused. Automatic node upgrade uses
    `UPGRADE_NODES][google.container.v1beta1.Operation.Type.UPGRADE_NODES]`.
SET_LABELS (12):
    Unused. Updating labels uses
    `UPDATE_CLUSTER][google.container.v1beta1.Operation.Type.UPDATE_CLUSTER]`.
SET_MASTER_AUTH (13):
    Unused. Updating master auth uses
    `UPDATE_CLUSTER][google.container.v1beta1.Operation.Type.UPDATE_CLUSTER]`.
SET_NODE_POOL_SIZE (14):
    The node pool is being resized. With the
    exception of resizing to or from size zero, the
    node pool is generally usable during this
    operation.
SET_NETWORK_POLICY (15):
    Unused. Updating network policy uses
    `UPDATE_CLUSTER][google.container.v1beta1.Operation.Type.UPDATE_CLUSTER]`.
SET_MAINTENANCE_POLICY (16):
    Unused. Updating maintenance policy uses
    `UPDATE_CLUSTER][google.container.v1beta1.Operation.Type.UPDATE_CLUSTER]`.
RESIZE_CLUSTER (18):
    The control plane is being resized. This operation type is
    initiated by GKE. These operations are often performed
    preemptively to ensure that the control plane has sufficient
    resources and is not typically an indication of issues. For
    more details, see `documentation on
    resizes <https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs>`__.
FLEET_FEATURE_UPGRADE (19):
    Fleet features of GKE Enterprise are being
    upgraded. The cluster should be assumed to be
    blocked for other upgrades until the operation
    finishes.

OperationProgress

Information about operation (or operation stage) progress.

Metric

Progress metric is (string, int|float|string) pair.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PodCIDROverprovisionConfig

[PRIVATE FIELD] Config for pod CIDR size overprovisioning.

PodSecurityPolicyConfig

Configuration for the PodSecurityPolicy feature.

PrivateClusterConfig

Configuration options for private clusters.

PrivateClusterMasterGlobalAccessConfig

Configuration for controlling master global access settings.

PrivateIPv6GoogleAccess

PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.

ProtectConfig

ProtectConfig defines the flags needed to enable/disable features for the Protect API.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

WorkloadVulnerabilityMode

WorkloadVulnerabilityMode defines mode to perform vulnerability scanning.

RangeInfo

RangeInfo contains the range name and the range utilization by this cluster.

RayClusterLoggingConfig

RayClusterLoggingConfig specifies logging configuration for Ray clusters.

RayClusterMonitoringConfig

RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.

RayOperatorConfig

Configuration options for the Ray Operator add-on.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

ReleaseChannel

ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk.

When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.

Channel

Possible values for 'channel'.

    WARNING: Versions available in the RAPID Channel
    may be subject to unresolved issues with no
    known workaround and are not subject to any
    SLAs.
REGULAR (2):
    Clusters subscribed to REGULAR receive
    versions that are considered GA quality. REGULAR
    is intended for production users who want to
    take advantage of new features.
STABLE (3):
    Clusters subscribed to STABLE receive
    versions that are known to be stable and
    reliable in production.
EXTENDED (4):
    Clusters subscribed to EXTENDED receive
    extended support and availability for versions
    which are known to be stable and reliable in
    production.

    Metadata concealment is a temporary security
    solution available while the bootstrapping
    process for cluster nodes is being redesigned
    with significant security improvements.  This
    feature is scheduled to be deprecated in the
    future and later removed.
EXPOSE (2):
    Expose all VM metadata to pods.
GKE_METADATA_SERVER (3):
    Run the GKE Metadata Server on this node. The
    GKE Metadata Server exposes a metadata API to
    workloads that is compatible with the V1 Compute
    Metadata APIs exposed by the Compute Engine and
    App Engine Metadata Servers. This feature can
    only be enabled if Workload Identity is enabled
    at the cluster level.

WorkloadPolicyConfig

WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Modules

pagers

API documentation for container_v1.services.cluster_manager.pagers module.

pagers

API documentation for container_v1beta1.services.cluster_manager.pagers module.