Package google.cloud.gkehub.v1beta1

Index

GkeHubMembershipService

GKE Hub MembershipService gère l'enregistrement de nombreux clusters Kubernetes sur Google Cloud, représenté par la ressource Membership.

GKE Hub est actuellement disponible dans la région mondiale et dans toutes les régions disponibles sur https://cloud.google.com/compute/docs/regions-zones. La fonctionnalité n'est disponible que dans la région mondiale, tandis que l'appartenance est disponible dans la région mondiale et dans toutes les régions.

La gestion des appartenances peut s'avérer complexe : il est recommandé d'utiliser l'une des bibliothèques clientes ou l'un des outils fournis par Google lorsque vous utilisez des ressources Membership dans la mesure du possible.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Operation)

Crée une appartenance.

Cette fonctionnalité n'est actuellement disponible que pour les clusters GKE sur Google Cloud. Pour enregistrer d'autres clusters, suivez les instructions disponibles sur la page https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/registering-a-cluster.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Operation)

Supprime une appartenance.

Cette fonctionnalité n'est actuellement disponible que pour les clusters GKE sur Google Cloud. Pour annuler l'enregistrement d'autres clusters, suivez les instructions disponibles sur la page https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/unregistering-a-cluster.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
GenerateConnectManifest

rpc GenerateConnectManifest(GenerateConnectManifestRequest) returns (GenerateConnectManifestResponse)

Génère le fichier manifeste pour le déploiement de l'agent GKE Connect.

Cette méthode est utilisée en interne par les bibliothèques fournies par Google. La plupart des clients n'ont normalement pas besoin d'appeler cette méthode directement.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
GenerateExclusivityManifest

rpc GenerateExclusivityManifest(GenerateExclusivityManifestRequest) returns (GenerateExclusivityManifestResponse)

GenerateExclusivityManifest génère les fichiers manifestes pour mettre à jour les artefacts d'exclusivité du cluster si nécessaire.

Les artefacts d'exclusivité incluent la définition de ressource personnalisée (CRD) de la ressource Membership et la ressource personnalisée Membership Singleton. Combinés à ValidateExclusivity, les artefacts d'exclusivité garantissent qu'un cluster Kubernetes n'est enregistré que dans un seul GKE Hub.

La CRD Membership est fournie avec une gestion des versions et peut nécessiter une conversion lorsque le serveur d'API GKE Hub commence à diffuser une version plus récente de l'objet CRD et de la ressource personnalisée correspondante. La réponse contient les CRD et les ressources personnalisées converties en cas de différences entre les versions.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Récupère les détails d'une appartenance.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Répertorie les appartenances d'un projet et d'un emplacement donnés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Operation)

Met à jour une appartenance existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.
ValidateExclusivity

rpc ValidateExclusivity(ValidateExclusivityRequest) returns (ValidateExclusivityResponse)

ValidateExclusivity valide l'état d'exclusivité du cluster. La validation ne dépend pas d'une ressource d'abonnement Hub existante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la page Présentation de l'authentification.

ApplianceCluster

ApplianceCluster contient des informations spécifiques aux clusters GDC Edge Appliance.

Champs

Autorité

L'autorité code la manière dont Google reconnaît les identités de ce membre. Pour en savoir plus, consultez la documentation sur Workload Identity : https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity.

Champs
issuer

string

Facultatif. URI d'émetteur de jetons Web JSON (JWT). issuer doit commencer par https:// et être une URL valide comportant moins de 2 000 caractères.

Si ce champ est défini, Google autorise les jetons OIDC valides de cet émetteur à s'authentifier dans le pool d'identités de charge de travail. La découverte OIDC sera effectuée sur cet URI pour valider les jetons de l'émetteur.

Supprimer issuer désactive Workload Identity. issuer ne peut pas être modifié directement ; vous devez effacer son contenu (et désactiver Workload Identity) avant d'utiliser un nouvel émetteur (et de réactiver Workload Identity).
workload_identity_pool

