L'API Anthos On-Prem est une API hébergée par Google Cloud qui vous permet de gérer le cycle de vie de vos clusters sur site à l'aide d'outils standards: la console Google Cloud, la Google Cloud CLI ou Terraform. Lorsque vous créez un cluster à l'aide de l'un de ces outils, l'API stocke les métadonnées sur l'état de votre cluster dans la région Google Cloud que vous avez spécifiée lors de la création du cluster.
Ces métadonnées vous permettent de gérer le cycle de vie du cluster à l'aide des outils standards. Si vous souhaitez utiliser ces outils pour afficher les détails d'un cluster ou gérer le cycle de vie des clusters créés à l'aide de bmctl
, vous devez enregistrer les clusters dans l'API Anthos On-Prem.
Terminologie
L'enregistrement d'un cluster vous permet de gérer son cycle de vie à l'aide de la console, de gcloud CLI ou de Terraform.
L'enregistrement d'un cluster est un processus distinct de l'enregistrement d'un cluster dans un parc.
Un parc est un regroupement logique de clusters Kubernetes que vous pouvez gérer ensemble. Tous les clusters GKE sur Bare Metal sont enregistrés dans un parc au moment de la création du cluster. Lorsque vous créez un cluster à l'aide de bmctl, celui-ci est enregistré dans le projet Google Cloud que vous spécifiez dans le champ gkeConnect.projectID
du fichier de configuration du cluster. Ce projet est appelé projet hôte du parc.
Pour en savoir plus sur les parcs, y compris sur les cas d'utilisation, les bonnes pratiques et des exemples, consultez la documentation Gestion de parc.
Afficher les clusters enregistrés
Tous les clusters de votre parc sont affichés sur les pages Clusters GKE Enterprise et Clusters GKE de la console. Cela vous donne un aperçu de l'ensemble de votre parc et, pour GKE sur Bare Metal, vous permet de voir quels clusters sont gérés par l'API Anthos On-Prem.
Pour afficher les clusters de votre parc:
-
Dans la console, accédez à la page des clusters GKE Enterprise.
Accéder à la page des clusters GKE Enterprise -
Sélectionnez le projet Google Cloud.
- Si Anthos (bare metal) s'affiche dans la colonne Type, le cluster est géré par l'API Anthos On-Prem.
- Si Externe s'affiche dans la colonne Type, le cluster n'est pas géré par l'API Anthos On-Prem.
Conditions requises
- Seuls les clusters d'utilisateur et d'administrateur peuvent être enregistrés avec l'API Anthos On-Prem. Il n'est pas possible d'enregistrer des clusters hybrides et autonomes.
- Version 1.13 ou ultérieure
Si votre organisation a configuré une liste d'autorisation qui permet au trafic provenant des API Google et d'autres adresses de transiter par votre serveur proxy, ajoutez ce qui suit à la liste d'autorisation :
- gkeonprem.googleapis.com
- gkeonprem.mtls.googleapis.com
Voici les noms de service de l'API Anthos On-Prem.
Si vous n'êtes pas propriétaire du projet, vous devez au minimum disposer du rôle Identity and Access Management
roles/gkeonprem.admin
sur le projet. Pour en savoir plus sur les autorisations incluses dans ce rôle, consultez la section Rôles GKE On-Prem dans la documentation IAM.
Enregistrer un cluster
Pour enregistrer un cluster à gérer par l'API Anthos On-Prem, procédez comme suit:
Assurez-vous de disposer de la dernière version de gcloud CLI. Si nécessaire, mettez à jour les composants de la gcloud CLI:
gcloud components update
Activez l'API Anthos On-Prem dans le projet hôte de votre parc :
gcloud services enable \ --project FLEET_HOST_PROJECT_ID \ gkeonprem.googleapis.com
Remplacez
FLEET_HOST_PROJECT_ID
par l'ID du projet hôte de votre parc. Il s'agit de l'ID de projet configuré dans la sectiongkeconnect
de votre fichier de configuration de cluster.Enregistrez le cluster avec l'API Anthos On-Prem:
Cluster d'utilisateur
Veillez à faire défiler la page si nécessaire pour remplir l'espace réservé
ADMIN_CLUSTER_NAME
correspondant à l'indicateur--admin-cluster-membership
.gcloud container bare-metal clusters enroll USER_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --admin-cluster-membership=projects/FLEET_HOST_PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=LOCATION
Remplacez les éléments suivants :
USER_CLUSTER_NAME
: nom du cluster d'utilisateur que vous souhaitez enregistrer.FLEET_HOST_PROJECT_ID
: ID du projet hôte de votre parc.ADMIN_CLUSTER_NAME
: cluster d'administrateur qui gère le cluster d'utilisateur. Le nom du cluster d'administrateur est le dernier segment du nom entièrement spécifié du cluster, qui identifie de manière unique le cluster dans Google Cloud.LOCATION
: région Google Cloud dans laquelle l'API Anthos On-Prem s'exécute. Spécifiezus-west1
ou une autre région compatible. La région ne peut plus être modifiée une fois le cluster enregistré. En plus de définir la région d'exécution de l'API Anthos On-Prem, il s'agit de la région dans laquelle les éléments suivants sont stockés:- Métadonnées du cluster d'utilisateur dont l'API Anthos On-Prem a besoin pour gérer le cycle de vie du cluster
- Données Cloud Logging et Cloud Monitoring des composants système
- Journal d'audit d'administrateur créé par Cloud Audit Logs
Cluster d'administrateur
Veillez à faire défiler la page si nécessaire pour remplir l'espace réservé
ADMIN_CLUSTER_NAME
correspondant à l'indicateur--admin-cluster-membership
.gcloud container bare-metal admin-clusters enroll ADMIN_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --admin-cluster-membership=projects/FLEET_HOST_PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=LOCATION
Remplacez les éléments suivants :
ADMIN_CLUSTER_NAME
: nom du cluster d'administrateur que vous souhaitez enregistrer.FLEET_HOST_PROJECT_ID
: ID du projet hôte de votre parc.ADMIN_CLUSTER_NAME
etFLEET_HOST_PROJECT_ID
sont utilisés pour former le nom de cluster complet pour l'option--admin-cluster-membership
.LOCATION
: région Google Cloud dans laquelle l'API Anthos On-Prem s'exécute. Spécifiezus-west1
ou une autre région compatible. La région ne peut plus être modifiée une fois le cluster enregistré. En plus de définir la région d'exécution de l'API Anthos On-Prem, il s'agit de la région dans laquelle les éléments suivants sont stockés:- Métadonnées de cluster dont l'API Anthos On-Prem a besoin pour gérer le cycle de vie du cluster.
- Données Cloud Logging et Cloud Monitoring des composants système
- Journal d'audit d'administrateur créé par Cloud Audit Logs
Une fois le cluster enregistré, vous pouvez utiliser les commandes suivantes pour obtenir des informations sur vos clusters:
Cluster d'utilisateur
- Pour décrire un cluster d'utilisateur:
gcloud container bare-metal clusters describe USER_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --location=LOCATION
- Pour répertorier vos clusters d'utilisateur, procédez comme suit:
gcloud container bare-metal clusters list \ --project=FLEET_HOST_PROJECT_ID \ --location=-
Lorsque vous définissez
--location=-
, cela signifie que tous les clusters de toutes les régions sont répertoriés. Si vous devez limiter le champ d'application de la liste, définissez--location
sur la région que vous avez spécifiée lors de l'enregistrement du cluster.Cluster d'administrateur
- Pour décrire un cluster d'administrateur:
gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --location=LOCATION
- Pour répertorier vos clusters d'administrateur:
gcloud container bare-metal admin-clusters list \ --project=FLEET_HOST_PROJECT_ID \ --location=-
Lorsque vous définissez
--location=-
, cela signifie que tous les clusters de toutes les régions sont répertoriés. Si vous devez limiter le champ d'application de la liste, définissez--location
sur la région que vous avez spécifiée lors de l'enregistrement du cluster.
Se connecter au cluster
Une fois le cluster enregistré avec l'API Anthos On-Prem, vous devez choisir et configurer une méthode d'authentification afin de pouvoir gérer le cluster à partir de la console Google Cloud. La méthode d'authentification que vous sélectionnez contrôle également l'accès au cluster à partir de la ligne de commande. Pour en savoir plus, consultez les ressources suivantes :