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
--ctx|--context KUBE_CONTEXT
Le contexte kubeconfig
à utiliser.
-c|--ca {mesh_ca|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) oucitadel
pour utiliser l'autorité de certification Istio. Pour en savoir plus sur l'autorité de certification à utiliser, consultez la page Choisir une autorité de certification. Pour connaître les options supplémentaires que vous devez spécifier lors de l'utilisation d'Istio CA, consultez la section Options pour le certificat personnalisé Istio CA. --co|--custom_overlay YAML_FILE
- Nom du fichier YAML de la ressource personnalisée
IstioOperator
pour activer une fonctionnalité qui n'est pas activée par défaut. Le script doit pouvoir localiser le fichier YAML. Par conséquent, celui-ci doit se trouver dans le même répertoire que le script, 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é. --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 OPTION_FILE
- Nom d'un fichier YAML du package
anthos-service-mesh
contenant la ressource personnaliséeIstioOperator
pour activer une fonctionnalité facultative. Lorsque vous incluez l'un de ces fichiers, vous n'avez pas besoin de télécharger le packageanthos-service-mesh
au préalable, et vous ne spécifiez pas l'extension.yaml
. Si vous devez modifier l'un des fichiers, téléchargez le packageanthos-service-mesh
, apportez vos modifications et utilisez l'option--custom_overlay
. 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é, le script 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.10.6-asm.2
. Le répertoireasm
contient la configuration pour l'installation. Le répertoireistio-1.10.6-asm.2
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, le script utilise ces fichiers au lieu de les télécharger à nouveau. -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, le script définit la valeur du libellé de révision en fonction de la version d'Anthos Service Mesh, par exemple :asm-1106-2
. 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. Il doit en outre contenir des caractères alphanumériques minuscules ou-
, commencer par un caractère alphabétique et se terminer par un caractère alphanumérique (par exemplemy-name'
ouabc-123
). 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. -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.
Options du certificat Citadel personnalisé
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 au script d'activer les API Google, de définir les autorisations IAM (Identity and Access Management) et de mettre à jour votre cluster. Si vous préférez, vous pouvez mettre à jour vous-même votre projet et votre cluster avant d'exécuter le script, comme décrit sur les pages Configurer le projet et Configurer un cluster du guide d'installation sur plusieurs projets. L'ensemble de ces options ne sont pas compatibles avec --only_validate
. Dans ce cas, le script se termine par une erreur.
-e|--enable_all
- Autorise le script à effectuer toutes les actions d'activation individuelles décrites ci-dessous.
--enable_cluster_roles
- Autorise le script à tenter de lier l'utilisateur ou le compte de service Google Cloud qui exécute le script au rôle
cluster-admin
sur le cluster. Le script identifie le compte utilisateur à l'aide de la commandegcloud config get core/account
. Si vous exécutez le script localement avec un compte utilisateur, veillez à appeler la commandegcloud auth login
avant d'exécuter le script. 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 le script à définir les libellés de cluster requis.
--enable_gcp_components
Autorise le script à 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 le script à activer toutes les API Google requises.
--enable_gcp_iam_roles
Autorise le script à définir les autorisations IAM requises.
--enable_registration
Autorisez le script à enregistrer le cluster dans le projet hébergeant le cluster. Si vous n'incluez pas cette option, suivez les étapes décrites dans la section Enregistrer un cluster pour enregistrer manuellement votre 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 vm
ou--option hub-meshca
) nécessitant l'enregistrement du cluster. Sinon, vous devez spécifier cette option séparément.
Autres options
--dry_run
- Imprime les commandes, mais ne les exécute 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é. --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. Le script 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. Le script ignore toutes les validations et la configuration lorsque vous spécifiez cette option.
--disable_canonical_service
- Par défaut, le script déploie le contrôleur de service canonique sur votre cluster. Si vous ne souhaitez pas que le script déploie le contrôleur, spécifiez l'option
--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.
-v|--verbose
- Lorsque le script s'exécute, imprime la commande qu'il exécutera ensuite. Avec l'option
--verbose
, le script 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 deinstall_asm_1.10
.