string

Uniquement en sortie. Nom du pool d'identités de charge de travail dans lequel issuer sera reconnu.

Un seul pool d'identités de charge de travail est partagé entre toutes les appartenances appartenant à ce Hub. Pour un hub hébergé dans {PROJECT_ID}, le format du pool de charges de travail est {PROJECT_ID}.hub.id.goog, bien que cela soit susceptible d'être modifié dans les versions plus récentes de cette API.
identity_provider

string

Uniquement en sortie. Un fournisseur d'identité qui reflète la valeur issuer dans le pool d'identités de charge de travail.
oidc_jwks

bytes

Facultatif. Clés de validation OIDC de cette appartenance au format JWKS (RFC 7517).

Lorsque ce champ est défini, la découverte OIDC n'est PAS effectuée sur issuer, mais les jetons OIDC sont validés à l'aide de ce champ.

ConnectAgent

Informations requises par les utilisateurs finaux pour utiliser GKE Connect.

Champs
name
(deprecated)

string

Ne le paramétrez pas.
proxy

bytes

Facultatif. URI d'un proxy si la connectivité de l'agent à gkeconnect.googleapis.com nécessite l'utilisation d'un proxy. Doit être au format http(s)://{proxy_address}, en fonction du protocole HTTP/HTTPS accepté par le proxy. Le trafic sortant de l'agent Connect sera acheminé via un proxy HTTP(S).
namespace

string

Facultatif. Espace de noms des ressources de l'agent GKE Connect. La valeur par défaut est gke-connect.

L'agent Connect est automatiquement autorisé lorsqu'il est exécuté dans l'espace de noms par défaut. Sinon, vous devez accorder une autorisation explicite avec une liaison IAM supplémentaire.

ConnectAgentResource

ConnectAgentResource représente un fichier manifeste de ressource Kubernetes pour le déploiement de Connect Agent.

Champs
type

TypeMeta

Type Kubernetes de la ressource.
manifest

string

Fichier manifeste YAML de la ressource.

CreateMembershipRequest

Message de requête pour la méthode GkeHubMembershipService.CreateMembership.

Champs
parent

string

