API documentation for gke_multicloud_v1.types package.
Classes
AttachedCluster
An Anthos cluster running on customer own infrastructure.
AttachedClusterError
AttachedClusterError describes errors found on attached clusters.
AttachedClusterGroup
Identities of a group-type subject for Attached clusters.
AttachedClusterUser
Identities of a user-type subject for Attached clusters.
AttachedClustersAuthorization
Configuration related to the cluster RBAC settings.
AttachedOidcConfig
OIDC discovery information of the target cluster.
Kubernetes Service Account (KSA) tokens are JWT tokens signed by the cluster API server. This fields indicates how Google Cloud Platform services validate KSA tokens in order to allow system workloads (such as GKE Connect and telemetry agents) to authenticate back to Google Cloud Platform.
Both clusters with public and private issuer URLs are supported.
Clusters with public issuers only need to specify the issuer_url
field while clusters with private issuers need to provide both
issuer_url and oidc_jwks.
AttachedPlatformVersionInfo
Information about a supported Attached Clusters platform version.
AttachedProxyConfig
Details of a proxy config.
AttachedServerConfig
AttachedServerConfig provides information about supported Kubernetes versions
AwsAuthorization
Configuration related to the cluster RBAC settings.
AwsAutoscalingGroupMetricsCollection
Configuration related to CloudWatch metrics collection in an AWS Auto Scaling group.
AwsCluster
An Anthos cluster running on AWS.
AwsClusterError
AwsClusterError describes errors found on AWS clusters.
AwsClusterGroup
Identities of a group-type subject for AWS clusters.
AwsClusterNetworking
ClusterNetworking defines cluster-wide networking configuration. Anthos clusters on AWS run on a single VPC. This includes control plane replicas and node pool nodes.
AwsClusterUser
Identities of a user-type subject for AWS clusters.
AwsConfigEncryption
Config encryption for user data.
AwsControlPlane
ControlPlane defines common parameters between control plane nodes.
AwsDatabaseEncryption
Configuration related to application-layer secrets encryption.
AwsInstancePlacement
Details of placement information for an instance. Limitations for
using the host tenancy:
- T3 instances that use the unlimited CPU credit option don't support host tenancy.
AwsJsonWebKeys
AwsJsonWebKeys is a valid JSON Web Key Set as specififed in RFC 7517.
AwsK8sVersionInfo
Kubernetes version information of GKE cluster on AWS.
AwsNodeConfig
Parameters that describe the nodes in a cluster.
AwsNodeManagement
AwsNodeManagement defines the set of node management features turned on for an AWS node pool.
AwsNodePool
An Anthos node pool running on AWS.
AwsNodePoolAutoscaling
AwsNodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
AwsNodePoolError
AwsNodePoolError describes errors found on AWS node pools.
AwsOpenIdConfig
AwsOpenIdConfig is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
AwsProxyConfig
Details of a proxy config stored in AWS Secret Manager.
AwsServerConfig
AwsServerConfig is the configuration of GKE cluster on AWS.
AwsServicesAuthentication
Authentication configuration for the management of AWS resources.
AwsSshConfig
SSH configuration for AWS resources.
AwsVolumeTemplate
Configuration template for AWS EBS volumes.
AzureAuthorization
Configuration related to the cluster RBAC settings.
AzureClient
AzureClient resources hold client authentication information
needed by the Anthos Multi-Cloud API to manage Azure resources on
your Azure subscription.
When an AzureCluster
is created, an AzureClient resource needs to be provided and all
operations on Azure resources associated to that cluster will
authenticate to Azure services using the given client.
AzureClient resources are immutable and cannot be modified upon
creation.
Each AzureClient resource is bound to a single Azure Active
Directory Application and tenant.
AzureCluster
An Anthos cluster running on Azure.
AzureClusterError
AzureClusterError describes errors found on Azure clusters.
AzureClusterGroup
Identities of a group-type subject for Azure clusters.
AzureClusterNetworking
ClusterNetworking contains cluster-wide networking configuration.
AzureClusterResources
Managed Azure resources for the cluster.
The values could change and be empty, depending on the state of the cluster.
AzureClusterUser
Identities of a user-type subject for Azure clusters.
AzureConfigEncryption
Configuration related to config data encryption.
Azure VM bootstrap secret is envelope encrypted with the provided key vault key.
AzureControlPlane
AzureControlPlane represents the control plane configurations.
AzureDatabaseEncryption
Configuration related to application-layer secrets encryption. Anthos clusters on Azure encrypts your Kubernetes data at rest in etcd using Azure Key Vault.
AzureDiskTemplate
Configuration for Azure Disks.
AzureJsonWebKeys
AzureJsonWebKeys is a valid JSON Web Key Set as specififed in RFC 7517.
AzureK8sVersionInfo
Kubernetes version information of GKE cluster on Azure.
AzureNodeConfig
Parameters that describe the configuration of all node machines on a given node pool.
AzureNodeManagement
AzureNodeManagement defines the set of node management features turned on for an Azure node pool.
AzureNodePool
An Anthos node pool running on Azure.
AzureNodePoolAutoscaling
Configuration related to Kubernetes cluster autoscaler.
The Kubernetes cluster autoscaler will automatically adjust the size of the node pool based on the cluster load.
AzureNodePoolError
AzureNodePoolError describes errors found on Azure node pools.
AzureOpenIdConfig
AzureOpenIdConfig is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
AzureProxyConfig
Details of a proxy config stored in Azure Key Vault.
AzureServerConfig
AzureServerConfig contains information about a Google Cloud location, such as supported Azure regions and Kubernetes versions.
AzureServicesAuthentication
Authentication configuration for the management of Azure resources.
AzureSshConfig
SSH configuration for Azure resources.
BinaryAuthorization
Configuration for Binary Authorization.
CreateAttachedClusterRequest
Request message for AttachedClusters.CreateAttachedCluster
method.
CreateAwsClusterRequest
Request message for AwsClusters.CreateAwsCluster method.
CreateAwsNodePoolRequest
Response message for AwsClusters.CreateAwsNodePool method.
CreateAzureClientRequest
Request message for AzureClusters.CreateAzureClient method.
CreateAzureClusterRequest
Request message for AzureClusters.CreateAzureCluster method.
CreateAzureNodePoolRequest
Response message for AzureClusters.CreateAzureNodePool method.
DeleteAttachedClusterRequest
Request message for AttachedClusters.DeleteAttachedCluster
method.
DeleteAwsClusterRequest
Request message for AwsClusters.DeleteAwsCluster method.
DeleteAwsNodePoolRequest
Request message for AwsClusters.DeleteAwsNodePool method.
DeleteAzureClientRequest
Request message for AzureClusters.DeleteAzureClient method.
DeleteAzureClusterRequest
Request message for AzureClusters.DeleteAzureCluster method.
DeleteAzureNodePoolRequest
Request message for AzureClusters.DeleteAzureNodePool method.
Fleet
Fleet related configuration.
Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.
See Anthos
Fleets <https://cloud.google.com/anthos/multicluster-management/fleets>__
for more details on Anthos multi-cluster capabilities using Fleets.
GenerateAttachedClusterAgentTokenRequest
GenerateAttachedClusterAgentTokenResponse
GenerateAttachedClusterInstallManifestRequest
Request message for
AttachedClusters.GenerateAttachedClusterInstallManifest method.
GenerateAttachedClusterInstallManifestResponse
Response message for
AttachedClusters.GenerateAttachedClusterInstallManifest method.
GenerateAwsAccessTokenRequest
Request message for AwsClusters.GenerateAwsAccessToken method.
GenerateAwsAccessTokenResponse
Response message for AwsClusters.GenerateAwsAccessToken method.
GenerateAwsClusterAgentTokenRequest
GenerateAwsClusterAgentTokenResponse
GenerateAzureAccessTokenRequest
Request message for AzureClusters.GenerateAzureAccessToken
method.
GenerateAzureAccessTokenResponse
Response message for AzureClusters.GenerateAzureAccessToken
method.
GenerateAzureClusterAgentTokenRequest
GenerateAzureClusterAgentTokenResponse
GetAttachedClusterRequest
Request message for AttachedClusters.GetAttachedCluster method.
GetAttachedServerConfigRequest
GetAttachedServerConfigRequest gets the server config for attached clusters.
GetAwsClusterRequest
Request message for AwsClusters.GetAwsCluster method.
GetAwsJsonWebKeysRequest
GetAwsJsonWebKeysRequest 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.
GetAwsNodePoolRequest
Request message for AwsClusters.GetAwsNodePool method.
GetAwsOpenIdConfigRequest
GetAwsOpenIdConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetAwsServerConfigRequest
GetAwsServerConfigRequest gets the server config of GKE cluster on AWS.
GetAzureClientRequest
Request message for AzureClusters.GetAzureClient method.
GetAzureClusterRequest
Request message for AzureClusters.GetAzureCluster method.
GetAzureJsonWebKeysRequest
GetAzureJsonWebKeysRequest 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.
GetAzureNodePoolRequest
Request message for AzureClusters.GetAzureNodePool method.
GetAzureOpenIdConfigRequest
GetAzureOpenIdConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetAzureServerConfigRequest
GetAzureServerConfigRequest gets the server config of GKE cluster on Azure.
ImportAttachedClusterRequest
Request message for AttachedClusters.ImportAttachedCluster
method.
Jwk
Jwk is a JSON Web Key as specified in RFC 7517.
KubernetesSecret
Information about a Kubernetes Secret
ListAttachedClustersRequest
Request message for AttachedClusters.ListAttachedClusters
method.
ListAttachedClustersResponse
Response message for AttachedClusters.ListAttachedClusters
method.
ListAwsClustersRequest
Request message for AwsClusters.ListAwsClusters method.
ListAwsClustersResponse
Response message for AwsClusters.ListAwsClusters method.
ListAwsNodePoolsRequest
Request message for AwsClusters.ListAwsNodePools method.
ListAwsNodePoolsResponse
Response message for AwsClusters.ListAwsNodePools method.
ListAzureClientsRequest
Request message for AzureClusters.ListAzureClients method.
ListAzureClientsResponse
Response message for AzureClusters.ListAzureClients method.
ListAzureClustersRequest
Request message for AzureClusters.ListAzureClusters method.
ListAzureClustersResponse
Response message for AzureClusters.ListAzureClusters method.
ListAzureNodePoolsRequest
Request message for AzureClusters.ListAzureNodePools method.
ListAzureNodePoolsResponse
Response message for AzureClusters.ListAzureNodePools method.
LoggingComponentConfig
Parameters that describe the Logging component configuration in a cluster.
LoggingConfig
Parameters that describe the Logging configuration in a cluster.
ManagedPrometheusConfig
ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.
MaxPodsConstraint
Constraints applied to pods.
MonitoringConfig
Parameters that describe the Monitoring configuration in a cluster.
NodeKubeletConfig
Configuration for node pool kubelet options.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
NodeTaint
The taint content for the node taint.
OperationMetadata
Metadata about a long-running operation.
ReplicaPlacement
Configuration for the placement of a control plane replica.
RollbackAwsNodePoolUpdateRequest
Request message for AwsClusters.RollbackAwsNodePoolUpdate
method.
SecurityPostureConfig
SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.
SpotConfig
SpotConfig has configuration info for Spot node.
SurgeSettings
SurgeSettings contains the parameters for Surge update.
UpdateAttachedClusterRequest
Request message for AttachedClusters.UpdateAttachedCluster
method.
UpdateAwsClusterRequest
Request message for AwsClusters.UpdateAwsCluster method.
UpdateAwsNodePoolRequest
Request message for AwsClusters.UpdateAwsNodePool method.
UpdateAzureClusterRequest
Request message for AzureClusters.UpdateAzureCluster method.
UpdateAzureNodePoolRequest
Request message for AzureClusters.UpdateAzureNodePool method.
UpdateSettings
UpdateSettings control the level of parallelism and the level of disruption caused during the update of a node pool.
These settings are applicable when the node pool update requires replacing the existing node pool nodes with the updated ones.
UpdateSettings are optional. When UpdateSettings are not specified during the node pool creation, a default is chosen based on the parent cluster's version. For clusters with minor version 1.27 and later, a default surge_settings configuration with max_surge = 1 and max_unavailable = 0 is used. For clusters with older versions, node pool updates use the traditional rolling update mechanism of updating one node at a time in a "terminate before create" fashion and update_settings is not applicable.
Set the surge_settings parameter to use the Surge Update mechanism for the rolling update of node pool nodes.
- max_surge controls the number of additional nodes that can be created beyond the current size of the node pool temporarily for the time of the update to increase the number of available nodes.
- max_unavailable controls the number of nodes that can be simultaneously unavailable during the update.
- (max_surge + max_unavailable) determines the level of parallelism (i.e., the number of nodes being updated at the same time).
WorkloadIdentityConfig
Workload Identity settings.