Guia 09 / 3
Configuração Ansible e casos de negócio
Compreender os ficheiros do projeto, os módulos e sete cenários de automatização diretamente utilizáveis.
Adaptar um projeto Ansible para servidores Linux, Nginx, SSH, Docker Compose e Kubernetes.
01 · Ler a estrutura de um projeto Ansible
Um projeto sustentável separa os alvos, a configuração geral, as variáveis, os scripts e os modelos.
Arborescência recomendada
Separar inventory, playbooks, templates, files, roles e requirements.yml para distinguir o alvo das operações.
Exemplo
ansible.cfg
inventory.ini
site.yml
group_vars/web.yml
templates/site.conf.j2
roles/
ansible.cfg
Configuração local de execução do projeto. O campo inventory evita repetir -i; os outros parâmetros devem ser adaptados.
Exemplo
[defaults]
inventory = inventory.ini
host_key_checking = True
Não desativar a verificação SSH nem os avisos por comodidade.
inventory.ini
Descreve os servidores reais ou virtuais que serão geridos e distribui-os por grupos.
Exemplo
[web]
web1 ansible_host=192.0.2.11
web2 ansible_host=192.0.2.12
[web:vars]
ansible_user=deployer
group_vars/web.yml
Valores comuns aos servidores web de um grupo.
Exemplo
site_hostname: demo.example.test
http_port: 80
requirements.yml
Declara as coleções externas necessárias para reproduzir o projeto noutro posto.
Exemplo
collections:
- name: community.docker
- name: kubernetes.core
02 · Chaves YAML e execução
Os ficheiros de playbook seguem uma hierarquia: play → tarefas → módulo e argumentos.
hosts
Seleciona os anfitriões visados pelo play segundo o inventário.
Exemplo
- hosts: web
Esta chave define o perímetro: controlar os alvos antes de qualquer execução.
name
Dá um título legível a uma tarefa ou a um play e facilita os registos e os diagnósticos.
Exemplo
- name: Configurer nginx
become / become_user
Permite executar tarefas com as permissões de outra conta, muitas vezes root via sudo.
Exemplo
become: true
become_user: root
tasks / handlers
tasks contém as operações a efetuar; handlers as operações desencadeadas apenas após uma alteração.
Exemplo
notify: Recharger nginx
vars / vars_files
Define variáveis diretamente no play ou carrega um ficheiro de variáveis.
Exemplo
vars:
http_port: 8080
when
Condição de execução calculada para cada anfitrião.
Exemplo
when: ansible_facts["os_family"] == "Debian"
loop
Percorre uma lista e expõe cada elemento em item.
Exemplo
loop:
- curl
- git
register
Regista a resposta de um módulo e permite testar changed, failed ou stdout.
Exemplo
register: resultat
notify
Pede a execução diferida de um handler se a tarefa notificadora alterou alguma coisa.
Exemplo
notify: Recharger nginx
serial
Limita o número de anfitriões tratados em simultâneo dentro de um play.
Exemplo
serial: 1
check_mode / changed_when
Ajusta o comportamento do modo de verificação ou a deteção de alteração em casos precisos.
Exemplo
changed_when: false pour une commande d’observation
Evitar mascarar arbitrariamente as alterações ou as falhas.
no_log
Impede a apresentação habitual dos parâmetros e dos resultados sensíveis de uma tarefa.
Exemplo
no_log: true
Não confundir ocultação dos registos com cifragem dos segredos.
03 · Módulos essenciais para os casos de negócio
Cada módulo responde a uma necessidade de negócio específica e possui parâmetros documentados. Os exemplos pressupõem Linux Debian/Ubuntu, salvo menção em contrário.
ansible.builtin.apt
Gere os pacotes Debian/Ubuntu segundo o estado desejado.
Exemplo
ansible.builtin.apt:
name: nginx
state: present
update_cache: true
ansible.builtin.package
Interface genérica de gestão de pacotes; delega num gestor subjacente.
Exemplo
ansible.builtin.package:
name: curl
state: present
ansible.builtin.file
Gere pastas, permissões, ligações e eliminações de caminhos.
Exemplo
ansible.builtin.file:
path: /opt/monapp
state: directory
mode: "0755"
ansible.builtin.copy
Transfere um ficheiro estático ou cria um ficheiro através de content.
Exemplo
ansible.builtin.copy:
src: files/index.html
dest: /var/www/html/index.html
ansible.builtin.template
Renderiza um modelo Jinja2 no alvo, com variáveis e eventualmente um comando de validação.
Exemplo
ansible.builtin.template:
src: templates/site.conf.j2
dest: /etc/nginx/sites-available/site
backup: true
Depois da renderização, executar nginx -t antes de recarregar o serviço; backup: true conserva a versão anterior.
ansible.builtin.service
Assegura que um serviço está iniciado, parado ou ativado no arranque.
Exemplo
ansible.builtin.service:
name: nginx
state: started
enabled: true
ansible.builtin.user
Cria e configura contas Unix segundo os parâmetros definidos.
Exemplo
ansible.builtin.user:
name: deploiement
state: present
community.docker.docker_compose_v2
Comanda os serviços de uma pasta Compose através do plugin Docker Compose V2 disponível no anfitrião.
Exemplo
community.docker.docker_compose_v2:
project_src: /opt/portail
state: present
Exige a coleção community.docker, o Docker e o plugin Compose na máquina visada.
kubernetes.core.k8s
Cria, atualiza ou elimina recursos Kubernetes através da API.
Exemplo
kubernetes.core.k8s:
state: present
definition: "{{ lookup('file', 'manifests/web.yaml') | from_yaml }}"
Exige a coleção, as dependências Python e um kubeconfig autorizado.
04 · Método de colocação em produção
Um caso de negócio Ansible acompanha-se de um método de controlo, de retorno e de verificação do serviço.
Antes da modificação
Fazer o inventário, verificar os direitos, versionar o playbook e guardar cópias de segurança dos ficheiros importantes.
Exemplo
ansible-playbook -i inventory.ini site.yml --list-hosts
Controlo de sintaxe
Validar a estrutura YAML e as referências dos módulos.
Exemplo
ansible-playbook -i inventory.ini site.yml --syntax-check
Simulação
Estimar as alterações e verificar as diferenças num anfitrião de TP.
Exemplo
ansible-playbook -i inventory.ini site.yml --limit web1 --check --diff
Um módulo pode não anunciar todas as suas ações no modo de verificação.
Implementação progressiva
Fazer uma primeira implementação num anfitrião piloto antes de alargar aos outros.
Exemplo
ansible-playbook -i inventory.ini site.yml --limit web1
Verificação de negócio
Testar o resultado funcional além do resumo do Ansible.
Exemplo
curl -I http://192.0.2.11/
Uma tarefa «ok» não prova a disponibilidade da aplicação.
Retorno atrás
Prever o regresso a uma configuração conhecida, a uma versão de imagem anterior e às cópias de segurança.
Exemplo
git checkout <revision> puis relance contrôlée du playbook
Fazer o rollback do código e restaurar os dados são duas operações diferentes.
05 · Caso de negócio A — Preparar uma frota de servidores Linux
NECESSIDADE: Um administrador SysOps quer preparar várias VM Ubuntu com as mesmas ferramentas, direitos e uma arborescência de base.
PRÉ-REQUISITOS: É necessário dispor de um acesso SSH, de uma conta que possa utilizar sudo e de repositórios APT acessíveis.
Realização · playbook 01-preparer-serveurs.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Preparations communes des serveurs Ubuntu
hosts: web
become: true
gather_facts: true
tasks:
- name: Verifier le systeme d'exploitation
ansible.builtin.assert:
that:
- ansible_facts['os_family'] == 'Debian'
fail_msg: "Ce cas vise Debian et Ubuntu."
- name: Mettre a jour le cache des paquets
ansible.builtin.apt:
update_cache: true
cache_valid_time: 3600
- name: Installer les outils d'exploitation
ansible.builtin.apt:
name: [curl, git, htop, ca-certificates]
state: present
- name: Creer un dossier applicatif
ansible.builtin.file:
path: /opt/portail
state: directory
mode: '0755'
A controlar: Validação: apt list --installed, presença de /opt/portail. Limite: não funciona tal como está em RHEL.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 01-preparer-serveurs.yml --syntax-check
ansible-playbook -i inventory.ini 01-preparer-serveurs.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 01-preparer-serveurs.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
06 · Caso de negócio B — Publicar um site web Nginx reproduzível
NECESSIDADE: Um responsável de exploração deve instalar o Nginx, publicar uma página HTML e criar um virtual host a partir de variáveis.
PRÉ-REQUISITOS: Instalar o módulo apt, fornecer files/index.html e templates/site.conf.j2, dispor de um DNS ou de /etc/hosts adequado.
Realização · playbook 02-deployer-nginx.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Installer et configurer le serveur web
hosts: web
become: true
vars:
site_hostname: demo.example.test
tasks:
- name: Installer nginx
ansible.builtin.apt:
name: nginx
state: present
update_cache: true
- name: Deployer la page d'accueil
ansible.builtin.copy:
src: files/index.html
dest: /var/www/html/index.html
owner: root
group: root
mode: '0644'
- name: Generer le virtual host
ansible.builtin.template:
src: templates/site.conf.j2
dest: /etc/nginx/sites-available/demo
owner: root
group: root
mode: '0644'
notify: Recharger nginx
- name: Activer le site
ansible.builtin.file:
src: /etc/nginx/sites-available/demo
dest: /etc/nginx/sites-enabled/demo
state: link
notify: Recharger nginx
- name: Valider la configuration nginx
ansible.builtin.command: nginx -t
changed_when: false
- name: Demarrer nginx au boot
ansible.builtin.service:
name: nginx
state: started
enabled: true
handlers:
- name: Recharger nginx
ansible.builtin.service:
name: nginx
state: reloaded
A controlar: Validação: nginx -t e depois curl -H "Host: demo.example.test" http://IP_DU_SERVEUR/ ; prever a validação da configuração antes do recarregamento em produção.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 02-deployer-nginx.yml --syntax-check
ansible-playbook -i inventory.ini 02-deployer-nginx.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 02-deployer-nginx.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
Ficheiro associado: 02-site.conf.j2
Recurso complementar utilizado pelo playbook. Conservar o nome e o caminho esperados e adaptar depois os valores ao TP.
Exemplo
server {
listen 80;
server_name {{ site_hostname }};
root /var/www/html;
index index.html;
location / { try_files $uri $uri/ =404; }
}
Estes ficheiros fazem também parte do ZIP dos exemplos.
Ficheiro associado: 02-index.html
Recurso complementar utilizado pelo playbook. Conservar o nome e o caminho esperados e adaptar depois os valores ao TP.
Exemplo
<!doctype html>
<html lang="fr"><meta charset="utf-8">
<title>Atelier Ansible</title><h1>Deploiement Ansible OK</h1>
Estes ficheiros fazem também parte do ZIP dos exemplos.
07 · Caso de negócio C — Gerir as contas e os acessos SSH
NECESSIDADE: Uma equipa de exploração cria uma conta de implementação única e associa-lhe uma chave pública aprovada.
PRÉ-REQUISITOS: Preparar files/deploiement.pub; instalar ansible.posix a partir de requirements.yml.
Realização · playbook 03-acces-ssh.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Creer un compte de deploiement
hosts: web
become: true
tasks:
- name: Creer le compte applicatif
ansible.builtin.user:
name: deploiement
shell: /bin/bash
create_home: true
state: present
- name: Installer sa cle publique
ansible.posix.authorized_key:
user: deploiement
key: "{{ lookup('file', 'files/deploiement.pub') }}"
state: present
A controlar: Validação: ssh -i CHEMIN_CLE deploiement@IP ; nunca suprimir o acesso existente antes de verificar o novo.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 03-acces-ssh.yml --syntax-check
ansible-playbook -i inventory.ini 03-acces-ssh.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 03-acces-ssh.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
08 · Caso de negócio D — Planear as atualizações por lotes
NECESSIDADE: Um administrador deve aplicar as correções nos servidores web sem os interromper todos em simultâneo.
PRÉ-REQUISITOS: Prever uma janela de manutenção, uma cópia de segurança e pelo menos alguma capacidade aplicacional restante durante serial: 1.
Realização · playbook 04-maintenance.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Maintenir les serveurs successivement
hosts: web
become: true
serial: 1
tasks:
- name: Installer les correctifs disponibles
ansible.builtin.apt:
update_cache: true
upgrade: safe
- name: Detecter un redemarrage demande par Ubuntu
ansible.builtin.stat:
path: /var/run/reboot-required
register: reboot_requis
- name: Redemarrer uniquement si necessaire
ansible.builtin.reboot:
reboot_timeout: 600
when: reboot_requis.stat.exists
A controlar: Validação: versões dos pacotes e disponibilidade aplicacional; a estratégia de reboot deve ser adaptada à exploração.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 04-maintenance.yml --syntax-check
ansible-playbook -i inventory.ini 04-maintenance.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 04-maintenance.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
09 · Caso de negócio E — Implementar uma aplicação Docker Compose
NECESSIDADE: Uma equipa DevOps reutiliza os seus conhecimentos de Docker: o Ansible copia o ficheiro Compose e assegura o arranque do serviço.
PRÉ-REQUISITOS: Docker Engine, plugin Compose V2 e community.docker instalados nas respetivas máquinas.
Realização · playbook 05-docker-compose.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Deployer une application Docker Compose
hosts: web
become: true
tasks:
- name: Creer le dossier du projet
ansible.builtin.file:
path: /opt/portail
state: directory
mode: '0755'
- name: Publier compose.yaml
ansible.builtin.copy:
src: files/compose.yaml
dest: /opt/portail/compose.yaml
mode: '0644'
- name: Lancer la stack Compose
community.docker.docker_compose_v2:
project_src: /opt/portail
state: present
A controlar: Validação: docker compose -f /opt/portail/compose.yaml ps ; HTTP na porta 8080 se a rede o permitir.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 05-docker-compose.yml --syntax-check
ansible-playbook -i inventory.ini 05-docker-compose.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 05-docker-compose.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
Ficheiro associado: 05-compose.yaml
Recurso complementar utilizado pelo playbook. Conservar o nome e o caminho esperados e adaptar depois os valores ao TP.
Exemplo
services:
web:
image: nginx:stable-alpine
ports:
- "8080:80"
restart: unless-stopped
Estes ficheiros fazem também parte do ZIP dos exemplos.
10 · Caso de negócio F — Implementar objetos Kubernetes
NECESSIDADE: Uma equipa de Platform Engineering utiliza o Ansible para aplicar um manifesto através da API Kubernetes, sem comando kubectl em shell.
PRÉ-REQUISITOS: Cluster acessível a partir do nó de controlo, kubeconfig autorizado, coleção kubernetes.core e respetivas dependências Python.
Realização · playbook 06-kubernetes.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Publier une ressource sur Kubernetes
hosts: localhost
gather_facts: false
tasks:
- name: Appliquer le manifeste YAML via l'API
kubernetes.core.k8s:
state: present
definition: "{{ lookup('file', 'manifests/web.yaml') | from_yaml }}"
A controlar: Validação: kubectl get configmap demo-ansible ; nunca publicar segredos em claro.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 06-kubernetes.yml --syntax-check
ansible-playbook -i inventory.ini 06-kubernetes.yml --check
ansible-playbook -i inventory.ini 06-kubernetes.yml
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.
Ficheiro associado: 06-web.yaml
Recurso complementar utilizado pelo playbook. Conservar o nome e o caminho esperados e adaptar depois os valores ao TP.
Exemplo
apiVersion: v1
kind: ConfigMap
metadata:
name: demo-ansible
namespace: default
data:
MESSAGE: "Configuration geree par Ansible"
Estes ficheiros fazem também parte do ZIP dos exemplos.
11 · Caso de negócio G — Auditar a conformidade dos servidores
NECESSIDADE: Um responsável de SI quer provar que o serviço Nginx está presente e ativo num conjunto de nós.
PRÉ-REQUISITOS: Nginx instalado na frota e direitos necessários para consultar o estado dos serviços.
Realização · playbook 07-audit.yml
O playbook abaixo pode ser copiado diretamente para um ficheiro YAML. Identificar hosts, os módulos chamados e os efeitos esperados antes da execução.
Exemplo
---
- name: Observer la conformite des serveurs
hosts: web
become: true
tasks:
- name: Collecter les services
ansible.builtin.service_facts:
- name: Verifier que nginx est actif
ansible.builtin.assert:
that:
- "'nginx.service' in ansible_facts.services"
- "ansible_facts.services['nginx.service'].state == 'running'"
fail_msg: "Nginx ne fonctionne pas sur cet hote."
- name: Donner le bilan
ansible.builtin.debug:
msg: "Nginx actif sur {{ inventory_hostname }}"
A controlar: Validação: saída por anfitrião; uma auditoria é uma fotografia do estado, e não um sistema completo de supervisão.
Comando de execução
Verificar o alvo e a sintaxe e executar depois apenas nas máquinas ou no cluster de formação.
Exemplo
ansible-playbook -i inventory.ini 07-audit.yml --syntax-check
ansible-playbook -i inventory.ini 07-audit.yml --limit web1 --check --diff
ansible-playbook -i inventory.ini 07-audit.yml --limit web1
Para os casos que utilizam localhost ou módulos que não simulam tudo: ajustar as opções e confirmar os pré-requisitos. O exemplo D pode provocar um reinício real.