Package google.cloud.edgecontainer.v1

Index

EdgeContainer

L'API EdgeContainer permet de gérer les clusters Kubernetes sur les déploiements Google Edge Cloud.

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

Crée un cluster dans un projet et un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

Crée un NodePool dans un projet et un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

Crée une connexion VPN dans un projet et un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

Supprime un seul cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

Supprime un seul pool de nœuds.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

Supprime une seule connexion VPN.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

Génère un jeton d'accès pour un cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GenerateOfflineCredential

rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse)

Génère un identifiant hors connexion pour un cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

Récupère les détails d'un seul cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

Récupère les détails d'une seule machine.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

Récupère les détails d'un seul NodePool.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GetServerConfig

rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig)

Obtient la configuration du serveur.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

Récupère les détails d'une seule connexion VPN.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

Liste les clusters d'un projet et d'un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

Liste les machines d'un projet et d'un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

Liste les NodePools d'un projet et d'un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

Liste les connexions VPN d'un projet et d'un emplacement donnés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

Met à jour les paramètres d'un seul cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

Met à jour les paramètres d'un seul NodePool.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.
UpgradeCluster

rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation)

Met à niveau un seul cluster.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisation

Stratégie RBAC qui sera appliquée et gérée par GEC.

Champs
admin_users

ClusterUser

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.

ChannelConfig

Configuration d'un version disponible.

Champs
default_version

string

Uniquement en sortie. Version par défaut pour ce version disponible, par exemple : "1.4.0".

Cluster

Cluster Kubernetes Google Distributed Cloud Edge.

Champs
name

string

Obligatoire. Nom de ressource du cluster.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle le cluster a été créé.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour du cluster.
labels

map<string, string>

Libellés associés à cette ressource.
fleet

Fleet

Obligatoire. Configuration du parc.
networking

ClusterNetworking

Obligatoire. Configuration réseau à l'échelle du cluster.
authorization

Authorization

Obligatoire. Immuable. Stratégie RBAC qui sera appliquée et gérée par GEC.
default_max_pods_per_node

int32

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

string

Uniquement en sortie. Adresse IP du serveur d'API Kubernetes.
port

int32

Uniquement en sortie. Numéro de port du serveur d'API Kubernetes.
cluster_ca_certificate

string

Uniquement en sortie. Certificat public de l'autorité de certification du cluster, encodé au format PEM.
maintenance_policy

MaintenancePolicy

Facultatif. Configuration des règles de maintenance à l'échelle du cluster.
control_plane_version

string

Uniquement en sortie. Version de publication du plan de contrôle
node_version

string

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

ControlPlane

Facultatif. Configuration du plan de contrôle du cluster.
system_addons_config

SystemAddonsConfig

Facultatif. Configuration des modules complémentaires du système.
external_load_balancer_ipv4_address_pools[]

string

Facultatif. Pools d'adresses IPv4 pour l'équilibrage de charge externe du plan de données du cluster.
control_plane_encryption

ControlPlaneEncryption

Facultatif. Options de chiffrement de disque du plan de contrôle à distance. Ce champ n'est utilisé que lorsque la compatibilité avec les clés CMEK est activée.
status

Status

Uniquement en sortie. État actuel du cluster.
maintenance_events[]

MaintenanceEvent

Uniquement en sortie. Tous les événements de maintenance planifiés pour le cluster, y compris ceux en cours, ceux prévus et ceux effectués au cours des 90 derniers jours.
target_version

string

Facultatif. Version cible du cluster. Exemple : "1.5.0".
release_channel

ReleaseChannel

Facultatif. Version disponible à laquelle un cluster est abonné.
survivability_config

SurvivabilityConfig

Facultatif. Configuration de la capacité de survie du cluster, par exemple en cas de perte de connectivité réseau. Remarque : Cela ne s'applique qu'aux clusters de plan de contrôle local.
external_load_balancer_ipv6_address_pools[]

string

Facultatif. Pools d'adresses IPv6 pour l'équilibrage de charge externe du plan de données du cluster.
connection_state

ConnectionState

Uniquement en sortie. État actuel de la connexion du cluster.
external_load_balancer_address_pools[]

ExternalLoadBalancerPool

