Execução Condicional Baseada na Saída do Shell
Uma das capacidades mais poderosas do Ansible é a capacidade de tomar decisões com base na saída de comandos shell. Nesta etapa, aprenderemos como usar condições e filtros para processar a saída de comandos shell e tornar os playbooks mais dinâmicos.
Usando Condições com Saída do Shell
Vamos criar um playbook que toma decisões com base na saída do comando shell:
- Crie um novo arquivo chamado
conditional_playbook.yml no diretório /home/labex/project.
- Adicione o seguinte conteúdo:
---
- name: Conditional Tasks Based on Command Output
hosts: local
gather_facts: no
tasks:
- name: Check disk space
shell: df -h / | grep -v Filesystem | awk '{print $5}' | sed 's/%//'
register: disk_usage
- name: Display disk usage
debug:
msg: "Current disk usage: {{ disk_usage.stdout }}%"
- name: Disk usage warning
debug:
msg: "WARNING: Disk usage is high"
when: disk_usage.stdout|int > 50
- name: Disk usage normal
debug:
msg: "Disk usage is normal"
when: disk_usage.stdout|int <= 50
Este playbook:
- Executa um comando shell para verificar a porcentagem de uso do disco no sistema de arquivos raiz
- Usa a condição
when com base na saída do comando
- Usa o filtro
int para converter a saída da string em um inteiro para comparação
Execute o playbook:
ansible-playbook -i inventory.ini conditional_playbook.yml
A saída variará dependendo do seu uso real do disco, mas terá uma aparência semelhante a esta:
PLAY [Conditional Tasks Based on Command Output] ******************************
TASK [Check disk space] *******************************************************
changed: [localhost]
TASK [Display disk usage] *****************************************************
ok: [localhost] => {
"msg": "Current disk usage: 38%"
}
TASK [Disk usage warning] *****************************************************
skipped: [localhost]
TASK [Disk usage normal] ******************************************************
ok: [localhost] => {
"msg": "Disk usage is normal"
}
PLAY RECAP ********************************************************************
localhost : ok=3 changed=1 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0
Observe como o Ansible executou apenas uma das tarefas condicionais com base no valor real de uso do disco.
Manipulando Saída JSON de Comandos
Muitas ferramentas CLI modernas retornam dados em formato JSON. O Ansible possui recursos integrados para lidar com a saída JSON:
- Crie um novo arquivo chamado
json_output.yml no diretório /home/labex/project.
- Adicione o seguinte conteúdo:
---
- name: Handling JSON Output
hosts: local
gather_facts: no
tasks:
- name: Create a JSON file for testing
copy:
dest: /tmp/services.json
content: |
{
"services": [
{
"name": "web",
"status": "running",
"port": 80
},
{
"name": "database",
"status": "stopped",
"port": 5432
},
{
"name": "cache",
"status": "running",
"port": 6379
}
]
}
- name: Read JSON file with shell
shell: cat /tmp/services.json
register: json_output
- name: Parse and display JSON content
debug:
msg: "{{ json_output.stdout | from_json }}"
- name: Extract and display service information
debug:
msg: "Service: {{ item.name }}, Status: {{ item.status }}, Port: {{ item.port }}"
loop: "{{ (json_output.stdout | from_json).services }}"
- name: Show only running services
debug:
msg: "Running service: {{ item.name }} on port {{ item.port }}"
loop: "{{ (json_output.stdout | from_json).services }}"
when: item.status == "running"
Este playbook:
- Cria um arquivo JSON de amostra para demonstração
- Lê o arquivo JSON com um comando shell
- Usa o filtro
from_json para analisar a string JSON em uma estrutura de dados
- Percorre a estrutura de dados para exibir informações
- Usa lógica condicional para filtrar apenas os serviços em execução
Execute o playbook:
ansible-playbook -i inventory.ini json_output.yml
Você deve ver uma saída semelhante a esta:
PLAY [Handling JSON Output] ***************************************************
TASK [Create a JSON file for testing] *****************************************
changed: [localhost]
TASK [Read JSON file with shell] **********************************************
changed: [localhost]
TASK [Parse and display JSON content] *****************************************
ok: [localhost] => {
"msg": {
"services": [
{
"name": "web",
"port": 80,
"status": "running"
},
{
"name": "database",
"port": 5432,
"status": "stopped"
},
{
"name": "cache",
"port": 6379,
"status": "running"
}
]
}
}
TASK [Extract and display service information] ********************************
ok: [localhost] => (item={'name': 'web', 'status': 'running', 'port': 80}) => {
"msg": "Service: web, Status: running, Port: 80"
}
ok: [localhost] => (item={'name': 'database', 'status': 'stopped', 'port': 5432}) => {
"msg": "Service: database, Status: stopped, Port: 5432"
}
ok: [localhost] => (item={'name': 'cache', 'status': 'running', 'port': 6379}) => {
"msg": "Service: cache, Status: running, Port: 6379"
}
TASK [Show only running services] *********************************************
ok: [localhost] => (item={'name': 'web', 'status': 'running', 'port': 80}) => {
"msg": "Running service: web on port 80"
}
skipped: [localhost] => (item={'name': 'database', 'status': 'stopped', 'port': 5432})
ok: [localhost] => (item={'name': 'cache', 'status': 'running', 'port': 6379}) => {
"msg": "Running service: cache on port 6379"
}
PLAY RECAP ********************************************************************
localhost : ok=5 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
Observe como o playbook analisa o JSON, extrai informações específicas e filtra os dados com base em condições.
Tratamento de Erros com Comandos Shell
Ao executar comandos shell, é importante lidar com possíveis erros de forma adequada:
- Crie um novo arquivo chamado
error_handling.yml no diretório /home/labex/project.
- Adicione o seguinte conteúdo:
---
- name: Error Handling with Shell Commands
hosts: local
gather_facts: no
tasks:
- name: Run a potentially failing command
shell: grep "nonexistent_pattern" /etc/passwd
register: command_result
ignore_errors: yes
- name: Display success or failure
debug:
msg: "Command {{ 'succeeded' if command_result.rc == 0 else 'failed with return code ' + command_result.rc|string }}"
- name: Run a custom failing command
shell: exit 3
register: exit_command
ignore_errors: yes
- name: Display detailed error information
debug:
msg: |
Return code: {{ exit_command.rc }}
Error message: {{ exit_command.stderr if exit_command.stderr else 'No error message' }}
Este playbook:
- Executa comandos que devem falhar
- Usa
ignore_errors: yes para continuar a execução do playbook mesmo quando os comandos falham
- Mostra diferentes métodos para lidar e exibir informações de erro
Execute o playbook:
ansible-playbook -i inventory.ini error_handling.yml
Você deve ver uma saída semelhante a esta:
PLAY [Error Handling with Shell Commands] *************************************
TASK [Run a potentially failing command] **************************************
fatal: [localhost]: FAILED! => {"changed": true, "cmd": "grep \"nonexistent_pattern\" /etc/passwd", "delta": "0:00:00.002916", "end": "2023-07-14 16:10:23.671519", "msg": "non-zero return code", "rc": 1, "start": "2023-07-14 16:10:23.668603", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}
...ignoring
TASK [Display success or failure] *********************************************
ok: [localhost] => {
"msg": "Command failed with return code 1"
}
TASK [Run a custom failing command] *******************************************
fatal: [localhost]: FAILED! => {"changed": true, "cmd": "exit 3", "delta": "0:00:00.002447", "end": "2023-07-14 16:10:23.906121", "msg": "non-zero return code", "rc": 3, "start": "2023-07-14 16:10:23.903674", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}
...ignoring
TASK [Display detailed error information] *************************************
ok: [localhost] => {
"msg": "Return code: 3\nError message: No error message\n"
}
PLAY RECAP ********************************************************************
localhost : ok=3 changed=2 unreachable=0 failed=0 skipped=0 rescued=0 ignored=2
Isso demonstra como capturar e responder a diferentes condições de erro ao executar comandos shell.
