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.

ListBoundMembershipsAsyncPager

A pager for iterating through list_bound_memberships requests.

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

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

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

ListBoundMembershipsPager

A pager for iterating through list_bound_memberships requests.

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

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

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

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.

ListFleetsAsyncPager

A pager for iterating through list_fleets requests.

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

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

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

ListFleetsPager

A pager for iterating through list_fleets requests.

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

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

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

ListMembershipBindingsAsyncPager

A pager for iterating through list_membership_bindings requests.

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

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

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

ListMembershipBindingsPager

A pager for iterating through list_membership_bindings requests.

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

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

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

ListMembershipRBACRoleBindingsAsyncPager

A pager for iterating through list_membership_rbac_role_bindings requests.

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

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

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

ListMembershipRBACRoleBindingsPager

A pager for iterating through list_membership_rbac_role_bindings requests.

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

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

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.

ListPermittedScopesAsyncPager

A pager for iterating through list_permitted_scopes requests.

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

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

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

ListPermittedScopesPager

A pager for iterating through list_permitted_scopes requests.

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

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

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

ListScopeNamespacesAsyncPager

A pager for iterating through list_scope_namespaces requests.

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

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

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

ListScopeNamespacesPager

A pager for iterating through list_scope_namespaces requests.

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

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

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

ListScopeRBACRoleBindingsAsyncPager

A pager for iterating through list_scope_rbac_role_bindings requests.

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

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

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

ListScopeRBACRoleBindingsPager

A pager for iterating through list_scope_rbac_role_bindings requests.

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

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

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

ListScopesAsyncPager

A pager for iterating through list_scopes requests.

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

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

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

ListScopesPager

A pager for iterating through list_scopes requests.

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

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

All the usual ListScopesResponse 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

BinaryAuthorizationConfig

BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature.

EvaluationMode

Binary Authorization mode of operation.

PolicyBinding

Binauthz policy that applies to this cluster.

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 Fleet-wide Feature status information.

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

CompliancePostureConfig

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

ComplianceStandard

Mode

ConnectAgentResource

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

CreateFeatureRequest

Request message for the GkeHub.CreateFeature method.

CreateFleetRequest

Request message for the GkeHub.CreateFleet method.

CreateMembershipBindingRequest

Request to create a MembershipBinding.

CreateMembershipRBACRoleBindingRequest

Request to create a rbacrolebindings.

CreateMembershipRequest

Request message for the GkeHub.CreateMembership method.

CreateScopeNamespaceRequest

Request to create a fleet namespace.

CreateScopeRBACRoleBindingRequest

Request to create a rbacrolebindings.

CreateScopeRequest

Request to create a Scope.

DefaultClusterConfig

DefaultClusterConfig describes the default cluster configurations to be applied to all clusters born-in-fleet.

DeleteFeatureRequest

Request message for GkeHub.DeleteFeature method.

DeleteFleetRequest

Request message for GkeHub.DeleteFleet method.

DeleteMembershipBindingRequest

Request to delete a Binding.

DeleteMembershipRBACRoleBindingRequest

Request to delete a Membership RBACRoleBinding.

DeleteMembershipRequest

Request message for GkeHub.DeleteMembership method.

DeleteScopeNamespaceRequest

Request to delete a fleet namespace.

DeleteScopeRBACRoleBindingRequest

Request to delete a Scope RBACRoleBinding.

DeleteScopeRequest

Request to delete a Scope.

Feature

Feature represents the settings and status of any Fleet 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.

ScopeSpecsEntry

The abstract base class for a message.

ScopeStatesEntry

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

Fleet

Fleet contains the Fleet-wide metadata and configuration.

LabelsEntry

The abstract base class for a message.

FleetLifecycleState

FleetLifecycleState describes the state of a Fleet resource.

Code

Code describes the state of a Fleet resource.

GenerateConnectManifestRequest

Request message for GkeHub.GenerateConnectManifest method. .

GenerateConnectManifestResponse

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

GenerateMembershipRBACRoleBindingYAMLRequest

Request to generate a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.

GenerateMembershipRBACRoleBindingYAMLResponse

Response for GenerateRBACRoleBindingYAML.

GetFeatureRequest

Request message for GkeHub.GetFeature method.

GetFleetRequest

Request message for the GkeHub.GetFleet method.

GetMembershipBindingRequest

Request message for the GkeHub.GetMembershipBinding method.