Facultatif. Pools d'équilibrage de charge externes pour le cluster.
zone_storage_encryption

ZoneStorageEncryption

Facultatif. Configuration du chiffrement du stockage de la zone
container_runtime_config

ContainerRuntimeConfig

Facultatif. Configuration de l'environnement d'exécution du conteneur du cluster.
enable_cluster_isolation

bool

Facultatif. Indique si le cluster doit être isolé. go/cluster-isolation-in-gdcc-cluster
google_group_authentication

GoogleGroupAuthenticationConfig

Facultatif. Configuration de l'authentification du groupe Google du cluster.

ConnectionState

ConnectionState contient l'état actuel de la connexion entre le cluster et Google.

Champs
state

State

Uniquement en sortie. État actuel de la connexion.
update_time

Timestamp

Uniquement en sortie. Heure à laquelle l'état de la connexion a été modifié pour la dernière fois.

État

État de la connexion.

Enums
STATE_UNSPECIFIED État de connexion inconnu.
DISCONNECTED Ce cluster est actuellement déconnecté de Google.
CONNECTED Ce cluster est actuellement connecté à Google.
CONNECTED_AND_SYNCING Ce cluster est actuellement connecté à Google, mais il se peut qu'il ait été reconnecté récemment après une déconnexion. La synchronisation est toujours en cours.

ContainerRuntimeConfig

Configuration de l'environnement d'exécution du conteneur du cluster.

Champs
default_container_runtime

DefaultContainerRuntime

Facultatif. Environnement d'exécution du conteneur par défaut à configurer dans le cluster.

DefaultContainerRuntime

Liste des runtimes de conteneur compatibles.

Enums
DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED L'environnement d'exécution du conteneur n'est pas spécifié.
RUNC Utilisez runc comme environnement d'exécution de conteneur par défaut dans le cluster.
GVISOR Utilisez gVisor comme environnement d'exécution de conteneur par défaut dans le cluster.

ControlPlane

Configuration du plan de contrôle du cluster.

Champs

Champ d'union config.

config ne peut être qu'un des éléments suivants :
remote

Remote

Configuration du plan de contrôle à distance.
local

Local

Configuration du plan de contrôle local.

Avertissement : Les clusters de plan de contrôle local doivent être créés dans leur propre projet. Les clusters de plan de contrôle local ne peuvent pas coexister dans le même projet avec d'autres types de clusters, y compris les clusters non GDCE. Si vous combinez des clusters GDCE avec plan de contrôle local et d'autres types de clusters dans le même projet, vous risquez de perdre des données.

Local

Configuration spécifique aux clusters avec un plan de contrôle hébergé localement.

Avertissement : Les clusters de plan de contrôle local doivent être créés dans leur propre projet. Les clusters de plan de contrôle local ne peuvent pas coexister dans le même projet avec d'autres types de clusters, y compris les clusters non GDCE. Si vous combinez des clusters GDCE avec plan de contrôle local et d'autres types de clusters dans le même projet, vous risquez de perdre des données.

Champs
node_location

string

Nom des zones Google Distributed Cloud Edge dans lesquelles ce pool de nœuds sera créé. Exemple : us-central1-edge-customer-a.
node_count

int32

Nombre de nœuds servant de répliques du plan de contrôle.
machine_filter

string

Seules les machines correspondant à ce filtre seront autorisées à héberger des nœuds de plan de contrôle. Le langage de filtrage accepte des chaînes telles que "name=". Pour en savoir plus, consultez la page AIP-160.
shared_deployment_policy

SharedDeploymentPolicy

Configuration des règles concernant le déploiement des applications utilisateur.
control_plane_node_storage_schema

string

Facultatif. Nom du schéma de stockage des nœuds du plan de contrôle.

Distant

Ce type ne comporte aucun champ.

Configuration spécifique aux clusters dont le plan de contrôle est hébergé à distance.

SharedDeploymentPolicy

Représente la configuration de la règle concernant le déploiement des applications utilisateur.

Enums
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED Non spécifié.
ALLOWED Les applications utilisateur peuvent être déployées à la fois sur le plan de contrôle et sur les nœuds de calcul.
DISALLOWED Les applications utilisateur ne peuvent pas être déployées sur les nœuds du plan de contrôle, mais uniquement sur les nœuds de calcul.