Obligatoire. Parent (projet et emplacement) dans lequel les ressources Membership seront créées. Spécifié au format projects/*/locations/*.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • gkehub.memberships.create
membership_id

string

Obligatoire. ID choisi par le client pour l'appartenance. membership_id doit être un libellé DNS valide conforme à la norme RFC 1123 :

  1. 63 caractères maximum
  2. Il doit être composé de caractères alphanumériques minuscules ou de -.
  3. Il doit commencer et se terminer par un caractère alphanumérique.

Il peut être exprimé sous la forme de l'expression régulière [a-z0-9]([-a-z0-9]*[a-z0-9])?, d'une longueur maximale de 63 caractères.
resource

Membership

Obligatoire. Appartenance à créer.
request_id

string

Facultatif. ID de requête permettant d'identifier les requêtes. Spécifiez un ID de requête unique pour que le serveur sache qu'il doit ignorer la requête si vous devez la retenter alors qu'elle est déjà terminée. Le serveur garantit cela pendant au moins 60 minutes après la première requête.

Par exemple, imaginons que vous effectuez une requête initiale et que celle-ci expire. Si vous effectuez à nouveau la requête avec le même ID de requête, le serveur peut vérifier si une opération d'origine ayant le même ID de requête a été reçue et, le cas échéant, ignorer la deuxième requête. Ainsi, les clients ne peuvent pas créer accidentellement des engagements en double.

L'ID de requête doit être un UUID valide, à ceci près qu'un UUID égal à zéro (00000000-0000-0000-0000-000000000000) n'est pas accepté.

DeleteMembershipRequest

Message de requête pour la méthode GkeHubMembershipService.DeleteMembership.

Champs
name

string

Obligatoire. Nom de la ressource Membership au format projects/*/locations/*/memberships/*.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gkehub.memberships.delete
request_id

string

Facultatif. ID de requête permettant d'identifier les requêtes. Spécifiez un ID de requête unique pour que le serveur sache qu'il doit ignorer la requête si vous devez la retenter alors qu'elle est déjà terminée. Le serveur garantit cela pendant au moins 60 minutes après la première requête.

Par exemple, imaginons que vous effectuez une requête initiale et que celle-ci expire. Si vous effectuez à nouveau la requête avec le même ID de requête, le serveur peut vérifier si une opération d'origine ayant le même ID de requête a été reçue et, le cas échéant, ignorer la deuxième requête. Ainsi, les clients ne peuvent pas créer accidentellement des engagements en double.

L'ID de requête doit être un UUID valide, à ceci près qu'un UUID égal à zéro (00000000-0000-0000-0000-000000000000) n'est pas accepté.
force

bool

Facultatif. Si la valeur est définie sur "true", toute sous-ressource de cette ressource Membership sera également supprimée. Sinon, la requête ne fonctionnera que si la ressource Membership n'a pas de sous-ressource.

EdgeCluster

EdgeCluster contient des informations spécifiques aux clusters périphériques Google.

Champs

GenerateConnectManifestRequest

Message de requête pour la méthode GkeHubMembershipService.GenerateConnectManifest.

Champs
name

string

Obligatoire. Nom de la ressource Membership à laquelle l'agent va s'associer, au format projects/*/locations/*/memberships/*.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gkehub.memberships.generateConnectManifest
connect_agent

ConnectAgent

Facultatif. Agent Connect pour lequel générer le fichier manifeste.
version

string

Facultatif. Version de l'agent Connect à utiliser. Correspond par défaut à la version la plus récente.
is_upgrade

bool

Facultatif. Si la valeur est définie sur "true", générez les ressources pour la mise à niveau uniquement. Certaines ressources générées uniquement pour l'installation (par exemple, les ressources Secret) seront exclues.
registry

string

Facultatif. Registre à partir duquel récupérer l'image de l'agent Connect. La valeur par défaut est gcr.io/gkeconnect.
image_pull_secret_content

bytes

Facultatif. Le contenu du secret d'extraction de l'image du registre, s'il n'est pas public.

GenerateConnectManifestResponse

GenerateConnectManifestResponse contient des informations du fichier manifeste pour l'installation/la mise à niveau d'un agent Connect.

Champs
manifest[]

ConnectAgentResource

Liste numérotée des ressources Kubernetes à appliquer au cluster pour l'installation ou la mise à niveau de l'agent GKE Connect.

GenerateExclusivityManifestRequest

Requête de génération des fichiers manifestes pour les artefacts d'exclusivité.

Champs
name

string

Obligatoire. Nom de la ressource Membership au format projects/*/locations/*/memberships/*.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gkehub.memberships.generateConnectManifest
crd_manifest

string

Facultatif. Le fichier manifeste YAML de la CRD Membership récupéré par kubectl get customresourcedefinitions membership. Laissez ce champ vide si la ressource n'existe pas.
cr_manifest

string

Facultatif. Le fichier manifeste YAML de la RS Membership récupéré par kubectl get memberships membership. Laissez ce champ vide si la ressource n'existe pas.

GenerateExclusivityManifestResponse

Réponse des fichiers manifestes d'artefacts d'exclusivité que le client doit appliquer.

Champs
crd_manifest

string

Fichier manifeste YAML de la CRD Membership à appliquer si une version plus récente de la CRD est disponible. Vide si aucune mise à jour n'est nécessaire.
cr_manifest

string

Le fichier manifeste YAML de la RS Membership à appliquer si une nouvelle version de la RS est disponible. Vide si aucune mise à jour n'est nécessaire.

GetMembershipRequest

Message de requête pour la méthode GkeHubMembershipService.GetMembership.

Champs
name

string

Obligatoire. Nom de la ressource Membership au format projects/*/locations/*/memberships/*.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gkehub.memberships.get

GkeCluster

GkeCluster contient des informations spécifiques aux clusters GKE.

Champs
cluster_missing

bool

Uniquement en sortie. Si cluster_MISSING est défini, cela signifie que le cluster GKE n'existe plus dans le plan de contrôle GKE.

KubernetesMetadata

KubernetesMetadata fournit des métadonnées informatives sur les appartenances représentant des clusters Kubernetes.

Champs
kubernetes_api_server_version

string

Uniquement en sortie. Chaîne de version du serveur d'API Kubernetes telle qu'indiquée par "/version".
node_provider_id

string

Uniquement en sortie. ID du fournisseur de nœud indiqué par le premier nœud de la liste des nœuds sur le point de terminaison Kubernetes. Sur les plates-formes Kubernetes qui acceptent les clusters sans nœud (comme GKE-on-GCP), node_count est égal à zéro et node_provider_id est vide.
node_count

int32

Uniquement en sortie. Nombre de nœuds indiqué par les ressources de nœuds Kubernetes.
vcpu_count

int32

Uniquement en sortie. Nombre de processeurs virtuels indiqué par les ressources des nœuds Kubernetes.
memory_mb

int32

Uniquement en sortie. Capacité totale de la mémoire indiquée par la somme de toutes les ressources de nœuds Kubernetes, définie en Mo.
update_time

Timestamp

Uniquement en sortie. Date et heure de la dernière mise à jour de ces informations. Ce champ update_time est différent de update_time au niveau de l'appartenance, car EndpointDetails est mis à jour en interne pour les utilisateurs de l'API.

KubernetesResource

KubernetesResource contient les fichiers manifestes et la configuration YAML pour les ressources Membership Kubernetes dans le cluster. Après CreateMembership ou UpdateMembership, ces ressources doivent être réappliquées dans le cluster.

Champs
membership_cr_manifest

string

Uniquement en entrée. Représentation YAML de la RS de la ressource Membership. Ce champ est ignoré pour les clusters GKE sur lesquels la ressource Hub peut lire directement la RS.

Les appelants doivent fournir la RS actuellement présente dans le cluster lors de la tâche CreateMembership ou UpdateMembership, ou laisser ce champ vide s'il n'en existe pas. Le fichier manifeste de RS permet de vérifier que le cluster n'a pas été enregistré auprès d'une autre ressource Membership.
membership_resources[]

ResourceManifest

Uniquement en sortie. Ressources Kubernetes supplémentaires à appliquer au cluster après la création de la ressource Membership et après chaque mise à jour.

Ce champ n'est renseigné que dans la ressource Membership renvoyée par une opération de longue durée réussie par CreateMembership ou UpdateMembership. Il n'est pas renseigné lors des demandes GetMembership ou ListMemberships normales. Pour obtenir le fichier manifeste de la ressource après l'enregistrement initial, l'appelant doit effectuer un appel UpdateMembership avec un masque de champ vide.
connect_resources[]

ResourceManifest

Uniquement en sortie. Ressources Kubernetes pour l'installation de l'agent GKE Connect

Ce champ n'est renseigné que dans la ressource Membership renvoyée par une opération de longue durée réussie par CreateMembership ou UpdateMembership. Il n'est pas renseigné lors des demandes GetMembership ou ListMemberships normales. Pour obtenir le fichier manifeste de la ressource après l'enregistrement initial, l'appelant doit effectuer un appel UpdateMembership avec un masque de champ vide.
resource_options

ResourceOptions

Facultatif. Options de génération de ressources Kubernetes.

ListMembershipsRequest

Message de requête pour la méthode GkeHubMembershipService.ListMemberships.

Champs
parent

string

Obligatoire. Parent (projet et emplacement) dans lequel les ressources Membership seront répertoriées. Spécifié au format projects/*/locations/*. projects/*/locations/- répertorie les ressources Membership dans toutes les régions.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • gkehub.memberships.list
page_size

