Index
EdgeContainer(interface)Authorization(message)Cluster(message)ClusterNetworking(message)ClusterUser(message)CreateClusterRequest(message)CreateNodePoolRequest(message)CreateVpnConnectionRequest(message)DeleteClusterRequest(message)DeleteNodePoolRequest(message)DeleteVpnConnectionRequest(message)Fleet(message)GenerateAccessTokenRequest(message)GenerateAccessTokenResponse(message)GetClusterRequest(message)GetMachineRequest(message)GetNodePoolRequest(message)GetVpnConnectionRequest(message)KmsKeyState(enum)ListClustersRequest(message)ListClustersResponse(message)ListMachinesRequest(message)ListMachinesResponse(message)ListNodePoolsRequest(message)ListNodePoolsResponse(message)ListVpnConnectionsRequest(message)ListVpnConnectionsResponse(message)LocationMetadata(message)Machine(message)MaintenancePolicy(message)MaintenanceWindow(message)NodePool(message)NodePool.LocalDiskEncryption(message)OperationMetadata(message)Quota(message)RecurringTimeWindow(message)TimeWindow(message)UpdateClusterRequest(message)UpdateNodePoolRequest(message)VpnConnection(message)VpnConnection.BgpRoutingMode(enum)VpnConnection.Details(message)VpnConnection.Details.CloudRouter(message)VpnConnection.Details.CloudVpn(message)VpnConnection.Details.State(enum)VpnConnection.VpcProject(message)ZoneMetadata(message)
EdgeContainer
L'API EdgeContainer permet de gérer les clusters Kubernetes sur les déploiements Google Edge Cloud.
| CreateCluster |
|---|
|
Crée un cluster dans un projet et un emplacement donnés.
|
| CreateNodePool |
|---|
|
Crée un NodePool dans un projet et un emplacement donnés.
|
| CreateVpnConnection |
|---|
|
Crée une connexion VPN dans un projet et un emplacement donnés.
|
| DeleteCluster |
|---|
|
Supprime un seul cluster.
|
| DeleteNodePool |
|---|
|
Supprime un seul pool de nœuds.
|
| DeleteVpnConnection |
|---|
|
Supprime une seule connexion VPN.
|
| GenerateAccessToken |
|---|
|
Génère un jeton d'accès pour un cluster.
|
| GetCluster |
|---|
|
Récupère les détails d'un seul cluster.
|
| GetMachine |
|---|
|
Récupère les détails d'une seule machine.
|
| GetNodePool |
|---|
|
Récupère les détails d'un seul NodePool.
|
| GetVpnConnection |
|---|
|
Récupère les détails d'une seule connexion VPN.
|
| ListClusters |
|---|
|
Liste les clusters d'un projet et d'un emplacement donnés.
|
| ListMachines |
|---|
|
Liste les machines d'un projet et d'un emplacement donnés.
|
| ListNodePools |
|---|
|
Liste les NodePools d'un projet et d'un emplacement donnés.
|
| ListVpnConnections |
|---|
|
Liste les connexions VPN d'un projet et d'un emplacement donnés.
|
| UpdateCluster |
|---|
|
Met à jour les paramètres d'un seul cluster.
|
| UpdateNodePool |
|---|
|
Met à jour les paramètres d'un seul NodePool.
|
Autorisation
Stratégie RBAC qui sera appliquée et gérée par GEC.
| Champs | |
|---|---|
admin_users |
Obligatoire. Utilisateur auquel le rôle cluster-admin sera attribué sur le cluster. Il disposera d'un accès complet au cluster. Actuellement, il s'agit d'un champ unique, mais il sera étendu pour permettre à plusieurs administrateurs à l'avenir. |
Cluster
Cluster Kubernetes Google Distributed Cloud Edge.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du cluster. |
create_time |
Uniquement en sortie. Heure à laquelle le cluster a été créé. |
update_time |
Uniquement en sortie. Heure de la dernière mise à jour du cluster. |
labels |
Libellés associés à cette ressource. |
fleet |
Facultatif. Configuration du parc. |
networking |
Obligatoire. Configuration réseau à l'échelle du cluster. |
authorization |
Obligatoire. Immuable. Stratégie RBAC qui sera appliquée et gérée par GEC. |
default_max_pods_per_node |
Facultatif. Nombre maximal de pods par nœud utilisés par défaut si aucune valeur maximale n'est spécifiée explicitement pour un pool de nœuds dans ce cluster. Si rien n'est spécifié, la valeur par défaut de Kubernetes est utilisée. |
endpoint |
Uniquement en sortie. Adresse IP du serveur d'API Kubernetes. |
cluster_ca_certificate |
Uniquement en sortie. Certificat public de l'autorité de certification du cluster, encodé au format PEM. |
maintenance_policy |
Facultatif. Configuration des règles de maintenance à l'échelle du cluster. |
control_plane_version |
Uniquement en sortie. Version de publication du plan de contrôle |
node_version |
Uniquement en sortie. Version la plus ancienne parmi tous les nœuds de calcul. Ce champ peut être vide si le cluster ne comporte aucun nœud de calcul. |
ClusterNetworking
Configuration réseau à l'échelle du cluster.
| Champs | |
|---|---|
cluster_ipv4_cidr_blocks[] |
Obligatoire. Une adresse IPv4 RFC1918 de ces blocs est attribuée à chaque pod du cluster. Un seul bloc est accepté. Une fois le nœud créé, ce champ ne peut plus être modifié. |
services_ipv4_cidr_blocks[] |
Obligatoire. Une adresse IPv4 RFC1918 de ces blocs est attribuée à chaque service du cluster. Un seul bloc est accepté. Une fois le nœud créé, ce champ ne peut plus être modifié. |
ClusterUser
Principal utilisateur pour une stratégie RBAC.
| Champs | |
|---|---|
username |
Obligatoire. Un nom d'utilisateur Google actif. |
CreateClusterRequest
Crée un cluster.
| Champs | |
|---|---|
parent |
Obligatoire. Emplacement parent où ce cluster sera créé. L'autorisation IAM suivante est requise pour la ressource
|
cluster_id |
Obligatoire. Identifiant unique du cluster spécifié par le client. |
cluster |
Obligatoire. Cluster à créer. |
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
CreateNodePoolRequest
Crée un pool de nœuds.
| Champs | |
|---|---|
parent |
Obligatoire. Cluster parent dans lequel ce pool de nœuds sera créé. L'autorisation IAM suivante est requise pour la ressource
|
node_pool_id |
Obligatoire. Identifiant unique du pool de nœuds spécifié par le client. |
node_pool |
Obligatoire. Pool de nœuds à créer. |
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
CreateVpnConnectionRequest
Crée une connexion VPN.
| Champs | |
|---|---|
parent |
Obligatoire. Emplacement parent où cette connexion VPN sera créée. L'autorisation IAM suivante est requise pour la ressource
|
vpn_connection_id |
Obligatoire. Identifiant de la connexion VPN. |
vpn_connection |
Obligatoire. Connexion VPN à créer. |
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
DeleteClusterRequest
Supprime un cluster.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du cluster. L'autorisation IAM suivante est requise pour la ressource
|
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
DeleteNodePoolRequest
Supprime un pool de nœuds.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du pool de nœuds. L'autorisation IAM suivante est requise pour la ressource
|
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
DeleteVpnConnectionRequest
Supprime une connexion VPN.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la connexion VPN. L'autorisation IAM suivante est requise pour la ressource
|
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
Parc
Configuration liée au parc.
Les parcs sont un concept de Google Cloud permettant d'organiser de manière logique les clusters. Vous pouvez ainsi utiliser et gérer des fonctionnalités multicluster et appliquer des règles cohérentes à vos systèmes.
| Champs | |
|---|---|
project |
Obligatoire. Nom du projet hôte du parc dans lequel ce cluster sera enregistré. Les noms de projet sont au format |
membership |
Uniquement en sortie. Nom de la ressource Hub Membership gérée associée à ce cluster. Les noms des abonnements sont au format |
GenerateAccessTokenRequest
Génère un jeton d'accès pour un cluster.
| Champs | |
|---|---|
cluster |
Obligatoire. Nom de ressource du cluster. L'autorisation IAM suivante est requise pour la ressource
|
GenerateAccessTokenResponse
Jeton d'accès pour un cluster.
| Champs | |
|---|---|
access_token |
Uniquement en sortie. Jeton d'accès pour s'authentifier auprès de k8s api-server. |
expire_time |
Uniquement en sortie. Code temporel correspondant à l'expiration du jeton. |
GetClusterRequest
Récupère un cluster.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du cluster. L'autorisation IAM suivante est requise pour la ressource
|
GetMachineRequest
Récupère une machine.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la machine. L'autorisation IAM suivante est requise pour la ressource
|
GetNodePoolRequest
Obtient un pool de nœuds.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du pool de nœuds. L'autorisation IAM suivante est requise pour la ressource
|
GetVpnConnectionRequest
Obtient une connexion VPN.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la connexion VPN. L'autorisation IAM suivante est requise pour la ressource
|
KmsKeyState
Représente l'état d'accessibilité d'une clé KMS gérée par le client utilisée pour l'intégration CMEK.
| Enums | |
|---|---|
KMS_KEY_STATE_UNSPECIFIED |
Non spécifié. |
KMS_KEY_STATE_KEY_AVAILABLE |
La clé est disponible et les ressources dépendantes devraient être accessibles. |
KMS_KEY_STATE_KEY_UNAVAILABLE |
La clé est indisponible pour une raison non spécifiée. Il est possible que les ressources dépendantes soient inaccessibles. |
ListClustersRequest
Liste les clusters dans un emplacement.
| Champs | |
|---|---|
parent |
Obligatoire. Emplacement parent qui possède cette collection de clusters. L'autorisation IAM suivante est requise pour la ressource
|
page_size |
Nombre maximal de ressources à lister. |
page_token |
Jeton de page reçu d'une requête de liste précédente. Jeton de page reçu d'une requête de liste précédente. |
filter |
Seules les ressources correspondant à ce filtre seront listées. |
order_by |
Spécifie l'ordre dans lequel les ressources seront listées. |
ListClustersResponse
Liste des clusters dans un emplacement.
| Champs | |
|---|---|
clusters[] |
Clusters dans l'emplacement. |
next_page_token |
Jeton permettant de récupérer la page de résultats suivante. |
unreachable[] |
Emplacements inaccessibles. |
ListMachinesRequest
Liste les machines d'un site.
| Champs | |
|---|---|
parent |
Obligatoire. Site parent qui possède cette collection de machines. L'autorisation IAM suivante est requise pour la ressource
|
page_size |
Nombre maximal de ressources à lister. |
page_token |
Jeton de page reçu d'une requête de liste précédente. |
filter |
Seules les ressources correspondant à ce filtre seront listées. |
order_by |
Spécifie l'ordre dans lequel les ressources seront listées. |
ListMachinesResponse
Liste des machines d'un site.
| Champs | |
|---|---|
machines[] |
Machines sur le site. |
next_page_token |
Jeton permettant de récupérer la page de résultats suivante. |
unreachable[] |
Emplacements inaccessibles. |
ListNodePoolsRequest
Liste les pools de nœuds d'un cluster.
| Champs | |
|---|---|
parent |
Obligatoire. Cluster parent qui possède cette collection de pools de nœuds. L'autorisation IAM suivante est requise pour la ressource
|
page_size |
Nombre maximal de ressources à lister. |
page_token |
Jeton de page reçu d'une requête de liste précédente. |
filter |
Seules les ressources correspondant à ce filtre seront listées. |
order_by |
Spécifie l'ordre dans lequel les ressources seront listées. |
ListNodePoolsResponse
Liste des pools de nœuds d'un cluster.
| Champs | |
|---|---|
node_pools[] |
Pools de nœuds dans le cluster. |
next_page_token |
Jeton permettant de récupérer la page de résultats suivante. |
unreachable[] |
Emplacements inaccessibles. |
ListVpnConnectionsRequest
Liste les connexions VPN.
| Champs | |
|---|---|
parent |
Obligatoire. Emplacement parent qui possède cette collection de connexions VPN. L'autorisation IAM suivante est requise pour la ressource
|
page_size |
Nombre maximal de ressources à lister. |
page_token |
Jeton de page reçu d'une requête de liste précédente. |
filter |
Seules les ressources correspondant à ce filtre seront listées. |
order_by |
Spécifie l'ordre dans lequel les ressources seront listées. |
ListVpnConnectionsResponse
Liste des connexions VPN dans un emplacement.
| Champs | |
|---|---|
vpn_connections[] |
VpnConnections dans l'emplacement. |
next_page_token |
Jeton permettant de récupérer la page de résultats suivante. |
unreachable[] |
Emplacements inaccessibles. |
LocationMetadata
Métadonnées d'un google.cloud.location.Location donné.
| Champs | |
|---|---|
available_zones |
Ensemble des zones Google Distributed Cloud Edge disponibles dans l'emplacement. La carte est indexée par l'ID en minuscules de chaque zone. |
Machine
Une machine Google Distributed Cloud Edge capable de servir de nœud Kubernetes.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la machine. |
create_time |
Uniquement en sortie. Heure à laquelle le pool de nœuds a été créé. |
update_time |
Uniquement en sortie. Heure de la dernière mise à jour du pool de nœuds. |
labels |
Libellés associés à cette ressource. |
hosted_node |
Nom canonique de la ressource du nœud que cette machine est chargée d'héberger (par exemple, projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}). Il est vide si la machine n'est pas attribuée pour assumer le rôle d'un nœud. Pour les nœuds du plan de contrôle hébergés sur des machines périphériques, cette commande renvoie le format suivant : "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}". |
zone |
Zone Google Distributed Cloud Edge de cette machine. |
version |
Uniquement en sortie. Version logicielle de la machine. |
disabled |
Uniquement en sortie. Indique si la machine est désactivée. Si cette option est désactivée, la machine ne peut pas être mise en service. |
MaintenancePolicy
Configuration de la stratégie de maintenance.
| Champs | |
|---|---|
window |
Spécifie la fenêtre de maintenance au cours de laquelle la maintenance peut être effectuée. |
MaintenanceWindow
Configuration de l'intervalle de maintenance
| Champs | |
|---|---|
recurring_window |
Configuration d'un intervalle de maintenance récurrent. |
NodePool
Ensemble de nœuds Kubernetes dans un cluster avec une configuration et une spécification communes.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du pool de nœuds. |
create_time |
Uniquement en sortie. Heure à laquelle le pool de nœuds a été créé. |
update_time |
Uniquement en sortie. Heure de la dernière mise à jour du pool de nœuds. |
labels |
Libellés associés à cette ressource. |
node_location |
Nom de la zone Google Distributed Cloud Edge dans laquelle ce pool de nœuds sera créé. Exemple : |
node_count |
Obligatoire. Nombre de nœuds du pool. |
machine_filter |
Seules les machines correspondant à ce filtre pourront rejoindre le pool de nœuds. Le langage de filtrage accepte des chaînes telles que "name= |
local_disk_encryption |
Facultatif. Options de chiffrement du disque local. Ce champ n'est utilisé que lorsque la compatibilité avec les clés CMEK est activée. |
node_version |
Uniquement en sortie. Version la plus ancienne parmi tous les nœuds de calcul. |
LocalDiskEncryption
Configuration de la compatibilité CMEK pour le chiffrement du disque local de la machine Edge.
| Champs | |
|---|---|
kms_key |
Immuable. Clé cryptographique Cloud KMS (par exemple, projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}) à utiliser pour protéger les disques locaux des nœuds. Si aucune clé n'est spécifiée, une clé gérée par Google sera utilisée à la place. |
kms_key_active_version |
Uniquement en sortie. Version de CryptoKey Cloud KMS actuellement utilisée pour protéger les disques locaux des nœuds. Ne s'applique que si kms_key est défini. |
kms_key_state |
Uniquement en sortie. Disponibilité de la CryptoKey Cloud KMS. Si ce n'est pas le cas, les nœuds peuvent passer hors connexion, car ils ne peuvent pas accéder à leurs données locales. |
kms_status |
Uniquement en sortie. État d'erreur renvoyé par Cloud KMS lors de l'utilisation de cette clé. Ce champ ne peut être renseigné que si |
OperationMetadata
Métadonnées d'opération de longue durée pour les méthodes de l'API Edge Container.
| Champs | |
|---|---|
create_time |
Heure à laquelle l'opération a été créée. |
end_time |
Heure à laquelle l'opération a terminé son exécution. |
target |
Chemin d'accès à la ressource défini par le serveur pour la cible de l'opération. |
verb |
Verbe exécuté par l'opération. |
status_message |
Statut lisible de l'opération, le cas échéant. |
requested_cancellation |
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 |
api_version |
Version de l'API ayant permis de démarrer l'opération. |
warnings[] |
Avertissements qui ne bloquent pas l'opération, mais qui contiennent des informations pertinentes pour l'utilisateur final. |
Quota
Représente le quota pour les ressources Edge Container.
| Champs | |
|---|---|
metric |
Nom de la métrique de quota. |
limit |
Limite de quota pour cette métrique. |
usage |
Utilisation actuelle de cette métrique. |
RecurringTimeWindow
Représente une période arbitraire récurrente.
| Champs | |
|---|---|
window |
Période de la première récurrence. |
recurrence |
RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) pour la récurrence de cette fenêtre. Ils durent pendant la période comprise entre l'heure de début et l'heure de fin. |
TimeWindow
Représente une période arbitraire.
| Champs | |
|---|---|
start_time |
Heure de début de la période. |
end_time |
Heure de fin de la période. L'heure de fin doit être postérieure à l'heure de début. |
UpdateClusterRequest
Met à jour un cluster.
| Champs | |
|---|---|
update_mask |
Le masque de champ permet de spécifier les champs à écraser dans la ressource Cluster lors de la mise à jour. Les champs spécifiés dans le paramètre update_mask sont relatifs à la ressource, et non à la requête complète. Un champ sera écrasé s'il figure dans le masque. Si l'utilisateur ne fournit pas de masque, tous les champs seront écrasés. |
cluster |
Cluster mis à jour. L'autorisation IAM suivante est requise pour la ressource
|
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
UpdateNodePoolRequest
Met à jour un pool de nœuds.
| Champs | |
|---|---|
update_mask |
Le masque de champ permet de spécifier les champs à écraser dans la ressource NodePool lors de la mise à jour. Les champs spécifiés dans le paramètre update_mask sont relatifs à la ressource, et non à la requête complète. Un champ sera écrasé s'il figure dans le masque. Si l'utilisateur ne fournit pas de masque, tous les champs seront écrasés. |
node_pool |
Pool de nœuds mis à jour. L'autorisation IAM suivante est requise pour la ressource
|
request_id |
Identifiant unique de cette requête. 36 caractères ASCII maximum. Nous vous recommandons d'utiliser un UUID aléatoire. Cette requête n'est idempotente que si |
VpnConnection
Une connexion VPN
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la connexion VPN |
create_time |
Uniquement en sortie. Heure à laquelle la connexion VPN a été créée. |
update_time |
Uniquement en sortie. Heure de la dernière mise à jour de la connexion VPN. |
labels |
Libellés associés à cette ressource. |
nat_gateway_ip |
Adresse IP de la passerelle NAT ou du réseau étendu. Si un client dispose de plusieurs adresses IP NAT, il doit configurer le NAT de sorte qu'une seule adresse IP externe soit mappée sur le cluster Anthos GMEC. Ce champ est vide si la NAT n'est pas utilisée. |
bgp_routing_mode |
Mode de routage dynamique du réseau VPC ( |
cluster |
Nom canonique du cluster auquel se connecter. Il se présente sous la forme projects/{project}/locations/{location}/clusters/{cluster}. |
vpc |
ID du réseau VPC auquel se connecter. |
vpc_project |
Facultatif. Détails du projet du réseau VPC. Obligatoire si le VPC se trouve dans un projet différent de celui du cluster. |
enable_high_availability |
Indique si la haute disponibilité est activée pour cette connexion VPN côté cluster. Si cette option est activée, nous tenterons d'utiliser deux adresses IP flottantes ANG lors de la création de la connexion VPN. |
details |
Uniquement en sortie. Détails de la connexion créée. |
BgpRoutingMode
Mode de routage.
| Enums | |
|---|---|
BGP_ROUTING_MODE_UNSPECIFIED |
Inconnu |
REGIONAL |
Mode régional. |
GLOBAL |
Mode global. |
Détails
Détails de la connexion créée.
| Champs | |
|---|---|
state |
État de cette connexion. |
error |
Message d'erreur. Ce champ n'est renseigné que lorsque l'état est "ERROR". |
cloud_router |
Informations sur Cloud Router |
cloud_vpns[] |
Chaque connexion comporte plusieurs passerelles Cloud VPN. |
CloudRouter
Informations sur Cloud Router
| Champs | |
|---|---|
name |
Nom du routeur Cloud Router associé. |
CloudVpn
Informations sur Cloud VPN
| Champs | |
|---|---|
gateway |
Nom de la passerelle Cloud VPN créée. |
État
État actuel de la connexion.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Inconnu |
STATE_CONNECTED |
Connecté |
STATE_CONNECTING |
Connexion toujours en cours. |
STATE_ERROR |
Une erreur s'est produite. |
VpcProject
Détails du projet du réseau VPC.
| Champs | |
|---|---|
project_id |
Projet du VPC auquel se connecter. Si elle n'est pas spécifiée, elle est identique au projet du cluster. |
service_account |
Facultatif. Compte de service dans le projet VPC configuré par l'utilisateur. Il permet de créer/supprimer des routeurs Cloud Router et des VPN haute disponibilité Cloud VPN pour la connexion VPN. Si cette SA est modifiée pendant ou après la création d'une connexion VPN, vous devez supprimer les ressources Cloud Router et Cloud VPN dans |project_id|. Elle se présente sous la forme service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com. |
ZoneMetadata
Zone Google Distributed Cloud Edge où se trouvent les machines périphériques.
| Champs | |
|---|---|
quota[] |
Quota pour les ressources de cette zone. |