apigeectl

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                                         

apigeectl est une interface de ligne de commande (CLI) permettant d'installer et de gérer Apigee hybrid dans un cluster Kubernetes. Pour en savoir plus sur le téléchargement et l'installation de apigeectl, consultez la section Télécharger et installer apigeectl.

REMARQUE : Pour utiliser la commande apigeectl, vous devez avoir installé kubectl et l'avoir configuré sur votre machine d'administration Kubernetes.

Champs d'application de la commande apigeectl

À l'aide des options apigeectl, vous contrôlez les champs d'application auxquels la commande applique les modifications de configuration. Pour obtenir une présentation des champs d'application dans l'environnement d'exécution Apigee hybrid, consultez la présentation de la configuration d'exécution du service.

Champ d'application	Composants	Option apigeectl
Stockage	Cassandra	‑‑datastore
Stockage en mémoire	Redis	‑‑redis
Environnement	Environnement d'exécution Synchronizer UDCA	‑‑all‑envs ‑‑env
Organisation	Agent Apigee Connect marT Watcher	‑‑org
Rapports	Métriques outil de journalisation	‑‑telemetry

Syntaxe apigeectl

apigeectl [command] [flags]

Où :

• command : spécifie l'opération que vous souhaitez effectuer. Pour obtenir la liste complète des commandes, consultez la section Commandes apigeectl.

• flags : spécifie les paramètres de commande. Pour obtenir la liste complète des options, consultez la section Options apigeectl.

Commandes apigeectl

Le tableau suivant répertorie les commandes apigeectl :

Commande	Description
apply	Applique les configurations des composants d'exécution Apigee hybrid aux clusters. Si vous ne spécifiez pas d'options, la commande apigeectl apply s'applique à tous les composants du cluster. Options apigeectl : ‑‑all‑envs, ‑‑datastore, ‑‑dry‑run, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑print‑yaml, ‑‑redis, ‑‑settings virtualhosts, ‑‑telemetry, ‑‑v REMARQUE : Après une nouvelle installation ou une mise à niveau, vous devez appeler apigeectl init avant d'appeler apigeectl apply.
check‑ready	Vérifie l'état des pods de composants hybrides. Lorsque tous les pods de composants sont prêts, le message "Tous les conteneurs sont prêts" est généré. Pour les scripts automatisés, notez que la commande se termine avec l'état 0 lorsque les conteneurs sont tous prêts. Lorsqu'au moins un pod n'est pas prêt, la commande se termine avec l'état 1. options apigeectl : ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
delete	Avertissement : L'utilisation de la commande apigeectl delete avec l'option ‑‑all (par exemple, apigeectl delete ‑‑all -f overrides.yaml) supprime également les données de sauvegarde pour tous les instantanés de volume CSI. Supprime les composants hybrides du cluster. Utilisez l'option ‑‑all pour supprimer TOUS les composants. Si vous omettez ‑‑all, seuls les composants spécifiques à Apigee sont supprimés (les composants installés avec apigeectl init ne sont pas supprimés). Les composants spécifiques à Apigee sont les composants installés avec la commande apply. apigeectl delete sans aucune option facultative applique la commande delete à tous les composants déployés dans le cluster. apigeectl diagnostic delete ‑f OVERRIDES_FILE supprime l'espace de noms apigee‑diagnostic créé par apigeectl diagnostic. L'option ‑f/‑‑file‑override‑config est obligatoire avec apigeectl diagnostic delete Options apigeectl : ‑‑all, ‑‑all‑envs, ‑‑datastore, ‑‑env, ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑org, ‑‑redis, ‑‑telemetry, ‑‑v Pour en savoir plus, consultez la page Désinstaller l'environnement d'exécution hybride.
diagnostic	Appelle le collecteur de diagnostics, qui capture les données de diagnostic sur les composants Kubernetes d'une instance Apigee hybrid à la demande et les stocke dans des buckets de stockage Google Cloud. Le collecteur de diagnostics nécessite un bucket de stockage Google Cloud nommé, un compte de service avec le rôle Administrateur de l'espace de stockage et un stanza diagnostic: ajouté à votre fichier overrides. Consultez les pages suivantes : Utiliser le collecteur de diagnostics Documentation de référence sur les propriétés de configuration : diagnostic Lorsque vous appelez le collecteur de diagnostics, il crée un espace de noms Kubernetes "apigee‑diagnostic". Vous devez supprimer celui-ci avec apigeectl diagnostic delete avant d'appeler à nouveau le collecteur de diagnostics. Appelez le collecteur de diagnostics : apigeectl diagnostic ‑f OVERRIDES_FILE Supprimez le collecteur de diagnostics : apigeectl diagnostic delete ‑f OVERRIDES_FILE Options apigeectl : ‑‑file‑override‑config
encode	Renvoie la liste des noms encodés de tous les ApigeeDeployments pour l'organisation spécifiée ou l'environnement indiqué au sein de l'organisation spécifiée. Les noms encodés incluent le nom du composant doté d'un nom haché de l'organisation et, si vous utilisez l'option ‑‑env, d'un nom haché de l'environnement. Apigee hybride crée des noms hachés d'organisations et d'environnements pour pouvoir éviter les conflits d'espace de noms. Vous devez utiliser ‑‑org org‑name seul ou à la fois ‑‑org org‑name avec les indicateurs ‑‑env env‑name et encode. Exemple : ./apigeectl encode ‑‑org hybrid‑example List of ApigeeDeployments are: apigee‑connect‑agent‑hybrid‑example‑6a82f8a apigee‑mart‑hybrid‑example‑6a82f8a apigee‑watcher‑hybrid‑example‑6a82f8a ./apigeectl encode ‑‑org hybrid‑example ‑‑env example‑env List of ApigeeDeployments are: apigee‑runtime‑hybrid‑example‑example‑env‑9e87e2d apigee‑synchronizer‑hybrid‑example‑example‑env‑9e87e2d apigee‑udca‑hybrid‑example‑example‑env‑9e87e2d options apigeectl : ‑‑env, ‑‑org
help	Imprime l'aide en ligne.
init	Installe les opérateurs et les CRD Apigee dans l'espace de noms apigee-system. Exécutez apigeectl init après une nouvelle installation ou une mise à niveau avant d'exécuter apigeectl apply. options apigeectl : ‑f, ‑‑file‑override‑config, ‑‑help, ‑‑v
version	Imprime les informations concernant la version de la CLI. option apigeectl : ‑‑help

