Étape 9 : Installer un environnement d'exécution hybride

Vous consultez actuellement la version 1.10 de la documentation d'Apigee hybrid. Pour en savoir plus, consultez la section Versions compatibles.

Version 1.10 

   Versions compatibles :

• v1.13 (la plus récente)
• v1.12
• v1.11                         
• Liste des versions compatibles

   Versions non compatibles :

• v1.10
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Appliquer la configuration au cluster

Pour installer Apigee hybrid sur votre cluster, procédez comme suit :

1. Vérifiez que vous êtes bien dans le répertoire hybrid-base-directory/hybrid-files.

   cd $HYBRID_FILES

   Remarque : Comme le fichier de remplacement spécifie les fichiers de compte de service à l'aide de chemins relatifs à votre répertoire hybrid-base-directory/hybrid-files, vous devez exécuter les commandes à partir de ce répertoire.
2. Vérifiez que kubectl est défini sur le bon contexte à l'aide de la commande suivante. Le contexte actuel doit être défini sur le cluster au sein duquel vous déployez Apigee hybrid.

   kubectl config current-context

   Le résultat doit inclure le nom du cluster dans lequel vous déployez Apigee hybrid. Par exemple, sur GKE, le nom du contexte se présente généralement au format gke_project-id_cluster-location_cluster-name, comme suit :

   gke_my-project_us-central1_my-cluster

   Si le nom du cluster ne correspond pas dans le contexte, la commande suivante récupère les identifiants gcloud du cluster et définit le contexte kubectl :

   Clusters régionaux

   gcloud container clusters get-credentials $CLUSTER_NAME \
   --region $CLUSTER_LOCATION \
   --project $PROJECT_ID

   Cluster zonal

   gcloud container clusters get-credentials $CLUSTER_NAME \
   --zone $CLUSTER_LOCATION \
   --project $PROJECT_ID

3. Pour les plates-formes Anthos sur solution Bare Metal, AWS sur GKE, EKS et GKE on Prem uniquement, vérifiez que la variable KUBECONFIG est définie à l'aide de la commande suivante.

   echo ${KUBECONFIG}

4. Effectuez une simulation d'initialisation. L'exécution d'une simulation vous permet de rechercher les erreurs éventuelles avant que des modifications ne soient apportées au cluster. Exécutez la commande init avec l'option --dry-run comme suit :

   ${APIGEECTL_HOME}/apigeectl init -f overrides/overrides.yaml --dry-run=client

5. Si aucune erreur ne s'affiche, exécutez la commande init comme suit :

   ${APIGEECTL_HOME}/apigeectl init -f overrides/overrides.yaml

   La commande init installe les services de déploiement Apigee, le contrôleur de déploiement Apigee ainsi que le webhook d'admission Apigee.

6. Pour vérifier l'état du déploiement, vous pouvez exécuter les commandes suivantes :

   ${APIGEECTL_HOME}/apigeectl check-ready -f overrides/overrides.yaml

   kubectl get pods -n apigee-system

   kubectl get pods -n apigee

   Lorsque les pods sont prêts, passez à l'étape suivante.

7. Effectuez une simulation d'intallation. Exécutez la commande apply avec l'option --dry-run.

   ${APIGEECTL_HOME}/apigeectl apply -f overrides/overrides.yaml --dry-run=client

8. Si aucune erreur ne s'affiche, vous pouvez appliquer les composants d'exécution spécifiques à Apigee au cluster à l'aide de la commande suivante :

   ${APIGEECTL_HOME}/apigeectl apply -f overrides/overrides.yaml

9. Pour vérifier l'état du déploiement, exécutez la commande suivante :

   ${APIGEECTL_HOME}/apigeectl check-ready -f overrides/overrides.yaml

   Répétez cette étape jusqu'à ce que tous les pods soient prêts. Le démarrage des pods peut prendre plusieurs minutes.

   Remarque : Si vous configurez votre fichier de remplacement pour utiliser Workload Identity sur GKE, une erreur peut indiquer que apigeeenvironment n'est pas en cours d'exécution. Passez aux étapes de la section suivante. check-ready affiche votre environnement Apigee en cours d'exécution une fois la procédure d'activation de Workload Identity terminée.