int32

Facultatif. Lorsque vous demandez une "page" de ressources, page_size spécifie le nombre de ressources à renvoyer. Si cette valeur n'est pas spécifiée ou est définie sur 0, toutes les ressources sont renvoyées.
page_token

string

Facultatif. Jeton renvoyé par l'appel précédent à ListMemberships qui spécifie la position dans la liste à partir de laquelle continuer à répertorier les ressources.
filter

string

Facultatif. Répertorie les ressources Membership qui correspondent à l'expression de filtre, en suivant la syntaxe décrite sur https://google.aip.dev/160.

Exemples :

  • Le nom est bar dans le projet foo-proj et l'emplacement global :
  name = "projects/foo-proj/locations/global/membership/bar"
  • Ressources Membership dont le libellé est foo :
  labels.foo:*
  • Ressources Membership associées au libellé foo dont la valeur est bar :
  labels.foo = bar
  • Ressources Membership à l'état CREATING :
  state = CREATING
order_by

string

Facultatif. Un ou plusieurs champs à comparer et à utiliser pour trier la sortie. Consultez la page https://google.aip.dev/132#ordering.

ListMembershipsResponse

Message de réponse pour la méthode GkeHubMembershipService.ListMemberships.

Champs
resources[]

Membership

Liste des ressources Membership correspondantes.
next_page_token