Options apigeectl

Le tableau suivant répertorie les options apigeectl :

Option	Description
‑‑all	Avertissement : L'utilisation de la commande apigeectl delete avec l'option ‑‑all (par exemple, apigeectl delete ‑‑all -f overrides.yaml) supprime également les données de sauvegarde de tous les instantanés de volume CSI. delete uniquement : supprime l'intégralité de l'installation Apigee hybrid, à l'exception d'ASM (Istio) et de cert-manager de votre cluster.
‑‑all‑envs	Applique la commande apigeectl à tous les environnements de l'organisation spécifiée dans votre fichier de configuration de remplacements.
‑‑datastore	Applique la configuration au champ d'application du datastore (Cassandra).
‑‑dry‑run	Exécute la commande spécifiée sans modifier le cluster. S'utilise avec ‑‑print‑yaml pour générer la spécification d'objet rendue dans un fichier. ‑‑dry‑run doit être utilisé avec l'une des deux valeurs suivantes, en fonction de la version de kubectl que vous exécutez. Utilisez gcloud version pour vérifier votre version de kubectl : kubectl version 1.17.x ou antérieure : ‑‑dry‑run=true kubectl version 1.18.x ou ultérieure : ‑‑dry‑run=client
‑‑env env‑name	Applique la configuration à l'environnement spécifié. Cet option applique la configuration aux composants apigee-runtime, apigee-synchronizer et apigee-udca du champ d'application de l'environnement. ‑‑env doit être utilisé avec l'indicateur ‑‑org. Exemple : apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml
‑f ‑‑file‑override‑config	Spécifie un fichier YAML contenant des propriétés de configuration personnalisées pour le déploiement hybride. La valeur par défaut est ./overrides.yaml. Un fichier de remplacement est requis pour les commandes apply, check‑ready, delete et init. Vous devez spécifier le chemin complet avec cette option. Pour en savoir plus, consultez la section Gérer les composants du plan d'exécution.
‑h ‑‑help	Affiche l'aide associée à la commande.
‑‑org	Applique la configuration à l'organisation spécifiée. Cette option applique la configuration aux composants de champ d'application d'organisation apigee-connect-agent, apigee-mart et apigee-watcher. Remarque : Lorsque vous utilisez ‑‑org avec encode, vous devez inclure l'ID de l'organisation. Exemple : apigeectl encode ‑‑org example‑org
‑‑print‑yaml	Imprime la sortie du modèle de configuration sur stdout. Pour obtenir un exemple utilisant cette option, consultez la section Imprimer la configuration dans un fichier.
‑‑redis	Applique la configuration au champ d'application du stockage des données en mémoire (Redis).
‑‑restore	Restaure Cassandra dans un instantané précédemment enregistré spécifié par la propriété snapshotTimestamp dans la configuration restore du fichier overrides.yaml. La sauvegarde est restaurée à partir du bucket Cloud Storage ou d'un serveur distant en fonction de la configuration backup du fichier overrides.yaml. Pour en savoir plus, consultez la section Restaurer une région à partir d'une sauvegarde.
‑s ‑‑settings virtualhosts	Spécifie une configuration à laquelle la commande s'applique. Actuellement, cette option n'est compatible qu'avec la configuration virtualhosts, qui fait partie du composant runtime. Utilisez cette option si vous apportez des modifications à la propriété virtualhosts, et rien de plus. Par exemple, si vous apportez une modification à la configuration virtualhosts dans votre fichier de remplacement, appliquez-la au cluster à l'aide de la commande suivante : apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \ ‑‑org example‑org ‑‑env example‑env
‑‑telemetry	Applique la configuration des composants de télémétrie tels que apigee-logger et apigee-metrics.
‑‑v int	Imprime des journaux détaillés dans std err. int est un entier qui définit le niveau de verbosité. int est requis avec ‑‑v. Cette option se comporte de la même manière que l'option kubectl ‑‑v. Remarque: Cette option remplace l'option obsolète ‑‑verbose.

