The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

Membership
Feature

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubClient

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

Membership
Feature

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

ListFeaturesAsyncPager

A pager for iterating through list_features requests.

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

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

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

ListFeaturesPager

A pager for iterating through list_features requests.

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

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

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

ListMembershipsAsyncPager

A pager for iterating through list_memberships requests.

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

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

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

ListMembershipsPager

A pager for iterating through list_memberships requests.

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

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

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

Authority

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details:

https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

CommonFeatureSpec

CommonFeatureSpec contains Hub-wide configuration information

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

CommonFeatureState

CommonFeatureState contains Hub-wide Feature status information.

ConnectAgentResource

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

CreateFeatureRequest

Request message for the GkeHub.CreateFeature method.

CreateMembershipRequest

Request message for the GkeHub.CreateMembership method.

DeleteFeatureRequest

Request message for GkeHub.DeleteFeature method.

DeleteMembershipRequest

Request message for GkeHub.DeleteMembership method.

Feature

Feature represents the settings and status of any Hub Feature.

LabelsEntry

The abstract base class for a message.

MembershipSpecsEntry

The abstract base class for a message.

MembershipStatesEntry

The abstract base class for a message.

FeatureResourceState

FeatureResourceState describes the state of a Feature resource in the GkeHub API. See FeatureState for the "running state" of the Feature in the Hub and across Memberships.

State

State describes the lifecycle status of a Feature.

FeatureState

FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context.

Code

Code represents a machine-readable, high-level status of the Feature.

GenerateConnectManifestRequest

Request message for GkeHub.GenerateConnectManifest method. .

GenerateConnectManifestResponse

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

GetFeatureRequest

Request message for GkeHub.GetFeature method.

GetMembershipRequest

Request message for GkeHub.GetMembership method.

GkeCluster

GkeCluster contains information specific to GKE clusters.

KubernetesMetadata

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

KubernetesResource

KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster.

ListFeaturesRequest

Request message for GkeHub.ListFeatures method.

ListFeaturesResponse

Response message for the GkeHub.ListFeatures method.

ListMembershipsRequest

Request message for GkeHub.ListMemberships method.

ListMembershipsResponse

Response message for the GkeHub.ListMemberships method.

Membership

Membership contains information about a member cluster.

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

LabelsEntry

The abstract base class for a message.

MembershipEndpoint

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.

MembershipFeatureSpec

MembershipFeatureSpec contains configuration information for a single Membership.

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

MembershipFeatureState

MembershipFeatureState contains Feature status information for a single Membership.

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

MembershipState

MembershipState describes the state of a Membership resource.

Code

Code describes the state of a Membership resource.

MonitoringConfig

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

OperationMetadata

Represents the metadata of the long-running operation.

ResourceManifest

ResourceManifest represents a single Kubernetes resource to be applied to the cluster.

ResourceOptions

ResourceOptions represent options for Kubernetes resource generation.

TypeMeta

TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.

UpdateFeatureRequest

Request message for GkeHub.UpdateFeature method.

UpdateMembershipRequest

Request message for GkeHub.UpdateMembership method.

GkeHubMembershipServiceAsyncClient

The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubMembershipServiceClient

The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

ListMembershipsAsyncPager

A pager for iterating through list_memberships requests.

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

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

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

ListMembershipsPager

A pager for iterating through list_memberships requests.

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

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

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

ApplianceCluster

ApplianceCluster contains information specific to GDC Edge Appliance Clusters.

Authority

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details:

https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

ConnectAgent

The information required from end users to use GKE Connect.

ConnectAgentResource

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

CreateMembershipRequest

Request message for the GkeHubMembershipService.CreateMembership method.

DeleteMembershipRequest

Request message for GkeHubMembershipService.DeleteMembership method.

EdgeCluster

EdgeCluster contains information specific to Google Edge Clusters.

GenerateConnectManifestRequest

Request message for GkeHubMembershipService.GenerateConnectManifest method.

GenerateConnectManifestResponse

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

GenerateExclusivityManifestRequest

The request to generate the manifests for exclusivity artifacts.

GenerateExclusivityManifestResponse

The response of the exclusivity artifacts manifests for the client to apply.

GetMembershipRequest

Request message for GkeHubMembershipService.GetMembership method.

GkeCluster

GkeCluster contains information specific to GKE clusters.

KubernetesMetadata

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

KubernetesResource

ListMembershipsRequest

Request message for GkeHubMembershipService.ListMemberships method.

ListMembershipsResponse

Response message for the GkeHubMembershipService.ListMemberships method.

Membership

Membership contains information about a member cluster.

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

InfrastructureType

Specifies the infrastructure type of a Membership. Infrastructure type is used by Hub to control infrastructure-specific behavior, including pricing.

Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field automatically, but Attached Clusters customers should specify a type during registration.

LabelsEntry

The abstract base class for a message.

MembershipEndpoint

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.

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

Modules

pagers

API documentation for gkehub_v1.services.gke_hub.pagers module.

pagers

API documentation for gkehub_v1beta1.services.gke_hub_membership_service.pagers module.