Como Usar o Ansible para Instalar e Configurar o Apache no Ubuntu 18.04

Introdução

A automação de servidores desempenha agora um papel essencial na administração de sistemas, devido à natureza descartável dos ambientes das aplicações modernas. Ferramentas de Gerenciamento de configuração tais como o Ansible são normalmente usadas para otimizar o processo de automatização da configuração do servidor, estabelecendo procedimentos padrão para novos servidores e reduzindo também o erro humano associado às configurações manuais.

O Ansible oferece uma arquitetura simples que não requer a instalação de software especial nos nodes. Ele também fornece um conjunto robusto de recursos e módulos internos que facilitam a criação de scripts de automação.

Este guia explica como usar o Ansible para automatizar os passos contidos em nosso guia Como Instalar o Servidor Web Apache no Ubuntu 18.04. O servidor HTTP Apache é o servidor web mais utilizado no mundo. Ele fornece muitos recursos poderosos, incluindo módulos dinamicamente carregáveis, suporte robusto à mídia e ampla integração com outros softwares populares.

Pré-requisitos

Para executar a configuração automatizada fornecida pelo playbook que estamos discutindo neste guia, você precisará de:

• Um node de controle Ansible: uma máquina Ubuntu 18.04 com o Ansible instalado e configurado para conectar aos seus hosts Ansible usando chaves SSH. Certifique-se de que o node de controle possui um usuário regular com permissões sudo e um firewall ativado, conforme explicado em nosso guia Configuração Inicial de servidor. Para configurar o Ansible, siga nosso guia em Como instalar e configurar o Ansible no Ubuntu 18.04.
• Um ou mais Hosts Ansible: um ou mais servidores remotos Ubuntu 18.04 previamente configurados, seguindo o guia How to Use Ansible to Automate Initial Server Setup on Ubuntu 18.04.

O que Este Playbook Faz?

Este Playbook Ansible fornece uma alternativa à execução manual do procedimento descrito em nosso guia sobre Como Instalar o Servidor Web Apache no Ubuntu 18.04.

A execução deste playbook executará as seguintes ações nos hosts Ansible:

1. Instalar o aptitude, que é preferido pelo Ansible como uma alternativa ao gerenciador de pacotes apt.
2. Instalar o Apache.
3. Criar uma pasta raiz de documentos personalizada para o novo VirtualHost do Apache e configurar uma página de teste.
4. Ativar o novo VirtualHost do Apache.
5. Desativar o site padrão do Apache quando a variável disable_default é definida para true.
6. Configurar o UFW para permitir o tráfego HTTP na porta configurada (80 por padrão).

Quando o playbook terminar de ser executado, você terá um servidor web em execução no seu node de destino, com base nas opções que você definiu nas variáveis de configuração.

Como Usar Este Playbook

A primeira coisa que precisamos fazer é obter o playbook do Apache e suas dependências no repositório do-community/ansible-playbooks. Precisamos clonar esse repositório em uma pasta local dentro do Node de Controle Ansible

Caso você tenha clonado este repositório antes, enquanto seguia um guia diferente, acesse sua cópia existente do ansible-playbooks e execute um comando git pull para garantir que você tenha conteúdo atualizado:

cd ~/ansible-playbooks
git pull

Se esta é sua primeira vez usando o repositório do-community/ansible-playbooks, você deve começar clonando o repositório na sua pasta home com:

cd ~
git clone https://github.com/do-community/ansible-playbooks.git
cd ansible-playbooks

Os arquivos em que estamos interessados estão localizados dentro da pasta apache_ubuntu1804, que possui a seguinte estrutura:

apache_ubuntu1804
├── files
│   ├── apache.conf.j2
│   └── index.html.j2
├── vars
│   └── default.yml
├── playbook.yml
└── readme.md

Aqui está o que cada um desses arquivos representa:

• files/apache.conf.j2: Arquivo de modelo para configurar o VirtualHost no Apache.
• files/index.html.j2: Arquivo de modelo para configurar uma página de teste no diretório raiz do servidor web.
• vars/default.yml: Arquivo de variáveis para personalizar as configurações do playbook.
• playbook.yml: O arquivo do playbook, contendo as tarefas a serem executadas nos servidores remotos.
• readme.md: Um arquivo de texto contendo informações sobre este playbook.

Editaremos o arquivo de variáveis do playbook para personalizar algumas opções. Acesse o diretório apache_ubuntu1804 e abra o arquivo vars/default.yml usando o editor de linha de comando de sua escolha:

cd apache_ubuntu1804
nano vars/default.yml

Este arquivo contém algumas variáveis que requerem sua atenção:

---
app_user: "sammy"
http_host: "your_domain"
http_conf: "your_domain.conf"
http_port: "80"
disable_default: true

A lista a seguir contém uma breve explicação de cada uma dessas variáveis e como você pode alterá-las:

• app_user: Um usuário remoto não-root no host Ansible que será definido como o proprietário dos arquivos da aplicação.
• http_host: O seu nome de domínio.
• http_conf: O nome do arquivo de configuração que será criado no Apache.
• http_port: Porta HTTP para este virtual host, onde 80 é o padrão.
• disable_default: Desativar ou não o site padrão que acompanha o Apache.

Quando terminar de atualizar as variáveis dentro de vars/default.yml, salve e feche este arquivo. Se você usou o nano, faça isso pressionando CTRL + X, Y e, em seguida,ENTER.

Agora você está pronto para executar este playbook em um ou mais servidores. A maioria dos playbooks está configurada para ser executada em todos os servidores do seu inventário, por padrão. Podemos usar a flag -l para garantir que apenas um subconjunto de servidores ou um único servidor seja afetado pelo playbook. Também podemos usar a flag -u para especificar qual usuário no servidor remoto que estamos usando para conectar e executar os comandos do playbook nos hosts remotos.

