Conceitos
Os termos usados ao longo desta documentação, cada um com ligação para a sua página
Glossário
Os termos usados ao longo desta documentação:
| Termo | Significado |
|---|---|
| Formulário | Uma definição YAML que recolhe dados e executa um playbook, um template ou um workflow |
| Campo de formulário | Uma entrada de um formulário, como text, enum ou checkbox; o seu valor torna-se uma extravar |
| Categoria | Um grupo na árvore de formulários mostrada na página Formulários, definido em config.yaml |
| Função | Um conjunto de utilizadores e grupos; um formulário lista as funções que o podem ver e executar, default para toda a gente |
| Expressão | JavaScript que calcula o valor de um campo, no navegador (runLocal: true) ou no servidor |
| Extravars | As variáveis enviadas ao playbook ou ao template, construídas a partir dos valores dos campos |
| Credencial | Um início de sessão guardado, cifrado com ENCRYPTION_SECRET: um utilizador e uma palavra-passe (e host, porta, base de dados), ou desde a 7.3.0 o endereço e os segredos de um diretório LDAP, de um fornecedor de SSO, de um runner ou de um HashiCorp Vault |
| Cofre de segredos | Uma ligação ao HashiCorp Vault ou ao CyberArk que fornece o utilizador e a palavra-passe de uma credencial |
| Tarefa | Uma execução de um formulário, com o seu estado, extravars e saída, guardada no histórico de tarefas |
| Runner | Onde uma tarefa é executada, adicionado em Ligações > Runners: rte para playbooks, awx (AWX, ou as variantes aap ou ascender), semaphore, rundeck ou jenkins para templates e jobs. Um formulário escolhe um com runner:, ou é executado no runner predefinido rte (playbooks) ou awx (templates) |
| RTE | Um ambiente de execução: o servidor AnsibleForms iniciado com AF_ROLE=rte no seu próprio contentor, ao lado de python e ansible, que executa os playbooks de um runner do tipo rte |
| Ponto de aprovação | Uma pausa numa tarefa até que um utilizador com uma função de aprovação a aprove ou rejeite |
| Workflow | Um grafo de playbooks, aprovações e outros workflows ligados em caso de sucesso, de falha ou sempre, com a sintaxe do AWX |
| Formulário multistep | Descontinuado desde a 7: um formulário que executa vários playbooks ou templates em sequência; um workflow substitui-o |
| Canal de notificação | Um servidor de email, um webhook do Slack ou do Teams, um chat do Telegram ou um webhook para onde vão as notificações e os pedidos de aprovação |
| Designer | O editor no navegador para formulários, playbooks, inventários e workflows, usado por uma pessoa de cada vez |
| Subform | Um conjunto reutilizável de campos que descreve as linhas de um campo list ou o objeto de um campo yaml |
| config.yaml | O ficheiro com as categorias, as funções e as constantes; os formulários vivem nos seus próprios ficheiros |
| Config seed | Um ficheiro YAML (CONFIG_SEED_PATH) que declara os objetos de administração, como runners e credenciais |
| Pasta persistente | A pasta que contém os ficheiros que o AnsibleForms tem de manter entre reinícios e atualizações |