string

Jeton permettant de demander la page de ressources suivante à la méthode ListMemberships. La valeur d'une chaîne vide signifie qu'il n'y a plus de ressources à renvoyer.
unreachable[]

string

Liste des zones géographiques inaccessibles lors de la récupération de cette liste.

Accès

La ressource Membership contient des informations sur un cluster membre.

Champs
name

string

Uniquement en sortie. Nom complet et unique de cette ressource Membership au format projects/*/locations/*/memberships/{membership_id}, défini lors de la création.

membership_id doit être un libellé DNS valide conforme à la norme RFC 1123 :

  1. 63 caractères maximum
  2. Il doit être composé de caractères alphanumériques minuscules ou de -.
  3. Il doit commencer et se terminer par un caractère alphanumérique.

Il peut être exprimé sous la forme de l'expression régulière : [a-z0-9]([-a-z0-9]*[a-z0-9])?, d'une longueur maximale de 63 caractères.
labels

map<string, string>

Facultatif. Libellés GCP pour cette appartenance.
description

string

Facultatif. Description de cette appartenance, limitée à 63 caractères. Doit correspondre à l'expression régulière : [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*
state

MembershipState

Uniquement en sortie. État de la ressource Membership.
authority

Authority

Facultatif. Comment identifier les charges de travail de cette ressource Membership. Pour en savoir plus, consultez la documentation sur Workload Identity : https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity.
create_time

Timestamp

Uniquement en sortie. Date de création de la ressource Membership.
update_time

Timestamp

Uniquement en sortie. Date de la dernière mise à jour de la ressource Membership.
delete_time

Timestamp

Uniquement en sortie. Date de suppression de la ressource Membership.
external_id

string

Facultatif. ID généré et géré en externe pour cette ressource Membership. Cet ID peut être modifié après sa création, mais cela n'est pas recommandé. Pour les clusters GKE, "external_id" est géré par l'API Hub, et les mises à jour sont ignorées.

L'ID doit correspondre à l'expression régulière : [a-zA-Z0-9][a-zA-Z0-9_\-\.]*

Si cette ressource Membership représente un cluster Kubernetes, cette valeur doit être définie sur l'UID de l'objet d'espace de noms kube-system.
last_connection_time

Timestamp

Uniquement en sortie. Pour les clusters utilisant Connect, horodatage de la connexion la plus récente établie avec Google Cloud. Cette heure est mise à jour toutes les quelques minutes, et non pas en continu. Pour les clusters qui n'utilisent pas GKE Connect ou qui ne se sont jamais connectés correctement, ce champ n'est pas défini.
unique_id

string