GKE avec Workload Identity

Pour les installations Apigee hybrid sur GKE, Google Cloud propose une option appelée Workload Identity pour authentifier les composants d'exécution hybrides.

Remarque : Apigee hybrid v.1.10 n'est compatible qu'avec la fédération d'identité de charge de travail sur GKE.

Comptes de service Google Cloud et comptes de service Kubernetes

Un compte de service Google Cloud est un type particulier de compte qui peut être utilisé pour effectuer des appels d'API autorisés en s'authentifiant en tant que compte de service. Les comptes de service Google Cloud peuvent disposer de rôles et d'autorisations semblables à ceux d'un utilisateur individuel. Lorsqu'une application s'authentifie en tant que compte de service, elle a accès à toutes les ressources auxquelles le compte de service est autorisé à accéder. Pour en savoir plus sur les comptes de service Google Cloud, consultez la présentation des comptes de service.

Vous avez créé des comptes de service Google Cloud pour votre installation Apigee hybride à l'étape 4 : Créer des comptes de service. Apigee utilise ces comptes de service pour authentifier les composants hybrides.

Les comptes de service Kubernetes sont semblables aux comptes de service Google Cloud. Un compte de service Kubernetes fournit une identité pour les processus exécutés dans un pod et lui permet de s'authentifier auprès du serveur d'API de la même manière qu'un utilisateur. Si vous souhaitez en savoir plus sur les comptes de service Kubernetes, consultez la section Configurer les comptes de service pour les pods.

L'outil apigeectl a créé la plupart des comptes de service Kubernetes requis par Apigee hybrid lors de l'exécution de apigeectl apply à la procédure précédente.

Lorsque vous configurez Workload Identity sur GKE, vous associez les comptes de service Google Cloud aux comptes de service Kubernetes dans le cluster Kubernetes. De cette manière, les comptes de service Kubernetes peuvent emprunter l'identité des comptes de service Google Cloud et utiliser les rôles et autorisations qui leur ont été attribués pour s'authentifier auprès des composants hybrides.

Suivez ces instructions pour configurer Workload Identity pour votre projet.

Préparer la configuration de Workload Identity

Ces procédures utilisent les variables d'environnement suivantes. Vérifiez qu'elles sont définies et définissez celles qui ne le sont pas :

echo $APIGEECTL_HOME
echo $CLUSTER_LOCATION
echo $ENV_NAME
echo $HYBRID_FILES
echo $NAMESPACE
echo $PROJECT_ID
echo $ORG_NAME

1. Vérifiez que la configuration gcloud actuelle est définie sur l'ID de votre projet Google Cloud à l'aide de la commande suivante :

   gcloud config get project

Si nécessaire, définissez la configuration gcloud actuelle :

gcloud config set project $PROJECT_ID

2. Créez le compte de service Kubernetes apigee-cassandra-restore.

   Lorsque vous avez appliqué votre configuration en exécutant apigeectl apply, la commande a créé la plupart des comptes de service Kubernetes nécessaires pour Workload Identity.

   Pour créer le compte de service Kubernetes apigee-cassandra-restore, exécutez apigeectl apply avec l'option --restore :

   $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/overrides.yaml --restore

3. Vérifiez que Workload Identity est activé dans votre cluster GKE. Lorsque vous avez créé le cluster à l'étape 1 : Créer un cluster, l'étape 11 consistait à activer Workload Identity. Vous pouvez vérifier si Workload Identity est activé en exécutant la commande suivante :

   Clusters régionaux

   gcloud container clusters describe $CLUSTER_NAME \
     --region $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten 'workloadIdentityConfig'

   Cluster zonal

   gcloud container clusters describe $CLUSTER_NAME \
     --zone $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten 'workloadIdentityConfig'

   Le résultat doit se présenter sous la forme suivante :

     ---
     workloadPool: PROJECT_ID.svc.id.goog

   Si null s'affiche dans vos résultats, exécutez la commande suivante pour activer Workload Identity dans votre cluster :

   Clusters régionaux

   gcloud container clusters update $CLUSTER_NAME \
     --workload-pool=$PROJECT_ID.svc.id.goog \
     --project $PROJECT_ID \
     --region $CLUSTER_LOCATION

   Cluster zonal

   gcloud container clusters update  $CLUSTER_NAME \
     --workload-pool=$PROJECT_ID.svc.id.goog \
     --zone $CLUSTER_LOCATION \
     --project $PROJECT_ID