GetMembershipRBACRoleBindingRequest

Request message for the GkeHub.GetMembershipRBACRoleBinding method.

GetMembershipRequest

Request message for GkeHub.GetMembership method.

GetScopeNamespaceRequest

Request message for the GkeHub.GetNamespace method.

GetScopeRBACRoleBindingRequest

Request message for the GkeHub.GetScopeRBACRoleBinding method.

GetScopeRequest

Request message for the GkeHub.GetScope 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.

ListBoundMembershipsRequest

Request to list Memberships bound to a Scope.

ListBoundMembershipsResponse

List of Memberships bound to a Scope.

ListFeaturesRequest

Request message for GkeHub.ListFeatures method.

ListFeaturesResponse

Response message for the GkeHub.ListFeatures method.

ListFleetsRequest

Request message for the GkeHub.ListFleets method.

ListFleetsResponse

Response message for the GkeHub.ListFleetsResponse method.

ListMembershipBindingsRequest

Request to list MembershipBinding.

ListMembershipBindingsResponse

List of MembershipBindings.

ListMembershipRBACRoleBindingsRequest

Request to list Membership RBACRoleBindings.

ListMembershipRBACRoleBindingsResponse

List of Membership RBACRoleBindings.

ListMembershipsRequest

Request message for GkeHub.ListMemberships method.

ListMembershipsResponse

Response message for the GkeHub.ListMemberships method.

ListPermittedScopesRequest

Request to list permitted Scopes.

ListPermittedScopesResponse

List of permitted Scopes.

ListScopeNamespacesRequest

Request to list fleet namespaces.

ListScopeNamespacesResponse

List of fleet namespaces.

ListScopeRBACRoleBindingsRequest

Request to list Scope RBACRoleBindings.

ListScopeRBACRoleBindingsResponse

List of Scope RBACRoleBindings.

ListScopesRequest

Request to list Scopes.

ListScopesResponse

List of Scopes.

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.

MembershipBinding

MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to.

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

LabelsEntry

The abstract base class for a message.

MembershipBindingLifecycleState

MembershipBindingLifecycleState describes the state of a Binding resource.

Code

Code describes the state of a MembershipBinding resource.

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.

Namespace

Namespace represents a namespace across the Fleet

LabelsEntry

The abstract base class for a message.

NamespaceLabelsEntry

The abstract base class for a message.

NamespaceLifecycleState

NamespaceLifecycleState describes the state of a Namespace resource.

Code

Code describes the state of a Namespace resource.

OperationMetadata

Represents the metadata of the long-running operation.

RBACRoleBinding

RBACRoleBinding represents a rbacrolebinding across the Fleet

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

LabelsEntry

The abstract base class for a message.

Role

Role is the type for Kubernetes roles

PredefinedRoles

PredefinedRoles is an ENUM representation of the default Kubernetes Roles

RBACRoleBindingLifecycleState

RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.

Code

Code describes the state of a rbacrolebinding resource.

ResourceManifest

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

ResourceOptions

ResourceOptions represent options for Kubernetes resource generation.

Scope

Scope represents a Scope in a Fleet.

LabelsEntry

The abstract base class for a message.

NamespaceLabelsEntry

The abstract base class for a message.

ScopeFeatureSpec

ScopeFeatureSpec contains feature specs for a fleet scope.

ScopeFeatureState

ScopeFeatureState contains Scope-wide Feature status information.

ScopeLifecycleState

ScopeLifecycleState describes the state of a Scope resource.

Code

Code describes the state of a Scope resource.

SecurityPostureConfig

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

Mode

Mode defines enablement mode for GKE Security posture features.

VulnerabilityMode

VulnerabilityMode defines enablement mode for vulnerability scanning.

TypeMeta

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

UpdateFeatureRequest

Request message for GkeHub.UpdateFeature method.

UpdateFleetRequest

Request message for the GkeHub.UpdateFleet method.

UpdateMembershipBindingRequest

Request to update a MembershipBinding.

UpdateMembershipRBACRoleBindingRequest

Request to update a membership rbacrolebinding.

UpdateMembershipRequest

Request message for GkeHub.UpdateMembership method.

UpdateScopeNamespaceRequest

Request to update a fleet namespace.

UpdateScopeRBACRoleBindingRequest

Request to update a scope rbacrolebinding.

UpdateScopeRequest

Request to update a Scope.

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.

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.

Package Classes (1.21.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Package Classes (1.21.0)