Nomes, comentários e estilo que escalam
Convenções que mantêm os projetos legíveis.
Nomes, comentários e estilo que escalam é uma aula grátis de Ansible Academy no CoddyKit. Esta é a aula 4 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Ansible Academy, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Ansible Academy inclui 4 aulas no total.
Estilo não é opcional
Os playbooks são lidos muito mais vezes do que escritos. Uma nomenclatura e um estilo consistentes transformam um script pessoal em uma automação pronta para a equipe. ✨
Dê sempre um nome às suas tarefas
Dê a cada tarefa um name claro. Tarefas nomeadas tornam a saída da execução legível e informam a intenção à equipe de imediato.
- name: Install the nginx web server
package:
name: nginx
state: presentEscreva nomes como ações
Formule os nomes como ações claras, como Instalar nginx ou Criar usuário de implantação. Durante a execução do play, eles são lidos como uma lista de verificação.
Prefira módulos nativos
Prefira um módulo de verdade ao módulo shell ou command. Os módulos são idempotentes e autodocumentados; os comandos brutos não são.
Use YAML, não key=value
Escreva os argumentos dos módulos usando o estilo de bloco do YAML, uma chave por linha, em vez de colocar tudo em uma única sequência na mesma linha.
- name: Ensure dir exists
file:
path: /opt/app
state: directoryOs comentários explicam o motivo
Use um # comentário para explicar o motivo, não o que acontece. O nome da tarefa já informa o que ela faz; os comentários registram a razão ou uma particularidade importante.
# Pin version: 1.20 broke our TLS config
- name: Install nginx 1.18
package:
name: nginx=1.18*Nomes de variáveis consistentes
Dê nomes às variáveis usando lower snake_case e prefixe as variáveis da função com o nome da função para evitar conflitos, como nginx_port.
Coloque aspas quando estiver em dúvida
Coloque entre aspas qualquer valor que comece com {{ ou que possa ser interpretado como número ou booleano, para que o YAML nunca deduza o tipo incorretamente.
msg: "{{ greeting }}"
version: "1.10"Indentação de dois espaços
Use dois espaços por nível e nunca tabulações. O YAML diferencia espaços em branco, portanto misturar tipos de indentação interrompe a análise.
Deixe o ansible-lint impor o padrão
Execute o ansible-lint para detectar automaticamente problemas de estilo e de boas práticas. Deixe a ferramenta fiscalizar as convenções para que as revisões se concentrem na lógica.
ansible-lint site.ymlArquivos pequenos e focados
Mantenha cada arquivo responsável por uma função. Um arquivo de tarefas curto e bem nomeado é mais fácil de testar, reutilizar e compreender do que um arquivo enorme. 🎯
Verificação rápida
Qual é o principal motivo para adicionar um name a cada tarefa?
Recapitulação
Você aprendeu a nomear cada tarefa, preferir módulos ao shell, escrever YAML claro, comentar o motivo e deixar o ansible-lint impor o estilo. ✅
Perguntas Frequentes
A aula “Nomes, comentários e estilo que escalam” é grátis?
Sim — o texto completo de “Nomes, comentários e estilo que escalam” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Ansible Academy, atualize para CoddyKit PRO. O curso de Ansible Academy inclui 4 aulas no total.
O que vou aprender em “Nomes, comentários e estilo que escalam”?
Convenções que mantêm os projetos legíveis. Você pratica Ansible Academy com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.
Preciso ter experiência prévia para começar Ansible Academy?
Nenhuma experiência prévia é necessária. Ansible Academy no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 4 de 4.
Quanto tempo leva a aula “Nomes, comentários e estilo que escalam”?
A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.
Posso escrever e executar código nesta aula de Ansible Academy?
Sim. Cada aula de Ansible Academy inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.
Todas as aulas deste curso
- A organização de diretórios recomendada
- Diretórios group_vars e host_vars
- Dividindo playbooks com import e include
- Nomes, comentários e estilo que escalam