La commande apigeectl utilise kubectl en arrière-plan pour fonctionner. Les options de commande apigeectl (apply et delete), ainsi que l'utilisation de fichiers de configuration YAML, sont semblables à leurs équivalents kubectl. Pour en savoir plus sur la gestion des objets dans un cluster Kubernetes, consultez les rubriques suivantes :

• Gestion impérative des objets Kubernetes à l'aide de fichiers de configuration
• Présentation de kubectl

Exemples

Initialiser la configuration du cluster

Appliquez des configurations de composants préalables à votre cluster avec init. Vous devez exécuter la commande init avant apply.

apigeectl init ‑f my_overrides.yaml

Appliquer la configuration du cluster

Pour appliquer des configurations hybrides à votre cluster Kubernetes, utilisez la commande apply. La première fois que vous exécutez apply, tous les composants d'exécution hybride sont créés dans votre cluster. Si vous apportez des modifications de configuration, exécutez à nouveau apply pour n'appliquer que les modifications ou utilisez des options pour n'appliquer des modifications qu'à un champ d'application spécifique.

L'exemple suivant applique la configuration des composants du plan d'exécution hybride à votre cluster :

apigeectl apply ‑f my_overrides.yaml

Appliquer la configuration pour un seul composant

Pour limiter la commande apply à un composant particulier, utilisez les options décrites dans la section Options apigeectl.

L'exemple suivant applique uniquement la configuration du composant Cassandra :

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

Imprimer la configuration dans un fichier

Si vous déboguez un problème d'installation, il est utile d'imprimer la configuration complète du cluster dans un fichier pour pouvoir inspecter les paramètres de configuration. L'option ‑‑print‑yaml affiche la configuration hybride sur stdout, et l'option ‑‑dry‑run permet à la commande de s'exécuter sans apporter de modification au cluster.

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

Remarque : Il est recommandé d'enregistrer une copie de la sortie YAML dans le contrôle de la source pour référence ultérieure. Toutefois, sachez que le fichier de sortie contient des mots de passe et des secrets que vous ne souhaitez peut-être pas stocker.

Vérifier l'état du pod

L'exemple suivant permet de vérifier l'état des pods déployés sur votre cluster :

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

Supprimer le composant hybride du cluster

Pour en savoir plus, consultez la page Désinstaller l'environnement d'exécution hybride.