Documentation de référence sur asmcli
Cette page décrit les arguments disponibles pour asmcli
.
Options
Identifier le cluster Vous disposez des options suivantes pour identifier le cluster :
Limitation à GKE
-p|--project_id CLUSTER_PROJECT_ID
- ID du projet dans lequel le cluster a été créé.
-n|--cluster_name CLUSTER_NAME
- Nom du cluster.
-l|--cluster_location CLUSTER_LOCATION
- Zone (pour les clusters à zone unique) ou région (pour les clusters régionaux) dans laquelle le cluster a été créé.
Toutes les plates-formes
--kubeconfig KUBECONFIG_FILE
Chemin d'accès complet au fichier kubeconfig. La variable d'environnement $PWD
ne fonctionne pas ici.
--ctx|--context KUBE_CONTEXT
Contexte kubeconfig à utiliser. Si cette option n'est pas spécifiée, asmcli
utilise le contexte par défaut.
-c|--ca {mesh_ca|gcp_cas|citadel}
Autorité de certification à utiliser pour gérer les certificats TLS mutuels. Spécifiez
mesh_ca
pour utiliser l'autorité de certification Anthos Service Mesh (Mesh CA),gcp_cas
pour utiliser Certificate Authority Service oucitadel
pour utiliser Istio CA. Anthos Service Mesh géré n'est pas compatible avec Istio CA. Pour en savoir plus, consultez les pages suivantes :--co|--custom_overlay OVERLAY_FILE
Utilisez
--custom_overly
avec le nom d'un fichier YAML (appelé fichier superposé) contenant la ressource personnaliséeIstioOperator
pour configurer le plan de contrôle au sein du cluster. Vous spécifiez un fichier superposé pour activer une fonctionnalité qui n'est pas activée par défaut. Le service Anthos Service Mesh géré n'est pas compatible avec l'APIIstioOperator
. Vous ne pouvez donc pas utiliser--custom_overlay
pour configurer le plan de contrôle géré.asmcli
doit pouvoir localiser le fichier superposé. Il doit donc se trouver dans le même répertoire queasmcli
, ou vous pouvez spécifier un chemin d'accès relatif. Pour ajouter plusieurs fichiers, spécifiez--co|--custom_overlay
et le nom du fichier, par exemple :--co overlay_file1.yaml --co overlay_file2.yaml --co overlay_file3.yaml
--hub-registration-extra-flags HUB_REGISTRATION_EXTRA_FLAGS
Si vous utilisez des clusters Amazon EKS associés, enregistrez le cluster à l'aide de
--hub-registration-extra-flags
si le parc n'est pas déjà enregistré.-k|--key_file FILE_PATH
Fichier de clé d'un compte de service. Ne renseignez pas cette option si vous n'utilisez pas de compte de service.
--network_id NETWORK_ID
Utilisez
--network_id
pour définir le libellétopology.istio.io/network
appliqué à l'espace de nomsistio-system
. Pour GKE,--network_id
utilise par défaut le nom du réseau du cluster. Pour les autres environnements, la valeurdefault
est utilisée.-o|--option OVERLAY_FILE
Nom du fichier superposé (sans l'extension
.yaml
) téléchargé parasmcli
à partir du dépôtanthos-service-mesh
pour activer une fonctionnalité facultative. Vous devez disposer d'une connexion Internet pour utiliser--option
. Les options--option
et--custom_overlay
sont similaires, mais elles présentent un comportement légèrement différent :Utilisez
--custom_overlay
lorsque vous devez modifier les paramètres dans le fichier superposé.Utilisez
--option
pour activer une fonctionnalité qui ne nécessite pas d'apporter des modifications au fichier superposé, par exemple, pour configurer des règles d'audit pour vos services.
Pour ajouter plusieurs fichiers, spécifiez
-o|--option
et le nom du fichier, par exemple :-o option_file1 -o option_file2 -o option_file3
-D|--output_dir DIR_PATH
S'il n'est pas spécifié,
asmcli
crée un répertoire temporaire dans lequel il télécharge les fichiers et les configurations nécessaires à l'installation d'Anthos Service Mesh. Spécifiez l'option--output-dir
pour spécifier un chemin d'accès relatif vers un répertoire à utiliser à la place. Une fois l'opération terminée, le répertoire spécifié contient les sous-répertoiresasm
etistio-1.22.4-asm.0
. Le répertoireasm
contient la configuration pour l'installation. Le répertoireistio-1.22.4-asm.0
contient le contenu extrait du fichier d'installation, qui contientistioctl
, des exemples et des fichiers manifestes. Si vous spécifiez--output-dir
et que le répertoire contient déjà les fichiers nécessaires,asmcli
utilise ces fichiers au lieu de les télécharger à nouveau.--platform PLATFORM {gcp|multicloud}
Plate-forme ou fournisseur du cluster Kubernetes. La valeur par défaut est
gcp
(pour les clusters GKE). Pour toutes les autres plates-formes, utilisezmulticloud
.-r|--revision_name REVISION NAME
Un libellé de révision est une paire clé-valeur définie sur le plan de contrôle. La clé du libellé de révision est toujours
istio.io/rev
. Par défaut,asmcli
définit la valeur du libellé de révision en fonction de la version d'Anthos Service Mesh, par exemple :asm-1224-0
. Incluez cette option si vous souhaitez remplacer la valeur par défaut et spécifier la vôtre. L'argumentREVISION NAME
doit être un libellé DNS-1035. Cela signifie que le nom doit :- contenir au maximum 63 caractères ;
- contenir uniquement des caractères alphanumériques en minuscules ou "-" ;
- commencer par un caractère alphabétique ;
- se terminer par un caractère alphanumérique.
L'expression régulière utilisée pour la validation est la suivante : '[a-z]([-a-z0-9]*[a-z0-9])?'
-s|--service_account ACCOUNT
- Nom d'un compte de service permettant d'installer Anthos Service Mesh. S'il n'est pas spécifié, le compte utilisateur actif dans la configuration
gcloud
actuelle est utilisé. Si vous devez modifier le compte utilisateur actif, exécutez la commande gcloud auth login.
Options pour le certificat personnalisé Istio CA
Si vous avez spécifié --ca citadel
et que vous utilisez une autorité de certification personnalisée, incluez les options suivantes :
--ca_cert FILE_PATH
: le certificat intermédiaire--ca_key FILE_PATH
: la clé du certificat intermédiaire--root_cert FILE_PATH
: le certificat racine--cert_chain FILE_PATH
: la chaîne de certificats
Pour en savoir plus, consultez la page Connecter des certificats CA existants.
Options d'activation
Les options commençant par --enable
permettent à asmcli
d'activer les API Google nécessaires, de définir les autorisations IAM (Identity and Access Management) requises et de mettre à jour votre cluster. Si vous préférez, vous pouvez mettre à jour votre projet et votre cluster vous-même avant d'exécuter asmcli
. Toutes les options d'activation sont incompatibles avec asmcli validate
. Si vous spécifiez une option d'activation lorsque vous exécutez asmcli validate
, la commande se termine par une erreur.
-e|--enable_all
- Autorise
asmcli
à effectuer toutes les actions d'activation individuelles décrites ci-dessous. --enable_cluster_roles
- Autorise
asmcli
à tenter de lier l'utilisateur ou le compte de service Google Cloud qui exécuteasmcli
au rôlecluster-admin
sur le cluster.asmcli
identifie le compte utilisateur à l'aide de la commandegcloud config get core/account
. Si vous exécutezasmcli
en local avec un compte utilisateur, veillez à appeler la commandegcloud auth login
avant d'exécuterasmcli
. Si vous devez modifier le compte utilisateur, exécutez la commandegcloud config set core/account GCP_EMAIL_ADDRESS
, où GCP_EMAIL_ADDRESS correspond au compte que vous utilisez pour vous connecter à Google Cloud. --enable_cluster_labels
- Autorise
asmcli
à définir les libellés de cluster requis. --enable_gcp_components
Autorise
asmcli
à activer les services gérés et composants Google Cloud requis suivants :Workload Identity, qui permet aux applications GKE d'accéder en toute sécurité aux services Google Cloud
--enable_gcp_apis
Autorise
asmcli
à activer toutes les API Google requises.--enable_gcp_iam_roles
Autorise
asmcli
à définir les autorisations IAM requises.--enable_meshconfig_init
Autorisez le script à initialiser le point de terminaison maillageconfig en votre nom. Implications de
--enable_gcp_components
et--managed
.--enable_namespace_creation
Autorisez
asmcli
à créer l'espace de noms racineistio-system
.--enable_registration
Autorise
asmcli
à enregistrer le cluster dans le projet dans lequel il se trouve. Si vous n'incluez pas cette option, suivez les étapes décrites dans la section Enregistrer un cluster pour enregistrer manuellement le cluster. Notez que, contrairement aux autres options d'activation,--enable_registration
n'est inclus dans--enable_all
que lorsque vous spécifiez une option (par exemple,--option hub-meshca
) nécessitant l'enregistrement du cluster. Sinon, vous devez spécifier cette option séparément.
Autres options
--dry_run
- Imprimez les commandes, mais ne les exécutez pas.
--fleet_id
- Enregistre un cluster dans un parc à l'aide de l'ID de projet hôte du parc Cette option est requise pour les clusters autres que Google Cloud. Lorsqu'elle n'est pas fournie pour les clusters Google Cloud, elle utilise par défaut l'ID de projet du cluster. Vous pouvez exécuter
asmcli install
avec--fleet_id
avant l'installation ou pendant l'installation en transmettant les options--enable-registration
et--fleet-id
. Ce paramètre ne peut plus être modifié une fois configuré. --managed
- Provisionnez un plan de contrôle géré à distance au lieu d'en installer un en cluster.
--offline
- Effectuez une installation hors connexion à l'aide du package prétéléchargé dans le répertoire de sortie. Si le répertoire n'est pas spécifié ou ne contient pas les fichiers requis, le script se ferme avec une erreur.
--only_enable
- Suivez la procédure spécifiée pour configurer l'utilisateur/le cluster actuel, mais cela n'installe rien.
--only_validate
- Exécute la validation sans mettre à jour le projet ou le cluster, et sans installer Anthos Service Mesh. Cette option n'est pas compatible avec les options d'activation.
asmcli
se termine par une erreur si vous spécifiez--only_validate
avec une option d'activation. --print_config
- Au lieu d'installer Anthos Service Mesh, imprimez tout le fichier YAML compilé en sortie standard (stdout). Toutes les autres sorties sont générées pour les erreurs standards (stderr), même si elles se rendent normalement dans stdout.
asmcli
ignore toutes les validations et la configuration lorsque vous spécifiez cette option. --disable_canonical_service
- Par défaut,
asmcli
déploie le contrôleur de service canonique sur votre cluster. Si vous ne souhaitez pas queasmcli
déploie le contrôleur, spécifiez--disable_canonical_service
. Pour en savoir plus, consultez la page Activer et désactiver le contrôleur de service canonique. -h|--help
- Affiche un message d'aide décrivant les options, puis ferme.
--use_managed_cni
- Utiliser la CNI gérée Si cet indicateur n'est pas transmis,
asmcli
applique les fichiers manifestes CNI statiques. --use_vpcsc
- Cette option n'est plus nécessaire pour utiliser VPC Service Controls pour votre projet.
-v|--verbose
- Lorsque
asmcli
s'exécute, il imprime la commande qu'il exécutera ensuite. Avec l'option--verbose
,asmcli
imprime également la commande après l'exécution. --version
- Imprimez la version de
asmcli
, puis quittez. Si vous ne disposez pas de la version la plus récente, vous pouvez télécharger la version la plus récente deasmcli_1.22
.
Étapes suivantes
Découvrez comment configurer un maillage multicluster :
Si votre maillage ne comprend que des clusters GKE, consultez la page Configurer un maillage multicluster sur GKE.
Si votre maillage contient des clusters en dehors de Google Cloud, consultez la page Configurer un maillage multicluster en dehors de Google Cloud.