Configurer un cluster d'utilisateur pour qu'il soit géré par l'API GKE On-Prem

L'API GKE On-Prem vous permet de gérer le cycle de vie des clusters sur site à l'aide de la consoleGoogle Cloud , de Google Cloud CLI ou de Terraform. Lorsque vous créez un cluster avec ces outils, l'API stocke les métadonnées du cluster dans la région Google Cloudde votre choix. Si vous créez des clusters avec bmctl, vous devez les enregistrer dans l'API GKE On-Prem pour afficher les détails et gérer leur cycle de vie via ces interfaces.

L'inscription d'un cluster est un processus distinct de l'enregistrement d'un cluster dans un parc. Tous les clusters Google Distributed Cloud s'enregistrent automatiquement dans un projet hôte de parc lors de leur création. Dans la console Google Cloud , les clusters enregistrés gérés par l'API GKE On-Prem s'affichent sous la forme Bare Metal dans la colonne Type, tandis que les clusters non enregistrés s'affichent sous la forme Externe.

Conditions requises

  • Seuls les clusters utilisateur et administrateur peuvent être inscrits à l'API GKE On-Prem. L'enregistrement de clusters hybrides et autonomes n'est pas prise en charge.
  • Version 1.13 ou ultérieure

  • L'enregistrement de clusters d'utilisateur créés sous des espaces de noms personnalisés n'est pas possible. Le fichier de configuration du cluster d'utilisateur généré utilise l'espace de noms de cluster par défaut au format cluster-CLUSTER_NAME. Si vous modifiez l'espace de noms lors de la création du cluster, les tentatives d'enregistrement du cluster auprès de l'API GKE On-Prem sont bloquées.

  • Si vous n'êtes pas propriétaire du projet, vous devez disposer au minimum du rôle Identity and Access Management roles/gkeonprem.admin pour 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.

Avant de commencer

  1. Configurez gcloud CLI, si nécessaire.

    1. Si vous devez installer gcloud CLI, consultez la documentation de gcloud CLI. Mettez à jour les composants de gcloud CLI, si nécessaire :

      gcloud components update

  2. Pour activer et utiliser l'API GKE On-Prem, procédez comme suit :

    1. Activez l'API dans votre projet:

      gcloud services enable \
    --project PROJECT_ID \
    gkeonprem.googleapis.com

      Remplacez PROJECT_ID par l'ID de votre projet hôte de parc. Il s'agit de l'ID de projet configuré dans la section gkeconnect de votre fichier de configuration de cluster.

      Si une erreur PERMISSION_DENIED s'affiche, vérifiez l'ID de projet que vous avez saisi. Si l'ID du projet est correct, exécutez gcloud auth login pour vous connecter à gcloud CLI avec le compte ayant accès au projet.

    2. Si c'est la première fois que vous activez l'API GKE On-Prem dans votre projet, vous devez initialiser l'API. Pour ce faire, appelez une commande de la gcloud CLI qui affiche les versions disponibles que vous pouvez utiliser pour créer un cluster :

      gcloud container bare-metal clusters query-version-config \
    --project=PROJECT_ID \
    --location=REGION

      Remplacez REGION par us-west1 ou une autre région compatible.

  3. 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 GKE On-Prem.

Enregistrer un cluster d'utilisateur

gcloud CLI

  1. Répertoriez les appartenances au parc des clusters enregistrés :

    gcloud container fleet memberships list \
    --project=PROJECT_ID

    Remplacez PROJECT_ID par l'ID de votre projet hôte de parc.

    Notez la région dans laquelle le cluster d'administrateur qui gère le cluster d'utilisateur est membre, car vous en aurez besoin à l'étape suivante.

  2. Enregistrez le cluster dans l'API GKE On-Prem :

    gcloud container bare-metal clusters enroll USER_CLUSTER_NAME  \
    --project=PROJECT_ID \
    --admin-cluster-membership=projects/PROJECT_ID/locations/MEMBERSHIP_REGION/memberships/ADMIN_CLUSTER_NAME \
    --location=REGION

    Remplacez les éléments suivants :

    • USER_CLUSTER_NAME : nom du cluster d'utilisateur que vous souhaitez enregistrer.

    • PROJECT_ID : ID du projet hôte de votre parc.

    • MEMBERSHIP_REGION : région dans laquelle se trouve le cluster d'administrateur qui gère le cluster d'utilisateur. Il peut s'agir de global ou d'une région Google Cloud .

    • ADMIN_CLUSTER_NAME : nom du cluster d'administrateur qui gère le cluster d'utilisateur.

      ADMIN_CLUSTER_NAME, MEMBERSHIP_REGION et PROJECT_ID forment le nom de cluster entièrement spécifié pour l'option --admin-cluster-membership.

    • REGION : région Google Cloud dans laquelle l'API GKE On-Prem s'exécute et stocke les métadonnées du cluster. Spécifiez us-west1 ou une autre région prise en charge. Une fois le cluster inscrit, la région ne peut plus être modifiée.

bmctl

