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.
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 | Runtime Synchronizer UDCA |
‑‑all‑envs ‑‑env |
Organization (Organisation) | Agent Apigee Connect marT Watcher |
‑‑org |
Rapports | Logger Metrics |
‑‑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
Options apigeectl : |
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 : |
delete |
Supprime les composants hybrides du cluster. Utilisez l'option
Options apigeectl : |
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
Lorsque vous appelez le collecteur de diagnostics, il crée un espace de noms Kubernetes " Appelez le collecteur de diagnostics : apigeectl diagnostic ‑f OVERRIDES_FILE Supprimez le collecteur de diagnostics : apigeectl diagnostic delete ‑f OVERRIDES_FILE Options apigeectl : |
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 Vous devez utiliser ./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 : |
help |
Imprime l'aide en ligne. |
init |
Installe les opérateurs et les CRD Apigee dans l'espace de noms apigee-system.
Exécutez options apigeectl : |
version |
Imprime les informations concernant la version de la CLI. option apigeectl : |
Options apigeectl
Le tableau suivant répertorie les options apigeectl
:
Indicateur | Description |
---|---|
‑‑all |
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 |
‑‑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.
|
‑‑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.
apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \ ‑f overrides/overrides.yaml |
‑f |
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 |
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. |
‑‑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é |
‑s |
Spécifie une configuration à laquelle la commande s'applique. Actuellement, cette option n'est compatible qu'avec la configuration Par exemple, si vous apportez une modification à la configuration 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. ‑‑verbose . |
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
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'