- Resource: Membership
- MembershipEndpoint
- GkeCluster
- OnPremCluster
- OnPremCluster.ClusterType
- MultiCloudCluster
- EdgeCluster
- ApplianceCluster
- KubernetesMetadata
- KubernetesResource
- ResourceManifest
- ResourceOptions
- MembershipState
- MembershipState.Code
- Authority
- MonitoringConfig
- Methods
Resource: Membership
Membership contains information about a member cluster.
JSON representation |
---|
{ "name": string, "labels": { string: string, ... }, "description": string, "state": { object ( |
Fields | |
---|---|
name |
Output only. The full, unique name of this Membership resource in the format
Which can be expressed as the regex: |
labels |
Optional. Labels for this membership. An object containing a list of |
description |
Output only. Description of this membership, limited to 63 characters. Must match the regex: This field is present for legacy purposes. |
state |
Output only. State of the Membership resource. |
createTime |
Output only. When the Membership was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. When the Membership was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. When the Membership was deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
externalId |
Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: If this Membership represents a Kubernetes cluster, this value should be set to the UID of the |
lastConnectionTime |
Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
uniqueId |
Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different uniqueId. |
authority |
Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity |
monitoringConfig |
Optional. The monitoring config information for this membership. |
Union field type . Type of resource represented by this Membership type can be only one of the following: |
|
endpoint |
Optional. Endpoint information to reach this member. |
MembershipEndpoint
MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
JSON representation |
---|
{ "kubernetesMetadata": { object ( |
Fields | |
---|---|
kubernetesMetadata |
Output only. Useful Kubernetes-specific metadata. |
kubernetesResource |
Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources:
|
googleManaged |
Output only. Whether the lifecycle of this membership is managed by a google cluster platform service. |
Union field type . Cluster information of the registered cluster. type can be only one of the following: |
|
gkeCluster |
Optional. Specific information for a GKE-on-GCP cluster. |
onPremCluster |
Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead. |
multiCloudCluster |
Optional. Specific information for a GKE Multi-Cloud cluster. |
edgeCluster |
Optional. Specific information for a Google Edge cluster. |
applianceCluster |
Optional. Specific information for a GDC Edge Appliance cluster. |
GkeCluster
GkeCluster contains information specific to GKE clusters.
JSON representation |
---|
{ "resourceLink": string, "clusterMissing": boolean } |
Fields | |
---|---|
resourceLink |
Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. |
clusterMissing |
Output only. If clusterMissing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. |
OnPremCluster
OnPremCluster contains information specific to GKE On-Prem clusters.
JSON representation |
---|
{
"resourceLink": string,
"clusterMissing": boolean,
"adminCluster": boolean,
"clusterType": enum ( |
Fields | |
---|---|
resourceLink |
Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster |
clusterMissing |
Output only. If clusterMissing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists. |
adminCluster |
Immutable. Whether the cluster is an admin cluster. |
clusterType |
Immutable. The on prem cluster's type. |
OnPremCluster.ClusterType
ClusterType describes on prem cluster's type.
Enums | |
---|---|
CLUSTERTYPE_UNSPECIFIED |
The ClusterType is not set. |
BOOTSTRAP |
The ClusterType is bootstrap cluster. |
HYBRID |
The ClusterType is baremetal hybrid cluster. |
STANDALONE |
The ClusterType is baremetal standalone cluster. |
USER |
The ClusterType is user cluster. |
MultiCloudCluster
MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.
JSON representation |
---|
{ "resourceLink": string, "clusterMissing": boolean } |
Fields | |
---|---|
resourceLink |
Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster |
clusterMissing |
Output only. If clusterMissing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists. |
EdgeCluster
EdgeCluster contains information specific to Google Edge Clusters.
JSON representation |
---|
{ "resourceLink": string } |
Fields | |
---|---|
resourceLink |
Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster |
ApplianceCluster
ApplianceCluster contains information specific to GDC Edge Appliance Clusters.
JSON representation |
---|
{ "resourceLink": string } |
Fields | |
---|---|
resourceLink |
Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance |
KubernetesMetadata
KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
JSON representation |
---|
{ "kubernetesApiServerVersion": string, "nodeProviderId": string, "nodeCount": integer, "vcpuCount": integer, "memoryMb": integer, "updateTime": string } |
Fields | |
---|---|
kubernetesApiServerVersion |
Output only. Kubernetes API server version string as reported by |
nodeProviderId |
Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the nodeCount will be zero and the nodeProviderId will be empty. |
nodeCount |
Output only. Node count as reported by Kubernetes nodes resources. |
vcpuCount |
Output only. vCPU count as reported by Kubernetes nodes resources. |
memoryMb |
Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. |
updateTime |
Output only. The time at which these details were last updated. This updateTime is different from the Membership-level updateTime since EndpointDetails are updated internally for API consumers. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
KubernetesResource
KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After memberships.create or memberships.patch, these resources should be re-applied in the cluster.
JSON representation |
---|
{ "membershipCrManifest": string, "membershipResources": [ { object ( |
Fields | |
---|---|
membershipCrManifest |
Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during memberships.create or memberships.patch, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership. |
membershipResources[] |
Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from memberships.create or memberships.patch. It is not populated during normal memberships.get or memberships.list requests. To get the resource manifest after the initial registration, the caller should make a memberships.patch call with an empty field mask. |
connectResources[] |
Output only. The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from memberships.create or memberships.patch. It is not populated during normal memberships.get or memberships.list requests. To get the resource manifest after the initial registration, the caller should make a memberships.patch call with an empty field mask. |
resourceOptions |
Optional. Options for Kubernetes resource generation. |
ResourceManifest
ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
JSON representation |
---|
{ "manifest": string, "clusterScoped": boolean } |
Fields | |
---|---|
manifest |
YAML manifest of the resource. |
clusterScoped |
Whether the resource provided in the manifest is This field is used for REST mapping when applying the resource in a cluster. |
ResourceOptions
ResourceOptions represent options for Kubernetes resource generation.
JSON representation |
---|
{ "connectVersion": string, "v1beta1Crd": boolean, "k8sVersion": string } |
Fields | |
---|---|
connectVersion |
Optional. The Connect agent version to use for connectResources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected. |
v1beta1Crd |
Optional. Use |
k8sVersion |
Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, |
MembershipState
MembershipState describes the state of a Membership resource.
JSON representation |
---|
{
"code": enum ( |
Fields | |
---|---|
code |
Output only. The current state of the Membership resource. |
MembershipState.Code
Code describes the state of a Membership resource.
Enums | |
---|---|
CODE_UNSPECIFIED |
The code is not set. |
CREATING |
The cluster is being registered. |
READY |
The cluster is registered. |
DELETING |
The cluster is being unregistered. |
UPDATING |
The Membership is being updated. |
SERVICE_UPDATING |
The Membership is being updated by the Hub Service. |
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
JSON representation |
---|
{ "issuer": string, "workloadIdentityPool": string, "identityProvider": string, "oidcJwks": string } |
Fields | |
---|---|
issuer |
Optional. A JSON Web Token (JWT) issuer URI. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workloadIdentityPool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearing |
workloadIdentityPool |
Output only. The name of the workload identity pool in which There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is |
identityProvider |
Output only. An identity provider that reflects the |
oidcJwks |
Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on A base64-encoded string. |
MonitoringConfig
MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics.
JSON representation |
---|
{ "projectId": string, "location": string, "cluster": string, "kubernetesMetricsPrefix": string, "clusterHash": string } |
Fields | |
---|---|
projectId |
Optional. Project used to report Metrics |
location |
Optional. Location used to report Metrics |
cluster |
Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {clusterType}/{clusterName}, e.g., "awsClusters/cluster_1". |
kubernetesMetricsPrefix |
Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos. |
clusterHash |
Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. |
Methods |
|
---|---|
|
Creates a new Membership. |
|
Removes a Membership. |
|
Generates the manifest for deployment of the GKE connect agent. |
|
Gets the details of a Membership. |
|
Gets the access control policy for a resource. |
|
Lists Memberships in a given project and location. |
|
Updates an existing Membership. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |