create-service-account

Présentation de create-service-account

create-service-account est un outil de ligne de commande fourni avec Apigee hybrid qui crée des comptes de service Google Cloud avec des rôles permettant à des composants Apigee hybrid individuels d'effectuer des appels d'API autorisés et de télécharger les fichiers de clé de compte de service associés. Vous pouvez utiliser les fichiers de clé de compte de service générés par cette commande dans votre fichier de remplacement de configuration.

create-service-account crée un ou plusieurs comptes de service dans votre projet Google Cloud actuel ou dans le projet que vous spécifiez, attribue le rôle IAM approprié au compte de service, et télécharge le fichier de certificat dans un répertoire de votre ordinateur local.

Pour en savoir plus sur les comptes de service et obtenir la liste complète des comptes de service recommandés pour les environnements de production, consultez les pages suivantes :

Vous pouvez également créer des comptes de service dans la console Google Cloud . Consultez également Créer et gérer des comptes de service.

Prérequis

Rôle

L'outil create-service-account nécessite que la CLI gcloud soit installée. Les utilisateurs appelant l'utilitaire doivent disposer du rôle Service Account Admin.

Projet

Les comptes de service sont liés à un projet Google Cloud spécifique. create-service-account crée des comptes de service dans votre projet actuel ou dans le projet que vous spécifiez, et lie les rôles IAM aux comptes de service utilisés dans ce projet. create-service-account utilise également l'ID de projet dans le nom et l'adresse e-mail du fichier de clé du compte de service. Par exemple, si votre projet s'appelle my-hybrid-project, le fichier de clé du compte de service apigee-logger sera nommé my-hybrid-project-apigee-logger.json et l'adresse e-mail du compte de service sera apigee-logger@my-hybrid-project.iam.gserviceaccount.com.

Vous pouvez spécifier un projet en définissant une variable d'environnement PROJECT_ID ou avec l'option --project-id. Si les deux sont définis, l'indicateur --project-id est prioritaire sur la variable d'environnement PROJECT_ID et create-service-account enregistre un [WARNING]. Dans tous les cas, l'outil enregistre la source à partir de laquelle l'ID de projet a été lu et affiche le type de déploiement, le projet et le répertoire de sortie résolus avant de créer des comptes de service.

Si vous ne spécifiez pas d'ID de projet Cloud, create-service-account utilise le projet dans votre configuration de projet gcloud actuelle.

Vous pouvez vérifier la configuration actuelle du projet gcloud avec la commande suivante :

gcloud config list project

Si vous devez modifier l'ID de projet actuel, exécutez la commande suivante :

gcloud config set project PROJECT_ID

Où PROJECT_ID est l'ID de votre projet Cloud actuel. Les instructions de création d'un projet Cloud sont décrites à l'Étape 2 : Créer un projet Google Cloud.

Emplacement du fichier

Vous trouverez l'outil create-service-account dans le répertoire suivant :

$APIGEE_HELM_CHARTS_HOME/apigee-operator/etc/tools/

Vérifier que l'outil create-service-account est exécutable

Vérifiez que vous pouvez exécuter create-service-account. Si vous venez de télécharger les graphiques Helm Apigee, il est possible que les outils de ligne de commande ne soient pas en mode exécutable. Accédez au répertoire dans lequel create-service-account est installé et vérifiez qu'il est exécutable en l'exécutant avec --help :

./create-service-account --help

Si le résultat indique permission denied, vous devez rendre le fichier exécutable, par exemple avec chmod sous Linux, MacOS ou UNIX, ou dans l'explorateur Windows, ou à l'aide de la commande icacls dans Windows. Exemple :

chmod +x ./create-service-account

Utiliser create-service-account

Les exemples suivants montrent l'utilisation de create-service-account pour les tâches de configuration Apigee hybrid courantes.

Créer des comptes de service pour un environnement de production

Dans un environnement hybride de production, Apigee recommande d'utiliser un compte de service distinct pour chaque composant. Utilisez la commande suivante pour créer tous les comptes de service pour les composants hybrides, avec leurs noms par défaut dans le répertoire par défaut.

./tools/create-service-account --prod

Les comptes de service suivants seront créés avec les fichiers de certificat téléchargés dans le répertoire ./tools/service-accounts :

Compte de service Rôle IAM E-mail Fichier de certification
apigee-cassandra roles/storage.objectAdmin apigee-cassandra@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-cassandra.json
apigee-guardrails roles/serviceusage.serviceUsageViewer apigee-guardrails@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-guardrails.json
apigee-logger roles/logging.logWriter apigee-logger@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-logger.json
apigee-mart roles/apigeeconnect.Agent apigee-mart@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-mart.json
apigee-metrics roles/monitoring.metricWriter apigee-metrics@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-metrics.json
apigee-mint-task-scheduler Aucun rôle attribué apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-mint-task-scheduler.json
apigee-runtime Aucun rôle attribué apigee-runtime@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-runtime.json
apigee-synchronizer roles/apigee.synchronizerManager apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-synchronizer.json
apigee-watcher roles/apigee.runtimeAgent apigee-watcher@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-watcher.json

Créer un compte de service unique pour un environnement hors production

Pour les environnements hors production, tels qu'un environnement expérimental ou de démonstration, vous pouvez créer un seul compte de service nommé "apigee-non-prod" que vous pouvez utiliser pour tous les composants. Tous les rôles IAM de l'exemple précédent sont attribués à ce compte de service.

./tools/create-service-account --non-prod

Cette commande crée un compte de service unique nommé apigee-non-prod et télécharge le fichier de certificat dans le répertoire ./tools/service-accounts :

Compte de service Rôles IAM E-mail Fichier de certification
apigee-non-prod roles/apigee.runtimeAgent
roles/apigee.synchronizerManager
roles/apigeeconnect.Agent
roles/logging.logWriter
roles/monitoring.metricWriter
roles/serviceusage.serviceUsageViewer
roles/storage.objectAdmin
apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-non-prod.json

Donner un nom personnalisé à un seul compte de service de production

Par défaut, un seul compte de service de production est nommé d'après le nom de compte de service compatible que vous sélectionnez. Par exemple, --prod apigee-cassandra crée un compte de service nommé apigee-cassandra. Pour donner un nom différent à un compte de service de production unique tout en conservant le même rôle IAM, ajoutez l'indicateur --name (ou son alias -n) :

./tools/create-service-account --prod apigee-cassandra --name my-cassandra-sa

Cela crée un compte de service de production nommé my-cassandra-sa avec le rôle IAM apigee-cassandra (roles/storage.objectAdmin). Le rôle IAM provient toujours du nom du compte de service que vous transmettez à --prod ; --name ne modifie que le nom du compte.

create-service-account syntax

L'outil create-service-account utilise la syntaxe suivante :

create-service-account [flags] 

Le tableau suivant répertorie les options create-service-account :

Option Valeurs Description
--dir
-d
nom du répertoire Spécifie un répertoire de sortie pour les fichiers de clé du compte de service. Si le répertoire n'existe pas, create-service-account le crée. Si le répertoire existe déjà, create-service-account écrase tous les fichiers du répertoire portant le même nom que les fichiers de clé qu'il crée.

Si vous ne spécifiez pas de répertoire de sortie, create-service-account écrit les fichiers de compte de service dans le répertoire service-accounts/ au sein du répertoire où se trouve create-service-account.

--prod nom du compte de service
(facultatif)
Crée des comptes de service pour un environnement hybride de production. Il s'agit du comportement par défaut : si vous exécutez create-service-account sans indicateur de type de déploiement, il se comporte comme si --prod avait été transmis.

Dans un environnement de production, il est recommandé de disposer d'un seul compte de service pour chaque service Apigee. Chaque compte de service créé est associé à un seul rôle IAM.

create-service-account --prod sans nom de compte de service crée tous les comptes de service utilisés par Apigee hybrid. Pour créer un seul compte de service de production, transmettez son nom, par exemple --prod apigee-cassandra. Les noms de comptes de service de production compatibles sont listés dans le tableau des comptes de service plus haut sur cette page, sous Créer des comptes de service pour un environnement de production.

--non-prod nom du compte de service
(facultatif)
crée un seul compte de service auquel sont associés tous les rôles IAM ; Cela s'avère utile pour les environnements hors production tels qu'une installation expérimentale ou de démonstration.

Le compte de service est nommé apigee-non-prod, sauf si vous transmettez un nom, par exemple --non-prod my-account.

--name
-n
nom du compte de service Cela ne modifie que le nom du compte de service créé, jamais les rôles IAM qu'il reçoit. Les rôles sont toujours déterminés par le type de déploiement et, pour un compte de service de production unique, par SA_NAME.

Les règles de priorité dépendent du type de déploiement :

  • --prod SA_NAME --name NAME crée un seul compte de service de production nommé NAME avec le rôle IAM SA_NAME. Cela vous permet de donner à un compte de service de production un nom autre que SA_NAME.
  • --prod --name NAME sans SA_NAME est une erreur : sans nom de compte de service, --prod crée un compte de service distinct pour chaque nom de compte de service de production compatible. Un seul --name serait donc ambigu. Utilisez --prod SA_NAME --name NAME pour renommer un seul compte de service de production.
  • --non-prod SA_NAME --name NAME : --name est prioritaire. L'outil enregistre un [WARNING] indiquant qu'un nom positionnel et --name ont été fournis, et nomme le compte de service unique hors production NAME.
  • --non-prod --name NAME nomme le compte de service unique hors production NAME.
--skip-key-download aucun Crée les comptes de service et attribue leurs rôles IAM, mais ne télécharge pas les fichiers de clé JSON. Utilisez cet indicateur lorsque vous n'avez pas besoin des fichiers de clés, par exemple avec les méthodes d'authentification de Workload Identity Federation for GKE.
--help
-h
aucun Affiche le texte d'aide.
‑‑project‑id
-i
project id ID du projet Google Cloud dans lequel vous créez les comptes de service.

Vous pouvez fournir l'ID du projet avec l'option --project-id ou en exportant une variable d'environnement PROJECT_ID. Si les deux sont définis, l'indicateur --project-id est prioritaire sur la variable d'environnement PROJECT_ID et create-service-account enregistre un [WARNING]. Dans tous les cas, l'outil enregistre la source à partir de laquelle l'ID du projet a été lu.

Si vous ne spécifiez pas d'ID de projet avec l'option ou la variable d'environnement, create-service-account utilise l'ID du projet dans votre configuration gcloud actuelle.

Pour en savoir plus sur les comptes de service utilisés par Apigee hybrid, consultez la section À propos des comptes de service.

Vous pouvez également créer des comptes de service dans la console Google Cloud . Consultez aussi Créer et gérer des comptes de service.