Ce que fait ce module #
Quand vous démarrez une AMI imaxe, la première question est souvent la plus élémentaire : qu'y a-t-il à l'intérieur ? Quelle version du système d'exploitation, quels logiciels sont installés et dans quelle version, quelle base de données se trouve derrière et quel produit imaxe a été déployé.
Le module info répond à tout cela d'un seul coup : il sonde le système en direct et écrit un inventaire clair et lisible dans /etc/imaxe/info.yaml. Ce fichier rassemble le système d'exploitation, les logiciels et leurs versions, la base de données et le produit imaxe, prêt à être consulté à l'écran ou en JSON pour l'automatisation.
Le fichier /etc/imaxe/info.yaml est purement descriptif : des noms et des versions. Il ne stocke jamais de mots de passe, de clés ni de jetons ; vous pouvez donc le lire, le copier ou le joindre à un ticket en toute sérénité.
Tâches courantes #
Choisissez ce que vous voulez faire. Chaque recette fournit la commande déjà écrite — il suffit de la copier et de cliquer sur Copier.
1
Générer l'inventaire
Sonder la machine et écrire /etc/imaxe/info.yaml pour la première fois.
/etc/imaxe/info.yaml pour la première fois.Connectez-vous en SSH à votre serveur avec l'utilisateur ubuntu.
Lancez create : il parcourt le système et écrit l'inventaire sur le disque.
$ sudo imaxe info create/etc/imaxe/info.yaml est écrit avec le système d'exploitation, les logiciels et leurs versions, la base de données et le produit imaxe.2
Voir ce que j'ai installé
Affiche à l'écran l'inventaire déjà généré.
Lisez l'inventaire stocké dans /etc/imaxe/info.yaml :
$ imaxe info show3
Obtenir l'inventaire en JSON
Sortie structurée pour scripts, supervision ou inventaire centralisé.
Ajoutez --json à show pour obtenir l'inventaire dans un format lisible par machine :
$ imaxe info show --jsonVous voulez extraire une seule valeur ? Combinez-le avec jq, par exemple la version du système d'exploitation :
$ imaxe info show --json | jq .osstdout, prêt à être passé à jq, à un agent d'inventaire ou à votre CMDB.4
Régénérer après un changement
Mettre à jour l'inventaire après avoir installé ou mis à niveau un logiciel.
L'inventaire est un instantané du système au moment où il a été généré. Si vous avez mis à niveau des paquets ou changé de base de données, relancez create pour le réécrire avec des données fraîches :
$ sudo imaxe info create
$ imaxe info show/etc/imaxe/info.yaml reflète de nouveau l'état réel de la machine.Le fichier reflète le système tel qu'il était au moment où create a été exécuté. Il ne se met pas à jour tout seul : après tout changement significatif du logiciel, relancez create pour que show reste fidèle à la réalité.
Synopsis #
imaxe info <subcomando> [--json]La sous-commande create nécessite les privilèges root (utilisez sudo) car elle écrit dans /etc/imaxe/. En revanche, show ne fait que lire l'inventaire et peut s'exécuter sans sudo. Ajoutez --json à show pour obtenir une sortie lisible par machine, adaptée au scripting.
Sous-commandes #
| Sous-commande | Rôle | Flags pertinents |
|---|---|---|
| create | Sonde le système en direct et (ré)écrit l'inventaire dans /etc/imaxe/info.yaml. | — |
| show | Affiche l'inventaire stocké dans /etc/imaxe/info.yaml. | --json |
| help | Affiche l'aide du module. | — |
Arguments et flags #
| Flag | Type | Par défaut | Description |
|---|---|---|---|
| --json | bool | false | Dans show, émet l'inventaire sous forme de JSON structuré sur stdout, adapté à jq et à l'automatisation. |
Le module info ne prend aucun argument positionnel : chaque sous-commande opère sur l'inventaire du système lui-même.
Fichiers et chemins #
| Chemin | Contenu |
|---|---|
| /etc/imaxe/info.yaml | Inventaire de l'AMI : système d'exploitation, logiciels et versions, base de données et produit imaxe. Purement descriptif, sans secrets. |
Exemple de info.yaml :
os:
name: Ubuntu
version: 22.04
software:
nginx: 1.18.0
php: 8.1
database:
engine: mysql
version: 8.0.36
product:
name: imaxe
version: 1.0.0Codes de sortie et logs #
Chaque exécution renvoie un code que vous pouvez vérifier avec echo $? — pratique pour enchaîner dans des scripts :
show sans inventaire : lancez d'abord create.create sans les privilèges pour écrire dans /etc/imaxe/.Résolution des problèmes #
| Symptôme | Cause probable | Solution |
|---|---|---|
| show n'affiche rien ou échoue | L'inventaire n'a pas encore été généré. | Lancez sudo imaxe info create et réessayez show. |
| create renvoie une erreur de permissions | Il a été exécuté sans root et ne peut pas écrire dans /etc/imaxe/. | Relancez-le avec sudo imaxe info create. |
| L'inventaire ne correspond pas à la réalité | Un logiciel a été installé ou mis à niveau après sa génération. | Régénérez-le avec sudo imaxe info create : c'est un instantané à un instant donné. |
La sortie --json n'est pas propre | --json a été appliqué à une sous-commande qui ne le prend pas en charge. | --json ne s'applique qu'à show ; utilisez-le sous la forme imaxe info show --json. |
Bloqué sur le module Inventaire ?
Écrivez-nous avec la sortie de « imaxe <module> status --json » et nous vous répondons rapidement.