Uniquement en sortie. UUID généré par Google pour cette ressource. Ce nom est unique pour toutes les ressources Membership. Si une ressource Membership est supprimée et qu'une autre ressource portant le même nom est créée, elle obtient un "unique_id" différent.
infrastructure_type

Membership.InfrastructureType

Facultatif. Type d'infrastructure sur lequel cette ressource Membership s'exécute.
monitoring_config

MonitoringConfig

Facultatif. Informations de configuration de la surveillance de cette ressource Membership.
Champ d'union type. Le type de ressource représenté par cette ressource Membership type ne peut être que l'un des suivants :
endpoint

MembershipEndpoint

Facultatif. Informations sur le point de terminaison pour atteindre ce membre.

InfrastructureType

Spécifie le type d'infrastructure d'une appartenance. Le type d'infrastructure est utilisé par Hub pour contrôler le comportement spécifique à l'infrastructure, y compris la tarification.

Chaque distribution GKE (sur GCP, sur site, sur X, etc.) définit ce champ automatiquement, mais les clients des clusters associés doivent spécifier un type lors de l'enregistrement.

Enums
INFRASTRUCTURE_TYPE_UNSPECIFIED Aucun type n'a été spécifié. Certaines fonctionnalités de Hub peuvent nécessiter un type. Elles ne seront pas compatibles avec les abonnements avec cette valeur.
ON_PREM Infrastructure privée détenue ou gérée par le client. Cela inclut les distributions GKE telles que GKE On-Prem et GKE-OnBareMetal.
MULTI_CLOUD Infrastructure cloud publique

MembershipEndpoint

La ressource MembershipEndpoint contient les informations nécessaires pour contacter une API Kubernetes, un point de terminaison et d'autres métadonnées Kubernetes.

Champs
kubernetes_metadata

KubernetesMetadata

Uniquement en sortie. Métadonnées spécifiques à Kubernetes utiles.
kubernetes_resource

KubernetesResource

Facultatif. Les ressources Kubernetes dans le cluster à appliquer à un cluster correctement enregistré, à l'état stable. Ces ressources :

  • Assurent que le cluster est exclusivement enregistré auprès d'une seule ressource HubMembership.
  • Propagent les informations de pool de charges de travail disponibles dans le champ Membership Authority.
  • Vérifient la configuration initiale appropriée de la ressource HubFeatures par défaut.
Champ d'union type. Informations sur le cluster enregistré. type ne peut être qu'un des éléments suivants :
gke_cluster

GkeCluster

Facultatif. Informations spécifiques pour un cluster GKE-on-GCP.
on_prem_cluster

OnPremCluster

Facultatif. Informations spécifiques pour un cluster GKE On-Prem. Un cluster d'utilisateur sur site qui n'a pas de lien de ressource n'est pas autorisé à utiliser ce champ. Il doit avoir un "type" nul à la place.
multi_cloud_cluster

MultiCloudCluster

Facultatif. Informations spécifiques pour un cluster GKE Multi-Cloud.
edge_cluster

EdgeCluster

Facultatif. Informations spécifiques pour un cluster Google Edge.
appliance_cluster

ApplianceCluster

Facultatif. Informations spécifiques pour un cluster GDC Edge Appliance.

MembershipState

État de la ressource Membership.

Champs
code

MembershipState.Code

Uniquement en sortie. État actuel de la ressource Membership.
description
(deprecated)

string

Ce champ n'est jamais défini par HubService.
update_time
(deprecated)

Timestamp

Ce champ n'est jamais défini par le service Hub.

Code

Code décrit l'état d'une ressource Membership.

Enums
CODE_UNSPECIFIED Le code n'est pas défini.
CREATING Le cluster est en cours d'enregistrement.
READY Le cluster est enregistré.
DELETING L'enregistrement du cluster est en cours d'annulation.
UPDATING La ressource Membership est en cours de mise à jour.
SERVICE_UPDATING La ressource Membership est en cours de mise à jour par le service Hub.

MonitoringConfig