Para executar o playbook apenas no servidor server1, conectando-se como sammy, você pode usar o seguinte comando:

ansible-playbook playbook.yml -l server1 -u sammy

Você obterá uma saída semelhante a esta:

Output
PLAY [all] *****************************************************************************************************************************

TASK [Gathering Facts] *****************************************************************************************************************
ok: [server1]

TASK [Install prerequisites] ***********************************************************************************************************
ok: [server1] => (item=aptitude)

TASK [Install Apache] ******************************************************************************************************************
changed: [server1]

TASK [Create document root] ************************************************************************************************************
changed: [server1]

TASK [Copy index test page] ************************************************************************************************************
changed: [server1]

TASK [Set up Apache virtualhost] *******************************************************************************************************
changed: [server1]

TASK [Enable new site] *****************************************************************************************************************
changed: [server1]

TASK [Disable default Apache site] *****************************************************************************************************
changed: [server1]

TASK [UFW - Allow HTTP on port 80] *****************************************************************************************************
changed: [server1]

RUNNING HANDLER [Reload Apache] ********************************************************************************************************
changed: [server1]

PLAY RECAP *****************************************************************************************************************************
server1            : ok=10   changed=8    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

Quando o playbook terminar de ser executado, abra seu navegador web e acesse o host ou o endereço IP do servidor, conforme configurado nas variáveis do playbook:

http://host_ou_ip_do_servidor

Você verá uma página como esta:

Isso significa que a automação foi totalmente executada em seu servidor e o Apache agora está pronto para servir páginas HTML estáticas e ativos colocados no diretório raiz de documentos que você definiu nas variáveis de configuração do playbook.

O Conteúdo do Playbook

Você pode encontrar a configuração do servidor Apache apresentada neste tutorial na página apache_ubuntu1804 dentro do repositório DigitalOcean Community Playbooks. Para copiar ou baixar o conteúdo do script diretamente, clique no botão Raw na parte superior de cada script.

O conteúdo completo do playbook, bem como os arquivos associados, também estão incluídos aqui para sua conveniência.

vars/default.yml

O arquivo de variáveis default.yml contém valores que serão usados nas tarefas do playbook, como a porta HTTP e o nome do domínio a serem configurados no VirtualHost do Apache.

---
app_user: "sammy"
http_host: "your_domain"
http_conf: "your_domain.conf"
http_port: "80"
disable_default: true

files/apache.conf.j2

O arquivo apache.conf.j2 é um template ou modelo Jinja 2 que configura um novo VirtualHost no Apache. As variáveis usadas neste modelo são definidas no arquivo de variáveis vars/default.yml.

<VirtualHost *:{{ http_port }}>
   ServerAdmin webmaster@localhost
   ServerName {{ http_host }}
   ServerAlias www.{{ http_host }}
   DocumentRoot /var/www/{{ http_host }}
   ErrorLog ${APACHE_LOG_DIR}/error.log
   CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

files/index.html.j2

O arquivo index.html.j2 é outro modelo Jinja, usado para configurar uma página HTML de teste na raiz de documentos do servidor Apache recém-configurado.

<html>
   <head>
       <title>Welcome to {{ http_host }} !</title>
   </head>
   <body>
       <h1>Success! The {{ http_host }} virtual host is working!</h1>
   </body>
</html>

playbook.yml

O arquivo playbook.yml é onde todas as tarefas desta configuração são definidas. Ele começa definindo o grupo de servidores que deve ser o alvo dessa configuração (all), após o qual ele usa become: true para definir que as tarefas devem ser executadas com escalação de privilégios (sudo) por padrão. Em seguida, inclui o arquivo de variáveis vars/default.yml para carregar as opções de configuração.

---
- hosts: all
  become: true
  vars_files:
    - vars/default.yml

  tasks:
    - name: Install prerequisites
      apt: name={{ item }} update_cache=yes state=latest force_apt_get=yes
      loop: [ 'aptitude' ]

    - name: Install Apache
      apt: name=apache2 update_cache=yes state=latest

    - name: Create document root
      file:
        path: "/var/www/{{ http_host }}"
        state: directory
        owner: "{{ app_user }}"
        mode: '0755'

    - name: Copy index test page
      template:
        src: "files/index.html.j2"
        dest: "/var/www/{{ http_host }}/index.html"

    - name: Set up Apache virtuahHost
      template:
        src: "files/apache.conf.j2"
        dest: "/etc/apache2/sites-available/{{ http_conf }}"

    - name: Enable new site
      shell: /usr/sbin/a2ensite {{ http_conf }}
      notify: Reload Apache

    - name: Disable default Apache site
      shell: /usr/sbin/a2dissite 000-default.conf
      when: disable_default
      notify: Reload Apache

    - name: "UFW - Allow HTTP on port {{ http_port }}"
      ufw:
        rule: allow
        port: "{{ http_port }}"
        proto: tcp

  handlers:
    - name: Reload Apache
      service:
        name: apache2
        state: reloaded

    - name: Restart Apache
      service:
        name: apache2
        state: restarted

Sinta-se à vontade para modificar este playbook para melhor atender às suas necessidades individuais dentro do seu próprio fluxo de trabalho.

Conclusão

Neste guia, usamos o Ansible para automatizar o processo de instalação e configuração do Apache no Ubuntu 18.04.

Se você deseja incluir outras tarefas neste playbook para personalizar ainda mais sua configuração inicial de servidor, consulte nosso guia introdutório de Ansible em Configuration Management 101: Writing Ansible Playbooks.