Designer
Editar formulários, playbooks, inventários e workflows no navegador
Para autores de formulários: as secções do designer, e o que mostra cada um dos seus separadores.
O designer precisa da opção de função showDesigner. Edita um item de cada vez, um formulário, um playbook ou um ficheiro de workflow, com as suas secções no menu da esquerda. Cada tipo de ficheiro precisa também da sua própria opção, todas ligadas por predefinição: allowPlaybookDesign para os Playbooks, allowWorkflowDesign para os Fluxos de trabalho, allowInventoryDesign para os Inventários e allowVarsFileDesign para os Ficheiros de variáveis. Sem uma delas, a sua secção fica só de leitura e o servidor recusa-se a guardar, criar, remover ou enviar (push) os seus ficheiros; os formulários e os workflows continuam a poder escolhê-los. Os Formulários, as Categorias e as Constantes precisam de allowFormDesign da mesma forma: sem ela ficam só de leitura, e o servidor recusa-se a guardá-los, a fazer pull ou a enviá-los. Só uma pessoa edita de cada vez: ver O bloqueio do designer. Uma função também pode esconder os formulários, playbooks e workflows de outras equipas: ver Designers limitados.
As suas secções
Cada secção edita um tipo de ficheiro, guardado localmente ou num repositório:
| Secção | O que edita |
|---|---|
| Formulários | Os ficheiros de formulários |
| Categorias | As categorias do config.yaml |
| Constantes | As constantes do config.yaml |
| Ficheiros de variáveis | Os ficheiros de variáveis que os formulários carregam |
| Playbooks | Os playbooks que os formulários e os workflows executam |
| Inventários | Os inventários: inventory.yaml, group_vars e host_vars |
| Fluxos de trabalho | Os ficheiros de workflow |
As secções com ficheiros listam-nos num explorador de ficheiros e abrem o primeiro; uma secção ainda sem ficheiros indica-o. A secção Formulários e todas as secções de ficheiros têm um botão Novo ficheiro em primeiro lugar na sua barra de ferramentas: nos Inventários cria um novo inventário, nos Fluxos de trabalho um workflow novo e vazio. A lupa do explorador abre uma caixa que filtra os seus ficheiros pelo nome.
A caixa de pesquisa na linha do título encontra um texto no YAML que está aberto: marca todos os sítios onde aparece. Funciona no separador YAML, depois de o bloqueio do designer ser seu.
Os seus separadores
Todas as secções têm os mesmos três separadores, todos sobre o mesmo YAML: uma edição num aparece nos outros, e Guardar guarda-a.
- YAML é o ficheiro tal como está escrito.
- Visual edita-o com campos. Só mudam as chaves em que uma edição toca, pelo que os comentários e o resto ficam como estavam escritos.
- Pré-visualização mostra o que faz, e não edita nada.
O que mostram os separadores Visual e Pré-visualização, secção a secção:
| Secção | Visual | Pré-visualização |
|---|---|---|
| Formulários | As definições do formulário e os seus campos, com listas dos playbooks, inventários e workflows do designer | O formulário tal como está agora, incluindo as edições não guardadas; o seu envio não executa nada |
| Categorias | As categorias como tabela, editadas | O menu da página Formulários, construído a partir delas |
| Constantes | As constantes como estrutura em árvore, editadas (uma chave move-se com as teclas de seta) | Cada constante com a sua referência, $(NAME), para copiar, e os formulários que a usam |
| Ficheiros de variáveis | As variáveis, editadas | Cada variável com a sua referência num playbook, {{ name }}, para copiar, e os formulários que carregam o ficheiro |
| Playbooks | Os plays: o nome, os hosts, Become, Recolher facts e as roles de cada play, e as suas tarefas, cada uma com o seu módulo e argumentos | A estrutura do playbook: os seus plays, com os seus hosts, roles e tarefas, e os playbooks que importa |
| Inventários | Os grupos, os seus grupos filhos, os seus hosts e as variáveis que cada um define | O inventário como árvore, com os seus group_vars e host_vars |
| Fluxos de trabalho | O grafo do workflow, para o editar | Um ensaio: clique num nó para o fazer falhar |
Quando o YAML não pode ser lido, os separadores Visual e Pré-visualização dizem porquê, com Ver em YAML para abrir o YAML na linha.
Designers limitados
A partir da 7.5.0, três opções de função limitam que formulários, playbooks e workflows o designer mostra, para que cada equipa desenhe os seus. As três estão ligadas por predefinição e sempre ligadas para os admins:
| Opção | Desligada, o designer mostra só |
|---|---|
designAllForms (Editar Todos os Formulários) | Os formulários cujos roles contêm uma das funções do utilizador, e os subformulários que nenhum formulário escondido usa |
designAllPlaybooks (Editar Todos os Playbooks) | Os playbooks que os formulários do utilizador executam, e os que nenhum formulário usa ainda |
designAllWorkflows (Editar Todos os Fluxos de trabalho) | Os ficheiros de workflow que os formulários do utilizador executam, aninhados incluídos, e os que nenhum formulário usa ainda |
Um formulário executa um playbook através do seu playbook, dos seus passos ansible e dos workflows que executa. O que um designer limitado não pode fazer:
- Ver um ficheiro escondido. Nunca é listado nem nomeado: abrir um responde como um ficheiro que não existe, e um ficheiro novo com o seu nome como um ficheiro que já existe.
- Apontar para um. Um formulário que nomeia um formulário escondido como subformulário não mostra nada dele, e um formulário ou ficheiro de workflow que nomeia um playbook ou workflow escondido é recusado.
- Alterar um subformulário partilhado. Um subformulário que um formulário escondido também usa fica só de leitura, e um formulário guardado tem de manter uma das funções do utilizador.
- Mexer nos formulários escondidos de um ficheiro. Um ficheiro com vários formulários mantém os escondidos como estão ao guardar, e a restauração de uma cópia de segurança dos formulários é recusada.
- Acrescentar código que o servidor executa. Um formulário guardado não pode ganhar uma expressão nem uma consulta que o servidor execute, e a pré-visualização de um formulário ainda não guardado não executa nenhuma expressão própria.
- Ler nomes de ficheiros na saída do git. A saída de um pull ou de um push omite as linhas que nomeiam ficheiros.
allowFormDesign, allowPlaybookDesign e allowWorkflowDesign continuam a decidir se os ficheiros mostrados podem ser alterados. Os inventários, ficheiros de variáveis, categorias e constantes continuam visíveis para todos os designers. Um utilizador com só uma parte das definições vê só os seus próprios formulários e ficheiros de workflow nos separadores Formulários das páginas de definições e no separador Usado por de uma credencial.