MonitoringConfig indique aux applications, services et interfaces utilisateur basés sur le parc comment les métriques du cluster sous-jacent sont transmises aux services de surveillance cloud. Il peut être défini sur une valeur vide ou non vide, mais ne peut pas être muté directement pour éviter de briser accidentellement la continuité des métriques.

Champs
project_id

string

Facultatif. Projet utilisé pour générer des rapports sur les métriques
location

string

Facultatif. Emplacement utilisé pour générer des rapports sur les métriques
cluster

string

Facultatif. Nom du cluster utilisé pour générer des rapports sur les métriques. Pour Anthos sur les clusters Anthos sur VMWare/Baremetal/MultiCloud, il serait au format {cluster_type}/{cluster_name} ; par exemple, "awsClusters/cluster_1".
kubernetes_metrics_prefix

string

Facultatif. Les métriques système Kubernetes, si elles sont disponibles, sont écrites dans ce préfixe. La valeur par défaut est kubernetes.io pour GKE, et kubernetes.io/anthos pour Anthos. Remarque : Anthos MultiCloud utilisera le préfixe kubernetes.io aujourd'hui, mais sera migré sous kubernetes.io/anthos.
cluster_hash

string

Facultatif. Pour les clusters GKE et multicloud, il s'agit de l'UUID de la ressource de cluster. Pour les clusters VMWare et Baremetal, il s'agit de l'UID kube-system.

MultiCloudCluster

MultiCloudCluster contient des informations spécifiques aux clusters GKE Multi-Cloud.

Champs
cluster_missing

bool

Uniquement en sortie. Si cluster_missing est défini, la ressource API(gkemulticloud.googleapis.com) n'existe plus pour ce cluster GKE Multi-Cloud.

OnPremCluster

OnPremCluster contient des informations spécifiques aux clusters GKE On-Prem.

Champs
cluster_missing

bool

Uniquement en sortie. Si le champ cluster_existing est défini, cela signifie que la ressource API(gkeonprem.googleapis.com) de ce cluster GKE On-Prem n'existe plus.
admin_cluster

bool

Immuable. Si le cluster est un cluster d'administrateur.
cluster_type

OnPremCluster.ClusterType

Immuable. Type du cluster sur site.

ClusterType

ClusterType décrit le type de cluster sur site.

Enums
CLUSTERTYPE_UNSPECIFIED La ressource ClusterType n'est pas définie.
BOOTSTRAP La ressource ClusterType est un cluster d'amorçage.
HYBRID La ressource ClusterType est un cluster hybride Bare Metal.
STANDALONE La ressource ClusterType est un cluster autonome Bare Metal.
USER La ressource ClusterType est un cluster d'utilisateur.

OperationMetadata

Représente les métadonnées de l'opération de longue durée.

Champs
create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'opération a été créée.
end_time

Timestamp

Uniquement en sortie. Heure à laquelle l'opération a terminé son exécution.
target

string

Uniquement en sortie. Chemin d'accès à la ressource défini par le serveur pour la cible de l'opération.
verb

string

Uniquement en sortie. Nom du verbe exécuté par l'opération.
status_detail

string

Uniquement en sortie. Statut lisible de l'opération, le cas échéant.
cancel_requested

bool

Uniquement en sortie. Détermine si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur [Operation.error][] avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.
api_version

string

Uniquement en sortie. Version de l'API ayant permis de démarrer l'opération.

ResourceManifest

La ressource ResourceManifest représente une ressource Kubernetes unique à appliquer au cluster.

Champs
manifest

string

Fichier manifeste YAML de la ressource.
cluster_scoped

bool

Indique si la ressource fournie dans le fichier manifeste est cluster_scoped. Si cette valeur n'est pas définie, le fichier manifeste est supposé être à l'échelle d'un espace de noms.

Ce champ est utilisé pour le mappage REST lors de l'application de la ressource dans un cluster.

ResourceOptions

La ressource ResourceOptions représente les options de génération de ressources Kubernetes.

Champs
connect_version

string

