Ir para o conteúdo

Documentação

Referências técnicas para entender, executar e raciocinar sobre o Orvienm

Primeiros passosReferência da CLI

Referências técnicas do Alpha atual, na ordem em que são úteis: configurar e executar a CLI, entender o que cada etapa faz, consultar o formato de especificação e os comandos, e então diagnosticar falhas. Cada item leva a uma página que existe hoje.

Código-fonte

A CLI é distribuída como código-fonte em github.com/kw13j1qs0/orvienm-polaris, sob Apache-2.0. Ainda não há release em índice de pacotes; Primeiros passos traz os comandos de clone e instalação.

Comece por aqui

Primeiros passos

Instale a partir do código-fonte, escreva uma especificação e execute validate, plan, apply e verify de ponta a ponta.

Entenda o modelo

Modelo de execução

O que cada etapa lê e escreve, como ler um plano, o que significa desvio e o que conta como convergido.

Modelo de validação

Cada verificação feita antes da execução, como as falhas são reportadas e o que a validação não cobre.

Projeto do Engine

Os módulos que compõem o engine, o que cada um governa e onde fica a fronteira com o sistema de arquivos.

Visão geral da arquitetura

As superfícies que compõem o Orvienm e onde a especificação e o workspace se encaixam entre elas.

Referência

Referência da especificação

Cada chave, valor e regra que o formato de especificação aceita, o lock file e o desvio, e o que este Alpha não suporta.

Referência da CLI

Todos os onze comandos com seus argumentos, flags, comportamento e códigos de saída.

Operação

Solução de problemas

O que cada falha significa, o que verificar e qual o próximo passo seguro — organizado por código de saída.