O que faz este módulo #
Quando lanças uma AMI imaxe, a primeira pergunta costuma ser a mais básica: o que tem lá dentro? Que versão do sistema operativo, que software está instalado e em que versão, que base de dados está por trás e que produto imaxe foi implementado.
O módulo info responde a tudo isso de uma vez: sonda o sistema ao vivo e escreve um inventário claro e legível em /etc/imaxe/info.yaml. Esse ficheiro reúne o sistema operativo, o software e as suas versões, a base de dados e o produto imaxe, pronto para ver no ecrã ou em JSON para automação.
O ficheiro /etc/imaxe/info.yaml é puramente descritivo: nomes e versões. Nunca guarda palavras-passe, chaves ou tokens, por isso podes lê-lo, copiá-lo ou anexá-lo a um ticket com tranquilidade.
Tarefas comuns #
Escolhe o que queres fazer. Cada receita traz o comando já escrito — basta copiá-lo e clicar em Copiar.
1
Gerar o inventário
Sonda a máquina e escreve /etc/imaxe/info.yaml pela primeira vez.
/etc/imaxe/info.yaml pela primeira vez.Liga-te por SSH ao teu servidor com o utilizador ubuntu.
Executa create: percorre o sistema e escreve o inventário no disco.
$ sudo imaxe info create/etc/imaxe/info.yaml é escrito com o sistema operativo, o software e as suas versões, a base de dados e o produto imaxe.2
Ver o que tenho instalado
Mostra no ecrã o inventário já gerado.
Lê o inventário guardado em /etc/imaxe/info.yaml:
$ imaxe info show3
Obter o inventário em JSON
Saída estruturada para scripts, monitorização ou um inventário centralizado.
Adiciona --json a show para obter o inventário num formato legível por máquina:
$ imaxe info show --jsonQueres extrair um único valor? Combina-o com jq, por exemplo a versão do sistema operativo:
$ imaxe info show --json | jq .osstdout, pronto para encaminhar para o jq, um agente de inventário ou o teu CMDB.4
Regenerar após uma alteração
Atualiza o inventário após instalar ou atualizar software.
O inventário é uma foto do sistema no momento em que foi gerado. Se atualizaste pacotes ou mudaste a base de dados, executa create de novo para o reescrever com dados frescos:
$ sudo imaxe info create
$ imaxe info show/etc/imaxe/info.yaml volta a refletir o estado real da máquina.O ficheiro reflete o sistema tal como estava quando o create foi executado. Não se atualiza sozinho: após qualquer alteração significativa ao software, executa create de novo para que show se mantenha fiel à realidade.
Sinopse #
imaxe info <subcomando> [--json]O subcomando create requer privilégios de root (usa sudo) porque escreve em /etc/imaxe/. Em contraste, show apenas lê o inventário e pode correr sem sudo. Adiciona --json a show para obter saída legível por máquina, apta para scripting.
Subcomandos #
| Subcomando | O que faz | Flags relevantes |
|---|---|---|
| create | Sonda o sistema ao vivo e (re)escreve o inventário em /etc/imaxe/info.yaml. | — |
| show | Mostra o inventário guardado em /etc/imaxe/info.yaml. | --json |
| help | Mostra a ajuda do módulo. | — |
Argumentos e flags #
| Flag | Tipo | Por omissão | Descrição |
|---|---|---|---|
| --json | bool | false | Em show, emite o inventário como JSON estruturado em stdout, apto para jq e automação. |
O módulo info não recebe argumentos posicionais: cada subcomando opera sobre o próprio inventário do sistema.
Ficheiros e caminhos #
| Caminho | Conteúdo |
|---|---|
| /etc/imaxe/info.yaml | Inventário da AMI: sistema operativo, software e versões, base de dados e produto imaxe. Puramente descritivo, sem segredos. |
Exemplo 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.0Códigos de saída e logs #
Cada execução devolve um código que podes verificar com echo $? — útil para encadear em scripts:
show sem inventário: executa create primeiro.create sem privilégios para escrever em /etc/imaxe/.Resolução de problemas #
| Sintoma | Causa provável | Solução |
|---|---|---|
| show não mostra nada ou falha | O inventário ainda não foi gerado. | Executa sudo imaxe info create e tenta show de novo. |
| create dá um erro de permissões | Foi executado sem root e não consegue escrever em /etc/imaxe/. | Volta a executá-lo com sudo imaxe info create. |
| O inventário não coincide com a realidade | Foi instalado ou atualizado software depois de ter sido gerado. | Regenera-o com sudo imaxe info create: é uma foto de um instante concreto. |
A saída --json não está limpa | --json foi aplicado a um subcomando que não o suporta. | --json só se aplica a show; usa-o como imaxe info show --json. |
Ficou bloqueado com o módulo Inventário?
Escreva-nos com a saída de «imaxe <module> status --json» e respondemos rapidamente.