Rôle Ansible weareinteractive.apache2

weareinteractive.apache2 est un rôle Ansible qui :

• installe apache2
• configure apache2
• active/désactive des configurations
• crée des sites
• active/désactive des sites
• active/désactive des modules
• supprime éventuellement l'hôte par défaut
• ajoute des règles
• configure le service

Remarque :

Comme Ansible Galaxy supporte maintenant les organisations, ce rôle a été déplacé de franklinkim.apache2 à weareinteractive.apache2 !

Installation

Avec ansible-galaxy :

$ ansible-galaxy install weareinteractive.apache2

Avec requirements.yml :

- src: weareinteractive.apache2

Avec git :

$ git clone https://github.com/weareinteractive/ansible-apache2.git weareinteractive.apache2

Dépendances

• Ansible >= 2.4

Variables

Voici la liste de toutes les variables par défaut pour ce rôle, qui sont aussi disponibles dans defaults/main.yml.

---
# apache2_packages:
#   - apache2
#   - apache2-mpm-prefork
# apache2_module:
#   - { id: auth, state: absent }
#   - { id: rewrite, state: present }
# apache2_confs:
#   - { id: security, state: absent }
#   - { name: mime, state: present }
#   - id: my_config
#     state: present
#     template: path/to/template.j2
# apache2_sites:
#   - id: mysite (requis)
#     name: mysite.local (requis)
#     ip: '*'
#     port: 80
#     state: present
#     add_webroot: no
#     template: path/to/template.j2
#     rules: []
#     aliases: []
#     redirects: []
#     ssl:
#       port: 443
#       key_name: mykey
#       cert_name: mycert
#       chain_name: mychain
#     auth:
#       name: mysite
#       file: mysite
#     append: ''
#

# packages (versions)
apache2_packages:
  - apache2
# ports à écouter
apache2_ports: [80]
# ports ssl à écouter
apache2_ssl_ports: [443]
# adresses à écouter (2.2 seulement)
apache2_listen_addresses: ['*']
# modules activés/désactivés
apache2_modules: []
# configurations activées/désactivées
apache2_confs: []
# sites activés/désactivés
apache2_sites: []
# où se trouvent nos racines de documents (par défaut /var/www donc /var/www/<SiteId>/htdocs)
apache2_sites_basedir: /var/www
# fichier modèle de site par défaut
apache2_sites_template: etc/apache2/sites-available/site.j2
# supprimer l'hôte par défaut
apache2_remove_default: no
# démarrer au démarrage
apache2_service_enabled: yes
# état actuel : démarré, arrêté
apache2_service_state: started
# définir sur : Full | OS | Minimal | Minor | Major | Prod
apache2_server_tokens: Prod
# définir sur : On | Off | EMail
apache2_server_signiture: 'Off'
# définir sur : On | Off | extended
apache2_trace_enable: 'Off'
# chemin vers les certificats
apache2_certs_path: /etc/ssl/certs
# chemin vers les clés
apache2_keys_path: /etc/ssl/private

Gestionnaires

Voici les gestionnaires définis dans handlers/main.yml.

---

- name: test et redémarrer apache2
  command: apache2ctl configtest
  notify: restart apache2

- name: test et recharger apache2
  command: apache2ctl configtest
  notify: reload apache2

- name: redémarrer apache2
  service: name=apache2 state=restarted
  when: apache2_service_state != 'stopped'

- name: recharger apache2
  service: name=apache2 state=reloaded
  when: apache2_service_state != 'stopped'

Règles

Certains fragments de configuration provenant de HTML 5 Boilerplate seront copiés dans /etc/apache2/rules qui peuvent ensuite être utilisés dans vos configurations vhost (voir usage ci-dessous).

• compression
• content_transform
• cors
• cors_images
• cors_timing
• cors_web_fonts
• etag
• expires
• file_concatenation
• filename_based_cache_busting
• ie_cookies
• ie_edge
• mimes
• security_file_access
• security_hosts
• security_mime
• security_signiture
• security_technology
• ssl
• utf8

Utilisation

Voici un exemple de playbook :

---
# cet exemple utilise des rôles liés :
#
# - weareinteractive.apt  (https://github.com/weareinteractive/ansible-apt)
# - weareinteractive.openssl  (https://github.com/weareinteractive/ansible-openssl)
# - weareinteractive.htpasswd (https://github.com/weareinteractive/ansible-htpasswd)

- hosts: all
  become: yes
  roles:
    - weareinteractive.apt
    - weareinteractive.openssl
    - weareinteractive.htpasswd
    - weareinteractive.apache2
  vars:
    htpasswd:
      - name: foobar
        users:
          - { name: foobar, password: foobar }
    apache2_modules:
      - { id: ssl, state: present }
      - { id: mime, state: present }
      - { id: headers, state: present }
      - { id: rewrite, state: present }
    apache2_remove_default: yes
    openssl_generate_csr: yes
    openssl_self_signed:
      - name: 'foobar.local'
        country: 'DE'
        state: 'Bavière'
        city: 'Munich'
        organization: 'Foo Bar'
        unit: 'Unité Foo Bar'
        email: '[email protected]'
    apache2_sites:
      - id: foobar
        state: present
        name: foobar.local
        rules:
          - mimes
          - expires
          - compression
        add_webroot: yes
        auth:
          name: Foo Bar
          file: foobar
        ssl:
          key_name: foobar.local
          cert_name: foobar.local

Tests

$ git clone https://github.com/weareinteractive/ansible-apache2.git
$ cd ansible-apache2
$ make test

Contributions

En l'absence d'un guide de style formel, veillez à maintenir le style de codage existant. Ajoutez des tests unitaires et des exemples pour toute nouvelle fonctionnalité ou modification.

1. Forkez-le
2. Créez votre branche de fonctionnalité (git checkout -b my-new-feature)
3. Validez vos modifications (git commit -am 'Ajoutez une nouvelle fonctionnalité')
4. Poussez sur la branche (git push origin my-new-feature)
5. Créez une nouvelle demande de tirage

Remarque : Pour mettre à jour le fichier README.md, veuillez installer et exécuter ansible-role :

$ gem install ansible-role
$ ansible-role docgen

Licence

Copyright (c) We Are Interactive sous la licence MIT.