4. Activez Workload Identity pour chaque pool de nœuds à l'aide des commandes suivantes. Cette opération peut prendre jusqu'à 30 minutes pour chaque nœud :

   Clusters régionaux

   gcloud container node-pools update NODE_POOL_NAME \
     --cluster=$CLUSTER_NAME \
     --region $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --workload-metadata=GKE_METADATA

   Cluster zonal

   gcloud container node-pools update NODE_POOL_NAME \
     --cluster=$CLUSTER_NAME \
     --zone $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --workload-metadata=GKE_METADATA

   Où NODE_POOL_NAME est le nom de chaque pool de nœuds. Dans la plupart des installations Apigee hybrid, les deux pools de nœuds par défaut sont nommés apigee-data et apigee-runtime.

5. Vérifiez que Workload Identity est activé sur vos pools de nœuds à l'aide des commandes suivantes :

   Clusters régionaux

   gcloud container node-pools describe apigee-data \
     --cluster $CLUSTER_NAME \
     --region $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten "config:"

   gcloud container node-pools describe apigee-runtime \
     --cluster $CLUSTER_NAME \
     --region $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten "config:"

   Cluster zonal

   gcloud container node-pools describe apigee-data \
     --cluster $CLUSTER_NAME \
     --zone $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten "config:"

   gcloud container node-pools describe apigee-runtime \
     --cluster $CLUSTER_NAME \
     --zone $CLUSTER_LOCATION \
     --project $PROJECT_ID \
     --flatten "config:"

   Le résultat doit se présenter sous la forme suivante :

   ---
   diskSizeGb: 100
   diskType: pd-standard
   ...
   workloadMetadataConfig:
     mode: GKE_METADATA
       

6. Obtenez la liste des noms des comptes de service Google Cloud de votre projet. Vous aurez besoin de ces noms pour associer les comptes de service Kubernetes afin de configurer Workload Identity. Pour les installations hors production, il ne doit y avoir qu'un seul compte de service Google. Pour les installations en production, il doit y en avoir huit.

   Utilisez la commande suivante pour obtenir la liste des noms :

   gcloud iam service-accounts list --project $PROJECT_ID

   Le résultat doit se présenter sous la forme suivante :

   Hors production

   Pour les environnements hors production :

   DISPLAY NAME         EMAIL                                                      DISABLED
   apigee-non-prod      apigee-non-prod@my_project_id.iam.gserviceaccount.com      False
   

   Production

   Pour les environnements hors production :

   DISPLAY NAME         EMAIL                                                      DISABLED
   apigee-cassandra     apigee-cassandra@my_project_id.iam.gserviceaccount.com     False
   apigee-logger        apigee-logger@my_project_id.iam.gserviceaccount.com        False
   apigee-mart          apigee-mart@my_project_id.iam.gserviceaccount.com          False
   apigee-metrics       apigee-metrics@my_project_id.iam.gserviceaccount.com       False
   apigee-runtime       apigee-runtime@my_project_id.iam.gserviceaccount.com       False
   apigee-synchronizer  apigee-synchronizer@my_project_id.iam.gserviceaccount.com  False
   apigee-udca          apigee-udca@my_project_id.iam.gserviceaccount.com          False
   apigee-watcher       apigee-watcher@my_project_id.iam.gserviceaccount.com       False
   

   Conseil : Si les noms personnalisés de vos comptes de service ne correspondent pas facilement aux noms des composants Apigee, vous pouvez déterminer le rôle de chaque compte de service en vérifiant les rôles qui leur sont attribués et en les comparant aux rôles recommandés dans À propos des comptes de service.

   Exécutez la commande suivante pour vérifier les rôles attribués à un compte de service :

   gcloud projects get-iam-policy ${PROJECT_ID}  \
     --flatten="bindings[].members" \
     --format='table(bindings.role)' \
     --filter="SERVICE_ACCOUNT_NAME"