Procédez comme suit sur votre poste de travail administrateur.

  1. Ajoutez la section suivante au fichier de configuration du cluster d'administrateur :

    gkeOnPremAPI:
  enabled: true
  location: REGION

    Remplacez REGION par la région Google Cloud dans laquelle l'API GKE On-Prem s'exécute et stocke les métadonnées du cluster. Spécifiez us-west1 ou une autre région prise en charge. Une fois le cluster enregistré, la région ne peut plus être modifiée.

  2. Mettez à jour le cluster :

    bmctl update cluster -c USER_CLUSTER_NAME \
  --kubeconfig ADMIN_CLUSTER_KUBECONFIG

    Remplacez les éléments suivants :

    • USER_CLUSTER_NAME : nom du cluster d'utilisateur à mettre à jour.

    • ADMIN_CLUSTER_KUBECONFIG : chemin d'accès au fichier kubeconfig du cluster d'administrateur

Enregistrer un cluster d'administrateur

gcloud CLI

  1. Répertoriez les appartenances au parc des clusters enregistrés :

    gcloud container fleet memberships list \
    --project=PROJECT_ID

    Remplacez PROJECT_ID par l'ID de votre projet hôte de parc.

    Notez la région dans laquelle le cluster d'administrateur est membre, car vous en aurez besoin à l'étape suivante.

  2. Enregistrez le cluster d'administrateur dans l'API GKE On-Prem :

    gcloud container bare-metal admin-clusters enroll ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID  \
    --admin-cluster-membership=projects/PROJECT_ID /locations/MEMBERSHIP_REGION /memberships/ADMIN_CLUSTER_NAME  \
    --location=REGION

Remplacez les éléments suivants :

  • ADMIN_CLUSTER_NAME : nom du cluster d'administrateur que vous souhaitez enregistrer.

  • PROJECT_ID : ID de votre projet hôte de parc.

  • MEMBERSHIP_REGION : région dans laquelle le cluster d'administrateur est membre. Il peut s'agir de global ou d'une région Google Cloud .

    ADMIN_CLUSTER_NAME, MEMBERSHIP_REGION et PROJECT_ID forment le nom de cluster entièrement spécifié pour l'option --admin-cluster-membership.

  • REGION : région Google Cloud dans laquelle l'API GKE On-Prem s'exécute et stocke les métadonnées du cluster. Spécifiez us-west1 ou une autre région prise en charge. Une fois le cluster inscrit, la région ne peut plus être modifiée.

bmctl

Procédez comme suit sur votre poste de travail administrateur.

  1. Ajoutez la section suivante au fichier de configuration du cluster d'administrateur :

    gkeOnPremAPI:
  enabled: true
  location: REGION

    Remplacez REGION par la région Google Cloud dans laquelle l'API GKE On-Prem s'exécute et stocke les métadonnées du cluster. Spécifiez us-west1 ou une autre région prise en charge. Une fois le cluster enregistré, la région ne peut plus être modifiée.

  2. Mettez à jour le cluster :

    bmctl update cluster -c ADMIN_CLUSTER_NAME \
--kubeconfig ADMIN_CLUSTER_KUBECONFIG

    Remplacez les éléments suivants :

    • ADMIN_CLUSTER_NAME : nom du cluster d'administrateur à mettre à jour.

    • ADMIN_CLUSTER_KUBECONFIG : chemin d'accès au fichier kubeconfig du cluster d'administrateur

Afficher les clusters enregistrés

Tous vos clusters de parc s'affichent sur les pages Clusters GKE de la console. Vous obtenez ainsi une vue d'ensemble de votre parc et, pour Google Distributed Cloud, vous pouvez voir quels clusters sont gérés par l'API GKE On-Prem.

Pour afficher les clusters de votre parc, procédez comme suit :

  1. Dans la console, accédez à la page Clusters GKE.
    Accéder aux clusters GKE
  2. Sélectionnez le projet Google Cloud .
    • Si la mention Bare metal s'affiche dans la colonne Type, le cluster est géré par l'API GKE On-Prem.
    • Si la valeur Externe s'affiche dans la colonne Type, cela signifie que le cluster n'est pas géré par l'API GKE On-Prem.

Obtenir des informations sur votre cluster

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'utilisateurs:
gcloud container bare-metal clusters describe USER_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION
  • Pour afficher vos clusters d'utilisateurs:
gcloud container bare-metal clusters list \
    --project=PROJECT_ID \
    --location=-

Lorsque vous définissez --location=-, cela signifie que vous souhaitez lister tous les clusters de toutes les régions. Si vous devez limiter la liste, définissez --location sur la région que vous avez spécifiée lorsque vous avez inscrit le cluster.

Cluster d'administrateur

  • Pour décrire un cluster d'administrateur:
gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION
  • Pour afficher la liste de vos clusters d'administration:
gcloud container bare-metal admin-clusters list \
    --project=PROJECT_ID \
    --location=-

Lorsque vous définissez --location=-, cela signifie que vous souhaitez lister tous les clusters de toutes les régions. Si vous devez limiter la liste, définissez --location sur la région que vous avez spécifiée lorsque vous avez enregistré le cluster.

Se connecter au cluster

Une fois le cluster enregistré auprès de l'API GKE On-Prem, vous devez choisir et configurer une méthode d'authentification pour 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 :