ControlPlaneEncryption

Configuration de la compatibilité avec les clés KMS gérées par le client pour les nœuds du plan de contrôle.

Champs
kms_key

string

Facultatif. Clé CryptoKey Cloud KMS (par exemple, projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}) à utiliser pour protéger les disques du plan de contrôle. Si aucune clé n'est spécifiée, une clé gérée par Google sera utilisée à la place.
kms_key_active_version

string

Uniquement en sortie. Version CryptoKey Cloud KMS actuellement utilisée pour protéger les disques du plan de contrôle. Ne s'applique que si kms_key est défini.
kms_key_state

KmsKeyState

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.KEY_AVAILABLE Cela peut être dû à un manque d'autorisations pour utiliser la clé, ou si la clé est désactivée ou supprimée.
kms_status

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 kms_key_state n'est pas KMS_KEY_STATE_KEY_AVAILABLE. S'il est renseigné, ce champ contient l'état d'erreur signalé par Cloud KMS.
resource_state

ResourceState

Uniquement en sortie. État actuel de la ressource associé à CMEK.

ExternalLoadBalancerPool

Pool d'équilibreur de charge externe avec configuration personnalisée (nom, attribution manuelle/automatique, plage d'adresses IPv4 non chevauchantes et plage d'adresses IPv6 facultative, par exemple).

Champs
address_pool

string

Facultatif. Nom du pool d'équilibreur de charge externe.
ipv4_range[]

string

Obligatoire. Plage d'adresses IPv4 sans chevauchement du pool d'équilibreur de charge externe.
ipv6_range[]

string

Facultatif. Plage d'adresses IPv6 sans chevauchement du pool d'équilibreur de charge externe.
avoid_buggy_ips

bool

Facultatif. Si la valeur est "true", le pool omet les adresses IP se terminant par .0 et .255. Certains matériels réseau suppriment le trafic vers ces adresses spéciales. Sa valeur par défaut est "false".
manual_assign

bool

Facultatif. Si la valeur est "true", les adresses de ce pool ne sont pas automatiquement attribuées aux services Kubernetes. Si la valeur est "true", une adresse IP de ce pool ne va être utilisée que si elle est spécifiée explicitement par un service. Sa valeur par défaut est "false".

GoogleGroupAuthenticationConfig

Configuration de l'authentification Google Group du cluster. go/gdc-google-group-authentication

Champs
enable

bool

Facultatif. Si la valeur est "true", le cluster sera configuré pour utiliser l'authentification Google Group.

MaintenanceEvent

Un événement de maintenance est une opération qui peut entraîner des perturbations temporaires des charges de travail du cluster, y compris les mises à niveau de cluster initiées par Google ou par l'utilisateur, les modifications de configuration de cluster initiées par l'utilisateur qui nécessitent le redémarrage des nœuds, etc.

Champs
uuid

string

Uniquement en sortie. UUID de l'événement de maintenance.
target_version

string

Uniquement en sortie. Version cible du cluster.
operation

string