7. Obtenez la liste des noms des comptes de service Kubernetes. Vous aurez besoin de cette liste de noms pour associer vos comptes de service Google Cloud ultérieurement dans cette procédure. Exécutez la commande suivante :

   kubectl get sa -n $NAMESPACE

   La sortie doit se présenter sous la forme suivante. Les comptes de service Kubernetes en gras sont ceux que vous devrez associer avec vos comptes de service Google :

   NAME                                                         SECRETS   AGE
   apigee-cassandra-backup                                      1         11m
   apigee-cassandra-restore                                     1         11m
   apigee-cassandra-schema-setup-my-project-id-123abcd-sa       1         11m
   apigee-cassandra-schema-val-my-project-id-123abcd            1         11m
   apigee-cassandra-user-setup-my-project-id-123abcd-sa         1         11m
   apigee-connect-agent-my-project-id-123abcd-sa                1         11m
   apigee-datastore-default-sa                                  1         11m
   apigee-ingressgateway                                        1         11m
   apigee-ingressgateway-my-project-id-123abcd                  1         11m
   apigee-ingressgateway-manager                                1         11m
   apigee-init                                                  1         11m
   apigee-mart-my-project-id-123abcd-sa                         1         11m
   apigee-metrics-sa                                            1         11m
   apigee-mint-task-scheduler-my-project-id-123abcd-sa          1         11m
   apigee-redis-default-sa                                      1         11m
   apigee-redis-envoy-default-sa                                1         11m
   apigee-runtime-my-project-id-env-name-234bcde-sa             1         11m
   apigee-synchronizer-my-project-id-env-name-234bcde-sa        1         11m
   apigee-udca-my-project-id-123abcd-sa                         1         11m
   apigee-udca-my-project-id-env-name-234bcde-sa                1         11m
   apigee-watcher-my-project-id-123abcd-sa                      1         11m
   default                                                      1         11m
       

Configurer Workload Identity

Procédez comme suit pour activer Workload Identity pour votre installation hybride :

1. Pour chaque composant Apigee, annotez les comptes de service Kubernetes correspondants avec le compte de service Google du composant.
   IMPORTANT : Si les noms de vos comptes de service ne correspondent pas aux noms par défaut créés par create-service-account, remplacez le nom du compte de service en rouge par le nom de compte de service approprié pour le composant dans les commandes suivantes. Par exemple, si le compte de service Cassandra s'appelle my-cassandra-accnt-1, remplacez apigee-cassandra par ce nom dans la commande.

   Les étapes suivantes utilisent deux variables d'environnement. Vous allez réinitialiser les valeurs de ces variables avant chaque ensemble de commandes :

   • GSA_NAME : nom d'un compte de service Google. Il s'agit des comptes de service que vous avez créés avec l'outil create-service-account à l'étape 4 : Créer des comptes de service.
   • KSA_NAME : nom d'un compte de service Kubernetes. Il s'agit des comptes que vous avez répertoriés ci-dessus en exécutant la commande kubectl get sa -n $NAMESPACE (par exemple, apigee-cassandra-schema-setup-hybrid-example-project-123abcd-sa).
   Conseil : Si vous rencontrez une erreur indiquant que le compte de service est "Introuvable", essayez d'exécuter gcloud init pour définir la configuration actuelle sur l'ID de projet Google Cloud et l'emplacement de cluster appropriés.
