Interface en Ligne de Commande

L’Interface en Ligne de Commande (CLI) ZoneHero offre un moyen pratique d’interagir avec les API régionales de ZoneHero directement depuis votre terminal. Elle vous permet d’effectuer des opérations telles que la récupération d’informations sur les équilibreurs de charge, ce qui peut être particulièrement utile pour le dépannage et les besoins d’assistance.

Construction et Installation de la CLI#

La CLI ZoneHero peut être compilé à partir du même dépôt que celui utilisé pour le fournisseur Terraform.

Prérequis#

• Go >= 1.24
• Make

Étapes d’Installation#

1. Clonez le dépôt :

git clone https://gitlab.guerraz.net/HLB/hlb-terraform-provider.git

2. Construisez et installez la CLI :

cd hlb-terraform-provider
make cli && make cli-install

Cela compilera la CLI et l’installera sur votre système, rendant la commande zonehero disponible dans votre terminal.

Utilisation de la CLI#

La CLI ZoneHero nécessite les identifiants de votre compte AWS et une clé API pour s’authentifier auprès de l’API ZoneHero.

Configuration de Base#

Pour utiliser la CLI, vous aurez besoin de :

1. Une Clé API (voir Clés API)
2. Des identifiants AWS configurés (soit via des variables d’environnement, des profils AWS CLI, ou des rôles IAM)

Syntaxe des Commandes#

La syntaxe de base pour les commandes CLI ZoneHero est :

zonehero --api-key VOTRE_CLE_API --profile PROFIL_AWS --region REGION_AWS COMMANDE [OPTIONS]

Où :

• VOTRE_CLE_API est votre clé API ZoneHero
• PROFIL_AWS est le profil AWS à utiliser pour les identifiants
• REGION_AWS est la région AWS à cibler (par exemple, eu-west-1)
• COMMANDE est l’opération à effectuer (par exemple, hlb get-load-balancer)
• [OPTIONS] sont des options spécifiques à la commande

Exemple : Récupération d’Informations sur un Équilibreur de Charge#

Pour récupérer des informations détaillées sur un équilibreur de charge spécifique :

zonehero --api-key UUID --profile PROFIL_AWS --region eu-west-1 hlb get-load-balancer --id ID_LB --output json

Remplacez :

• UUID par votre clé API ZoneHero
• PROFIL_AWS par le nom de votre profil AWS
• ID_LB par l’ID de l’équilibreur de charge que vous souhaitez inspecter

L’option --output json formate la réponse en JSON, ce qui est utile pour un traitement ultérieur ou lors de la soumission de tickets d’assistance.

Dépannage et Assistance#

Lors de la création d’une demande d’assistance concernant un HLB particulier via le Portail d’Assistance ZoneHero, il est recommandé de joindre la sortie de la commande suivante :

zonehero --api-key UUID --profile PROFIL_AWS --region eu-west-1 hlb get-load-balancer --id ID_LB --output json

Cela fournit à l’équipe d’assistance des informations complètes sur la configuration de votre équilibreur de charge, facilitant le diagnostic et la résolution des problèmes.

Commandes Supplémentaires#

La CLI ZoneHero prend en charge diverses commandes pour gérer vos équilibreurs de charge. Pour une liste complète des commandes et options disponibles, exécutez :

zonehero --help

Pour obtenir de l’aide sur une commande spécifique, exécutez :

zonehero COMMANDE --help