Uniquement en sortie. Opération permettant d'exécuter l'événement de maintenance. Spécifié au format projects/*/locations/*/operations/*. Si l'événement de maintenance est divisé en plusieurs opérations (par exemple, en raison d'intervalles de maintenance), la dernière est enregistrée.
type

Type

Uniquement en sortie. Type d'événement de maintenance.
schedule

Schedule

Uniquement en sortie. Calendrier de l'événement de maintenance.
state

State

Uniquement en sortie. État de l'événement de maintenance.
create_time

Timestamp

Uniquement en sortie. Date et heure de création de la demande d'événement de maintenance.
start_time

Timestamp

Uniquement en sortie. Heure de début de l'événement de maintenance.
end_time

Timestamp

Uniquement en sortie. Heure à laquelle l'événement de maintenance s'est terminé, qu'il ait abouti ou non. Si l'événement de maintenance est divisé en plusieurs intervalles de maintenance, end_time n'est mis à jour que lorsque l'ensemble du flux se termine.
update_time

Timestamp

Uniquement en sortie. Heure à laquelle le message concernant l'événement de maintenance a été mis à jour.

Planification

Indique quand l'événement de maintenance doit être effectué.

Enums
SCHEDULE_UNSPECIFIED Non spécifié.
IMMEDIATELY Immédiatement après avoir reçu la demande.

État

Indique l'état de l'événement de maintenance.

Enums
STATE_UNSPECIFIED Non spécifié.
RECONCILING L'événement de maintenance est en cours. Le cluster est peut-être inutilisable.
SUCCEEDED L'événement de maintenance a réussi.
FAILED L'événement de maintenance a échoué.

Type

Indique le type d'événement de maintenance.

Enums
TYPE_UNSPECIFIED Non spécifié.
USER_INITIATED_UPGRADE Mise à niveau initiée par les utilisateurs.
GOOGLE_DRIVEN_UPGRADE Mise à niveau proposée par Google.

ReleaseChannel

Version disponible à laquelle un cluster est abonné.

Enums
RELEASE_CHANNEL_UNSPECIFIED Version disponible non spécifié. La chaîne STANDARD est sélectionnée par défaut.
NONE Aucun version disponible.
REGULAR Version disponible standard.

État

Indique l'état du cluster.

Enums
STATUS_UNSPECIFIED État inconnu.
PROVISIONING Création du cluster…
RUNNING Le cluster est créé et entièrement utilisable.
DELETING Suppression du cluster…
ERROR L'état indique que des erreurs se sont produites lors de la réconciliation ou de la suppression du cluster.
RECONCILING Le cluster est en cours de maintenance (mise à niveau de la version, etc.).

SurvivabilityConfig

Configuration de la capacité de survie du cluster, par exemple en cas de perte de connectivité réseau.

Champs
offline_reboot_ttl

Duration

Facultatif. Période pendant laquelle les nœuds du cluster peuvent être redémarrés et devenir fonctionnels sans connectivité réseau à Google. La valeur par défaut (0) signifie que l'accès n'est pas autorisé. La valeur maximale est de sept jours.

SystemAddonsConfig

Configuration que les clients sont autorisés à définir pour les modules complémentaires du système GDCE.

Champs
ingress

Ingress

Facultatif. Configuration pour Ingress.
vm_service_config

VMServiceConfig

Facultatif. Configuration pour le service de VM.

Entrée

Configuration du module complémentaire Ingress qui permet aux clients de créer un objet Ingress pour gérer l'accès externe aux serveurs d'un cluster. Le module complémentaire se compose d'istiod et d'istio-ingress.

Champs
disabled

bool

Facultatif. Indique si Ingress est désactivé.
ipv4_vip

string

Facultatif. Adresse IP virtuelle d'entrée.

VMServiceConfig

VMServiceConfig définit la configuration du service de VM GDCE.

Champs
vmm_enabled

bool

Facultatif. Indique si VMM est activé.

ZoneStorageEncryption

Configuration de la compatibilité CMEK pour le stockage par zone

Champs
kms_key

string

Facultatif. Clé Cloud KMS
kms_key_active_version

string

Uniquement en sortie. Version de la clé cryptographique Cloud KMS actuellement utilisée pour le chiffrement/déchiffrement
resource_state

ResourceState

Uniquement en sortie. État actuel de la ressource CMEK

ClusterNetworking

Configuration réseau à l'échelle du cluster.

Champs
cluster_ipv4_cidr_blocks[]

string

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[]

string

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

string

Obligatoire. Un nom d'utilisateur Google actif.

ConfigData

Les données de configuration contiennent toutes les données de configuration associées à la zone.

Champs
available_external_lb_pools_ipv4[]

string

Liste des pools d'adresses IP v4 disponibles pour l'équilibreur de charge externe
available_external_lb_pools_ipv6[]

string

Liste des pools d'adresses IP v6 disponibles pour l'équilibreur de charge externe

CreateClusterRequest

Crée un cluster.

Champs
parent

string

Obligatoire. Emplacement parent où ce cluster sera créé.

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

  • edgecontainer.clusters.create
cluster_id

string

Obligatoire. Identifiant unique du cluster spécifié par le client.
cluster

Cluster

Obligatoire. Cluster à créer.
request_id

string

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 request_id est fourni.

CreateNodePoolRequest

Crée un pool de nœuds.

Champs
parent

string

Obligatoire. Cluster parent dans lequel ce pool de nœuds sera créé.

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

  • edgecontainer.nodePools.create
node_pool_id

string

Obligatoire. Identifiant unique du pool de nœuds spécifié par le client.
node_pool

NodePool

Obligatoire. Pool de nœuds à créer.
request_id

string

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 request_id est fourni.

CreateVpnConnectionRequest

Crée une connexion VPN.

Champs
parent

string

Obligatoire. Emplacement parent où cette connexion VPN sera créée.

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

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

Obligatoire. Identifiant de la connexion VPN.
vpn_connection

VpnConnection

Obligatoire. Connexion VPN à créer.
request_id

string

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 request_id est fourni.

DeleteClusterRequest

Supprime un cluster.

Champs
name

string

Obligatoire. Nom de ressource du cluster.

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

  • edgecontainer.clusters.delete
request_id

string

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 request_id est fourni.

DeleteNodePoolRequest

Supprime un pool de nœuds.

Champs
name

string

Obligatoire. Nom de ressource du pool de nœuds.

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

  • edgecontainer.nodePools.delete
request_id

string

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 request_id est fourni.

DeleteVpnConnectionRequest

Supprime une connexion VPN.

Champs
name

string

Obligatoire. Nom de ressource de la connexion VPN.

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

  • edgecontainer.vpnConnections.delete
request_id

string

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 request_id est fourni.

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

string

Obligatoire. Nom du projet hôte du parc dans lequel ce cluster sera enregistré.

Les noms de projet sont au format projects/<project-number>.
membership

string

Uniquement en sortie. Nom de la ressource Hub Membership gérée associée à ce cluster.

Les noms des abonnements sont au format projects/<project-number>/locations/global/membership/<cluster-id>.

GenerateAccessTokenRequest

Génère un jeton d'accès pour un cluster.

Champs
cluster

string

Obligatoire. Nom de ressource du cluster.

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

  • edgecontainer.clusters.generateAccessToken

GenerateAccessTokenResponse

Jeton d'accès pour un cluster.

Champs
access_token

string

Uniquement en sortie. Jeton d'accès pour s'authentifier auprès de k8s api-server.
expire_time

Timestamp

Uniquement en sortie. Code temporel correspondant à l'expiration du jeton.

GenerateOfflineCredentialRequest

Génère des identifiants hors connexion pour un cluster.

Champs
cluster

string

Obligatoire. Nom de ressource du cluster.

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

  • edgecontainer.clusters.generateOfflineCredential

GenerateOfflineCredentialResponse

Identifiant hors connexion pour un cluster.

Champs
client_certificate

string

Uniquement en sortie. Certificat client pour s'authentifier auprès de k8s api-server.
client_key

string

Uniquement en sortie. Clé privée du client pour s'authentifier auprès de k8s api-server.
user_id

string

Uniquement en sortie. Identité du client.
expire_time

Timestamp

Uniquement en sortie. Code temporel correspondant à l'expiration de cet identifiant.

GetClusterRequest

Récupère un cluster.

Champs
name

string

Obligatoire. Nom de ressource du cluster.

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

  • edgecontainer.clusters.get

GetMachineRequest

Récupère une machine.

Champs
name

string

Obligatoire. Nom de ressource de la machine.

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

  • edgecontainer.machines.get

GetNodePoolRequest

Obtient un pool de nœuds.

Champs
name

string

Obligatoire. Nom de ressource du pool de nœuds.

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

  • edgecontainer.nodePools.get

GetServerConfigRequest

Obtient la configuration du serveur.

Champs
name

string

Obligatoire. Nom (projet et emplacement) de la configuration du serveur à obtenir, au format projects/*/locations/*.

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

  • edgecontainer.serverConfig.get

GetVpnConnectionRequest

Obtient une connexion VPN.

Champs
name

string

Obligatoire. Nom de ressource de la connexion VPN.

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

  • edgecontainer.vpnConnections.get

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

string

Obligatoire. Emplacement parent qui possède cette collection de clusters.

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

  • edgecontainer.clusters.list
page_size

int32

Nombre maximal de ressources à lister.
page_token

string

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

string

Seules les ressources correspondant à ce filtre seront listées.
order_by

string

Spécifie l'ordre dans lequel les ressources seront listées.

ListClustersResponse

Liste des clusters dans un emplacement.

Champs
clusters[]

Cluster

Clusters dans l'emplacement.
next_page_token

string

Jeton permettant de récupérer la page de résultats suivante.
unreachable[]

string

Emplacements inaccessibles.

ListMachinesRequest

Liste les machines d'un site.

Champs
parent

string

Obligatoire. Site parent qui possède cette collection de machines.

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

  • edgecontainer.machines.list
page_size

int32

Nombre maximal de ressources à lister.
page_token

string

Jeton de page reçu d'une requête de liste précédente.
filter

string

Seules les ressources correspondant à ce filtre seront listées.
order_by

string

Spécifie l'ordre dans lequel les ressources seront listées.

ListMachinesResponse

Liste des machines d'un site.

Champs
machines[]

Machine

Machines sur le site.
next_page_token

string

Jeton permettant de récupérer la page de résultats suivante.
unreachable[]

string

Emplacements inaccessibles.

ListNodePoolsRequest

Liste les pools de nœuds d'un cluster.

Champs
parent

string

Obligatoire. Cluster parent qui possède cette collection de pools de nœuds.

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

  • edgecontainer.nodePools.list
page_size

int32

Nombre maximal de ressources à lister.
page_token

string

Jeton de page reçu d'une requête de liste précédente.
filter

string

Seules les ressources correspondant à ce filtre seront listées.
order_by

string

Spécifie l'ordre dans lequel les ressources seront listées.

ListNodePoolsResponse

Liste des pools de nœuds d'un cluster.

Champs
node_pools[]

NodePool

Pools de nœuds dans le cluster.
next_page_token

string

Jeton permettant de récupérer la page de résultats suivante.
unreachable[]

string

Emplacements inaccessibles.

ListVpnConnectionsRequest

Liste les connexions VPN.

Champs
parent

string

Obligatoire. Emplacement parent qui possède cette collection de connexions VPN.

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

  • edgecontainer.vpnConnections.list
page_size

int32

Nombre maximal de ressources à lister.
page_token

string

Jeton de page reçu d'une requête de liste précédente.
filter

string

Seules les ressources correspondant à ce filtre seront listées.
order_by

string

Spécifie l'ordre dans lequel les ressources seront listées.

ListVpnConnectionsResponse

Liste des connexions VPN dans un emplacement.

Champs
vpn_connections[]

VpnConnection

VpnConnections dans l'emplacement.
next_page_token

string

Jeton permettant de récupérer la page de résultats suivante.
unreachable[]

string

Emplacements inaccessibles.

LocationMetadata

Métadonnées d'un google.cloud.location.Location donné.

Champs
available_zones

map<string, ZoneMetadata>

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

string

Obligatoire. Nom de ressource de la machine.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle le pool de nœuds a été créé.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour du pool de nœuds.
labels

map<string, string>

Libellés associés à cette ressource.
hosted_node

string

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

string

Zone Google Distributed Cloud Edge de cette machine.
version

string

Uniquement en sortie. Version logicielle de la machine.
disabled

bool

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

Status

Uniquement en sortie. État actuel de la machine.
purpose

Purpose

Type de cluster pour lequel la machine est utilisée.

Objectif

L'objectif de la machine peut être VIRTUALIZED_WORKLOAD ou BAREMETAL_CLUSTER.

Enums
PURPOSE_UNSPECIFIED Usage non spécifié.
VIRTUALIZED_WORKLOAD La machine est utilisée pour une charge de travail virtuelle.
BAREMETAL_CLUSTER La machine est utilisée pour un cluster d'utilisateur Bare Metal.

État

Indique l'état de la machine.

Enums
STATUS_UNSPECIFIED État inconnu.
READY La machine est prête à héberger un nœud. Il s'agit de l'option par défaut.
DISABLED_FOR_REPAIR La machine a été désactivée pour réparation en ajoutant une ou plusieurs revendications de désactivation.

MaintenanceExclusionWindow

Représente une fenêtre d'exclusion de maintenance.

Champs
window

TimeWindow

Facultatif. Période.
id

string

Facultatif. Identifiant unique (par cluster) de la fenêtre.

MaintenancePolicy

Configuration de la stratégie de maintenance.

Champs
window

MaintenanceWindow

Spécifie la fenêtre de maintenance au cours de laquelle la maintenance peut être effectuée.
maintenance_exclusions[]

MaintenanceExclusionWindow

Facultatif. Exclusions de la maintenance automatique. La maintenance non urgente ne doit pas avoir lieu pendant ces intervalles. Chaque exclusion possède un nom unique et peut être active ou expirée. Le nombre maximal d'exclusions de maintenance autorisées à un moment donné est de trois.

MaintenanceWindow

Configuration de l'intervalle de maintenance

Champs
recurring_window

RecurringTimeWindow

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

string

Obligatoire. Nom de ressource du pool de nœuds.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle le pool de nœuds a été créé.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour du pool de nœuds.
labels

map<string, string>

Libellés associés à cette ressource.
node_location

string

Nom de la zone Google Distributed Cloud Edge dans laquelle ce pool de nœuds sera créé. Exemple : us-central1-edge-customer-a.
node_count

int32

Obligatoire. Nombre de nœuds du pool.
machine_filter

string

Seules les machines correspondant à ce filtre pourront rejoindre le pool de nœuds. Le langage de filtrage accepte des chaînes telles que "name=". Il est décrit plus en détail sur la page AIP-160.
local_disk_encryption

LocalDiskEncryption

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

string

Uniquement en sortie. Version la plus ancienne parmi tous les nœuds de calcul.
node_config

NodeConfig

Facultatif. Configuration de chaque nœud du NodePool

LocalDiskEncryption

Configuration de la compatibilité CMEK pour le chiffrement du disque local de la machine Edge.

Champs
kms_key

string

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

string

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

KmsKeyState

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.KEY_AVAILABLE Cela peut être dû à un manque d'autorisations pour utiliser la clé, ou si la clé est désactivée ou supprimée.
kms_status

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 kms_key_state n'est pas KMS_KEY_STATE_KEY_AVAILABLE. S'il est renseigné, ce champ contient l'état d'erreur signalé par Cloud KMS.
resource_state

ResourceState

Uniquement en sortie. État actuel de la ressource associé à CMEK.

NodeConfig

Configuration de chaque nœud du NodePool

Champs
labels

map<string, string>

Facultatif. Étiquettes des nœuds Kubernetes
node_storage_schema

string

Facultatif. Nom du schéma de stockage des nœuds de calcul.

OperationMetadata

Métadonnées d'opération de longue durée pour les méthodes de l'API Edge Container.

Champs
create_time

Timestamp

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

Timestamp

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

string

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

string

Verbe exécuté par l'opération.
status_message

string

Statut lisible de l'opération, le cas échéant.
requested_cancellation

bool

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

Version de l'API ayant permis de démarrer l'opération.
warnings[]

string

Avertissements qui ne bloquent pas l'opération, mais qui contiennent des informations pertinentes pour l'utilisateur final.
status_reason

StatusReason

État de l'opération lisible par une machine, le cas échéant.

StatusReason

Indique la raison de l'état de l'opération.

Enums
STATUS_REASON_UNSPECIFIED Motif inconnu.
UPGRADE_PAUSED La mise à niveau du cluster est actuellement suspendue.
RETRYABLE_ERROR La requête a généré une erreur, mais il est possible de réessayer.

Quota

Représente le quota pour les ressources Edge Container.

Champs
metric

string

Nom de la métrique de quota.
limit

double

Limite de quota pour cette métrique.
usage

double

Utilisation actuelle de cette métrique.

RecurringTimeWindow

Représente une période arbitraire récurrente.

Champs
window

TimeWindow

Période de la première récurrence.
recurrence

string

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.

ResourceState

Indique si la ressource est en état de verrouillage ou en attente.

Enums
RESOURCE_STATE_UNSPECIFIED Valeur par défaut.
RESOURCE_STATE_LOCK_DOWN La ressource est en état de verrouillage.
RESOURCE_STATE_LOCK_DOWN_PENDING La ressource est en attente de verrouillage.

ServerConfig

Configuration du serveur pour les versions et les canaux de publication compatibles.

Champs
channels

map<string, ChannelConfig>

Uniquement en sortie. Mappage du version disponible à la configuration du canal.
versions[]

Version

Uniquement en sortie. Versions compatibles, par exemple : ["1.4.0", "1.5.0"].
default_version

string

Uniquement en sortie. Version par défaut, par exemple : "1.4.0".
version_rollouts[]

VersionRollout

Uniquement en sortie. Informations sur le déploiement de la configuration du serveur.

TimeWindow

Représente une période arbitraire.

Champs
start_time

Timestamp

Heure de début de la période.
end_time

Timestamp

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

FieldMask

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

Cluster mis à jour.

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

  • edgecontainer.clusters.update
request_id

string

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 request_id est fourni.

UpdateNodePoolRequest

Met à jour un pool de nœuds.

Champs
update_mask

FieldMask

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

NodePool

Pool de nœuds mis à jour.

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

  • edgecontainer.nodePools.update
request_id

string

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 request_id est fourni.

UpgradeClusterRequest

Mise à niveau d'un cluster.

Champs
name

string

Obligatoire. Nom de ressource du cluster.

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

  • edgecontainer.clusters.upgrade
target_version

string

Obligatoire. Version vers laquelle le cluster va être mis à niveau.
schedule

Schedule

Calendrier de la migration.
request_id

string

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 request_id est fourni.

Planification

Représente le calendrier de mise à niveau du cluster.

Enums
SCHEDULE_UNSPECIFIED Non spécifié. La valeur par défaut consiste à mettre à niveau le cluster immédiatement, ce qui est la seule option disponible aujourd'hui.
IMMEDIATELY Le cluster sera mis à niveau immédiatement après réception de la demande.

Version

Version d'un cluster.

Champs
name

string

Uniquement en sortie. Nom de la version. Exemple : "1.4.0".

VersionRollout

VersionRollout contient les informations sur le déploiement de la version.

Champs
version

string

Uniquement en sortie. Version sémantique, par exemple : "1.4.0".
available_zones[]

string

Uniquement en sortie. Liste des zones dans lesquelles la version a été déployée, par exemple : ["us-central1", "us-west1"].

VpnConnection

Une connexion VPN

Champs
name

string

Obligatoire. Nom de ressource de la connexion VPN
create_time

Timestamp

Uniquement en sortie. Heure à laquelle la connexion VPN a été créée.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour de la connexion VPN.
labels

map<string, string>

Libellés associés à cette ressource.
nat_gateway_ip

string

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
(deprecated)

BgpRoutingMode

Mode de routage dynamique du réseau VPC (regional ou global).
cluster

string

Nom canonique du cluster auquel se connecter. Il se présente sous la forme projects/{project}/locations/{location}/clusters/{cluster}.
vpc

string

ID du réseau VPC auquel se connecter.
vpc_project

VpcProject

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

bool

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

string

Facultatif. Nom Cloud Router de la connexion VPN.
details

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

State

État de cette connexion.
error

string

Message d'erreur. Ce champ n'est renseigné que lorsque l'état est "ERROR".
cloud_router

CloudRouter

Informations sur Cloud Router
cloud_vpns[]

CloudVpn

Chaque connexion comporte plusieurs passerelles Cloud VPN.

CloudRouter

Informations sur Cloud Router

Champs
name

string

Nom du routeur Cloud Router associé.

CloudVpn

Informations sur Cloud VPN

Champs
gateway

string

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

string

Projet du VPC auquel se connecter. Si elle n'est pas spécifiée, elle est identique au projet du cluster.
service_account
(deprecated)

string

Facultatif. Obsolète : ne pas utiliser.

ZoneMetadata

Zone Google Distributed Cloud Edge où se trouvent les machines périphériques.

Champs
quota[]

Quota

Quota pour les ressources de cette zone.
rack_types

map<string, RackType>

La carte est indexée par nom de rack et a une valeur RackType.
config_data

ConfigData

Données de configuration de la zone.

RackType

Type de rack.

Enums
RACK_TYPE_UNSPECIFIED Type de rack non spécifié. Les racks uniques appartiennent également à ce type.
BASE Type de rack de base, une paire de deux racks Config-1 modifiés contenant des commutateurs d'agrégation.
EXPANSION Type de rack d'extension, également appelé rack autonome, ajouté par les clients à la demande.