apigeectl

Vous consultez actuellement la version 1.2 de la documentation d'Apigee hybrid. Cette version est en fin de vie. Vous devez passer à une version plus récente. Pour en savoir plus, consultez la section Versions compatibles.

Version 1.2 (unsupported)

   Versions compatibles :

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

   Versions non compatibles :

• 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é et configuré kubectl sur votre machine d'administration Kubernetes.

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 à vos clusters Kubernetes. Utilisez l'option -c pour spécifier un ou plusieurs composants (séparés par des virgules). Si vous ne spécifiez pas l'option -c, la commande apply applique tous les composants au cluster. REMARQUE : 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. Si vous ne spécifiez pas l'option -c, la commande check-ready s'applique à tous les composants du cluster.
delete	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. Si vous ne spécifiez pas l'option -c, la commande delete s'applique à tous les composants déployés dans le cluster.
help	Imprime l'aide en ligne.
init	Applique les configurations de composants prérequis, tels qu'Istio et Apigee Deployment, au cluster. Utilisez l'option -c pour spécifier un ou plusieurs composants (séparés par des virgules).
version	Imprime les informations concernant la version de la CLI.

Options apigeectl

Le tableau suivant répertorie les options apigeectl :

Option	Description
-c, --components	Spécifie un composant unique auquel la commande s'applique. Si vous ne spécifiez pas cette option, la commande s'applique à tous les composants (tout le déploiement) du cluster. Les valeurs possibles sont les suivantes : cassandra logger mart metrics runtime synchronizer udca Par exemple : -c cassandra Ou, pour spécifier plusieurs composants, ajoutez des valeurs séparées par des virgules : -c cassandra, runtime
--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.
‑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.
--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.
-s, --settings	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. (Ajouté v1.2.0) 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 -c runtime

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 -c pour n'appliquer qu'un composant 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 l'option -c, comme décrit dans la section Options apigeectl.

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

apigeectl apply -c synchronizer -f my_overrides.yaml

L'exemple applique uniquement la configuration des composants Cassandra et d'exécution :

apigeectl apply -c cassandra,runtime -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 --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
All containers ready in namespace 'my-namespace'

Supprimer le composant hybride du cluster

L'exemple suivant supprime uniquement les composants d'exécution hybride de votre cluster Kubernetes. Pour tout supprimer, utilisez l'option --all.

REMARQUE : Pour désinstaller l'outil, vous devez disposer de kubectl version 1.11.x ou ultérieure.

apigeectl delete -f my_overrides.yaml