Facultatif. Version de l'agent Connect à utiliser pour connect_resources. Correspond par défaut à la dernière version de GKE Connect. La version doit être une version actuellement compatible. Les versions obsolètes seront refusées.
v1beta1_crd

bool

Facultatif. Utilisez apiextensions/v1beta1 au lieu de apiextensions/v1 pour les ressources CustomResourceDefinition. Cette option doit être définie pour les clusters ayant des versions de serveur d'API Kubernetes <1.16.
k8s_version

string

Facultatif. Version majeure du cluster Kubernetes. Cela permet uniquement de déterminer la version à utiliser pour les ressources CustomResourceDefinition, apiextensions/v1beta1 ou apiextensions/v1.

TypeMeta

La ressource TypeMeta est l'information de type nécessaire au démarshaling de contenu des ressources Kubernetes dans le fichier manifeste.

Champs
kind

string

Genre de la ressource (par exemple, Deployment).
api_version

string

Version d'API de la ressource (par exemple, v1).

UpdateMembershipRequest

Message de requête pour la méthode GkeHubMembershipService.UpdateMembership.

Champs
name

string

Obligatoire. Nom de la ressource d'appartenance au format suivant: projects/[project_id]/locations/global/memberships/[membership_id]

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gkehub.memberships.update
update_mask

FieldMask

Obligatoire. Masque de champs à mettre à jour. Au moins un chemin d'accès de champ doit être spécifié dans ce masque.
resource

Membership

Obligatoire. Seuls les champs spécifiés dans le champ update_mask sont mis à jour. Si vous spécifiez un champ dans la ressource update_mask, mais ne spécifiez pas sa valeur ici, ce champ sera supprimé. Si vous mettez à jour un champ de mappage, définissez la valeur d'une clé sur NULL ou une chaîne vide pour supprimer la clé du mappage. Il n'est pas possible de remplacer la valeur d'une clé par une chaîne vide. Si vous spécifiez la ressource update_mask sur un chemin spécial "*", remplace complètement tous les champs modifiables par l'utilisateur pour qu'ils correspondent à resource.
request_id

string

Facultatif. ID de requête permettant d'identifier les requêtes. Spécifiez un ID de requête unique pour que le serveur sache qu'il doit ignorer la requête si vous devez la retenter alors qu'elle est déjà terminée. Le serveur garantit cela pendant au moins 60 minutes après la première requête.

Par exemple, imaginons que vous effectuez une requête initiale et que celle-ci expire. Si vous effectuez à nouveau la requête avec le même ID de requête, le serveur peut vérifier si une opération d'origine ayant le même ID de requête a été reçue et, le cas échéant, ignorer la deuxième requête. Ainsi, les clients ne peuvent pas créer accidentellement des engagements en double.

L'ID de requête doit être un UUID valide, à ceci près qu'un UUID égal à zéro (00000000-0000-0000-0000-000000000000) n'est pas accepté.

ValidateExclusivityRequest

Requête permettant de valider l'état existant de la RS d'appartenance dans le cluster.

Champs
parent

string

Obligatoire. Parent (projet et emplacement) dans lequel les ressources Membership seront créées. Spécifié au format projects/*/locations/*.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • gkehub.memberships.generateConnectManifest
cr_manifest

string

Facultatif. Le code YAML de la RS d'appartenance dans le cluster. Vide si la RS d'adhésion n'existe pas.
intended_membership

string

Obligatoire. Nom d'appartenance prévu sous parent. Cette méthode n'effectue la validation qu'en prévision d'un appel CreateMembership portant le même nom.

ValidateExclusivityResponse

Réponse de l'état des résultats de la validation des artefacts d'exclusivité.

Champs
status

Status

Résultat de la validation.

  • OK signifie que l'exclusivité est validée, en supposant que le fichier manifeste produit par GenerateExclusivityManifest a bien été appliqué.
  • ALREADY_EXISTS signifie que la CRD Membership appartient déjà à un autre Hub. Consultez la section sur status.message pour en savoir plus.