• Cassandra

  Configurez Workload Identity pour le composant Cassandra.

  Le composant Cassandra est associé à six comptes de service Kubernetes :

  • apigee-cassandra-backup
  • apigee-cassandra-restore
  • apigee-cassandra-schema-setup
  • apigee-cassandra-schema-val (val = validation)
  • apigee-cassandra-user-setup
  • apigee-datastore-default

  Hors production

  Configurer le compte de service Kubernetes apigee-cassandra-backup

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-non-prod"
     KSA_NAME="apigee-cassandra-backup"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

     La sortie doit comporter une ligne décrivant l'annotation, semblable à ceci :

     Annotations:         iam.gke.io/gcp-service-account: [e-mail]

  Configurer le compte de service Kubernetes apigee-cassandra-restore

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-restore"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-schema-setup

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-schema-setup-service-account-name-sa"

     Exemple : apigee-cassandra-schema-setup-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-schema-val

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-schema-val-service-account-name"

     Exemple : apigee-cassandra-schema-val-hybrid-example-project-123abcd
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-user-setup

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-user-setup-service-account-name-sa"

     Exemple : apigee-cassandra-user-setup-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-datastore-default-sa

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-datastore-default-sa"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  Configurer le compte de service Kubernetes apigee-cassandra-backup

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-cassandra"
     KSA_NAME="apigee-cassandra-backup"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  La sortie doit comporter une ligne décrivant l'annotation, semblable à ceci :

  Annotations:         iam.gke.io/gcp-service-account: [e-mail]

  5. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-restore

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-restore"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  Configurer le compte de service Kubernetes apigee-cassandra-schema-setup

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-schema-setup-service-account-name-sa"

     Exemple : apigee-cassandra-schema-setup-hybrid-example-project-123abcd-sa

  Liez le rôle IAM :

  gcloud iam service-accounts add-iam-policy-binding \
    --role roles/iam.workloadIdentityUser \
    --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
    $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
    --project $PROJECT_ID

  2. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  3. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-schema-val

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-schema-val-service-account-name"

     Exemple : apigee-cassandra-schema-val-hybrid-example-project-123abcd
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-cassandra-user-setup

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-cassandra-user-setup-service-account-name-sa"

     Exemple : apigee-cassandra-user-setup-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Configurer le compte de service Kubernetes apigee-datastore-default-sa

  1. Redéfinissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-datastore-default-sa"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• Apigee Connect

  Configurer Workload Identity pour le composant Apigee Connect.

  Hors production

  1. Définissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-connect-agent-service-account-name-sa"

     Exemple : apigee-connect-agent-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-mart"
     KSA_NAME="apigee-connect-agent-service-account-name-sa"

     Exemple : apigee-connect-agent-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• MART

  Configurez Workload Identity pour le composant MART.

  Hors production

  1. Définissez la variable d'environnement KSA_NAME :

     KSA_NAME="apigee-mart-service-account-name-sa"

     Exemple : apigee-mart-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-mart"
     KSA_NAME="apigee-mart-service-account-name-sa"

     Exemple : apigee-mart-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• Métriques Apigee

  Configurer Workload Identity pour le composant de métriques Apigee.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-metrics-sa"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-metrics"
     KSA_NAME="apigee-metrics-sa"

  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
     --role roles/iam.workloadIdentityUser \
     --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
     $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
     --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
     --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• UDCA (au niveau de l'organisation)

  Configurez Workload Identity pour le composant UDCA au niveau de l'organisation.

  L'UDCA est implémenté dans les champs d'application au niveau de l'organisation et de l'environnement. Par conséquent, il existe deux comptes de service Kubernetes distincts pour l'UDCA, un pour chaque champ d'application. Vous pouvez les distinguer grâce au nom du compte. Le compte de champ d'application de l'environnement inclut le nom de l'environnement dans le nom du compte de service. Exemple :

  • Au niveau de l'organisation : apigee-udca-my-project-id-123abcd-sa, où my-project-id est l'ID du projet.
  • Au niveau de l'environnement : apigee-udca-my-project-id-my-env-234bcde-sa, où my-env est le nom de l'environnement.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-udca-service-account-name-sa"

     Exemple : apigee-udca-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

       gcloud iam service-accounts add-iam-policy-binding \
         --role roles/iam.workloadIdentityUser \
         --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
         $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
         --project $PROJECT_ID

  3. Annotez le compte de service :

       kubectl annotate serviceaccount \
         --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-udca"
     KSA_NAME="apigee-udca-service-account-name-sa"

     Exemple : apigee-udca-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• Apigee Watcher

  Configurer Workload Identity pour le composant Apigee Watcher.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-watcher-service-account-name-sa"

     Exemple : apigee-watcher-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-watcher"
     KSA_NAME="apigee-watcher-service-account-name-sa"

     Exemple : apigee-watcher-hybrid-example-project-123abcd-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• Environnement d'exécution

  Configurer Workload Identity pour le composant d'environnement d'exécution Apigee.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-runtime-env-level-service-account-name-sa"

     Exemple : apigee-runtime-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-runtime"
     KSA_NAME="apigee-runtime-env-level-service-account-name-sa"

     Exemple : apigee-runtime-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• Synchronisateur

  Configurez Workload Identity pour le composant Synchronisateur.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-synchronizer-env-level-service-account-name-sa"

     Exemple : apigee-synchronizer-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-synchronizer"
     KSA_NAME="apigee-synchronizer-env-level-service-account-name-sa"

     Exemple : apigee-synchronizer-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

• UDCA (au niveau de l'environnement)

  Configurez Workload Identity pour le composant UDCA au niveau de l'environnement.

  Hors production

  1. Définissez les variables d'environnement KSA_NAME :

     KSA_NAME="apigee-udca-env-level-service-account-name-sa"

     Exemple : apigee-udca-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

  Production

  1. Définissez les variables d'environnement KSA_NAME et GSA_NAME :

     GSA_NAME="apigee-udca"
     KSA_NAME="apigee-udca-env-level-service-account-name-sa"

     Exemple : apigee-udca-hybrid-example-project-example-env-234bcde-sa
  2. Liez le rôle IAM :

     gcloud iam service-accounts add-iam-policy-binding \
       --role roles/iam.workloadIdentityUser \
       --member "serviceAccount:$PROJECT_ID.svc.id.goog[$NAMESPACE/$KSA_NAME]" \
       $GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com \
       --project $PROJECT_ID

  3. Annotez le compte de service :

     kubectl annotate serviceaccount \
       --namespace $NAMESPACE $KSA_NAME iam.gke.io/gcp-service-account=$GSA_NAME@$PROJECT_ID.iam.gserviceaccount.com

  4. Vérifiez l'annotation :

     kubectl describe serviceaccount \
       --namespace $NAMESPACE $KSA_NAME

2. Facultatif : Supprimez tous les fichiers de clé de compte de service téléchargés.

   Si vous avez créé les comptes de service Google avec l'outil create-service-account, celui-ci a peut-être créé des clés de compte de service et téléchargé les fichiers de clés .json. Lorsque vous utilisez Workload Identity sur GKE, vous n'avez pas besoin de ces fichiers de clés.

   Vous pouvez supprimer les fichiers de clé à l'aide de la commande suivante :

   rm $HYBRID_FILES/service-accounts/*.json

Vérifier Workload Identity

1. (Facultatif) Vous pouvez consulter l'état de vos comptes de service Kubernetes sur la page Kubernetes : présentation des charges de travail de la console Google Cloud.

   Accéder à la page Charges de travail

   Remarque : Il est possible qu'un état d'erreur s'affiche pour les comptes de service apigee-cassandra-backup et apigee-cassandra-restore. En effet, vous n'effectuez pas de sauvegarde ni de restauration, et ces processus n'ont pas encore été entièrement configurés. Pour en savoir plus sur la sauvegarde et la restauration Cassandra, consultez la page Présentation de la sauvegarde feedbackCassandra.
2. Pour vérifier à nouveau l'état du déploiement à l'aide de apigeectl check-ready, procédez comme suit :

   ${APIGEECTL_HOME}/apigeectl check-ready -f ${HYBRID_FILES}/overrides/overrides.yaml

Félicitations !

Vous avez installé et configuré le plan d'exécution Apigee hybrid. À l'étape suivante, vous allez configurer la passerelle d'entrée Apigee.

1 2 3 4 5 6 7 8 9 (SUIVANT) Étape 10 : Exposer Apigee Ingress 11