ansible-role-nginx

Manages nginx.

Requirements

None

Role Variables

Variable	Description	Default
nginx_user	user of nginx	{{ __nginx_user }}
nginx_group	group of nginx	{{ __nginx_group }}
nginx_log_dir	path to log directory	{{ __nginx_log_dir }}
nginx_access_log_file	path to access.log	{{ nginx_log_dir }}/access.log
nginx_error_log_file	path to error.log	{{ nginx_log_dir }}/error.log
nginx_service	service name of nginx	nginx
nginx_package	package name of nginx	{{ __nginx_package }}
nginx_conf_dir	path to configuration directory	{{ __nginx_conf_dir }}
nginx_conf_fragments_dir	path to optional configuration fragment directory	{{ nginx_conf_dir }}/conf.d
nginx_conf_file	path to nginx.conf	{{ nginx_conf_dir }}/nginx.conf
nginx_flags	optional flags to command nginx. (not supported in RedHat because it does not provide a mechanism to pass one)	""
nginx_validate_enable	when yes enable nginx.conf validation. note that all the path in all configuration files must be absolute. set to no if relative path must be used	yes
nginx_include_x509_certificate	include and execute reallyenglish.x509-certificate during the play when yes (see below)	no
nginx_config	string of nginx.conf content	""
nginx_config_fragments	list of optional configuration fragments in nginx_conf_fragments_dir (see below)	[]

nginx_include_x509_certificate

When yes, this variable includes and execute reallyenglish.x509 during the play, which makes it possible to manage certificates without ugly hacks. This is only supported in ansible version at least 2.2 and later.

reallyenglish.x509 must be listed in requirements.yml when yes. The role is not automatically downloaded as a dependency because the role does NOT depend on it in meta/main.yml.

Known supported platforms:

platform	ansible version
CentOS	2.3.1.0
FreeBSD	2.3.1.0
Ubuntu	2.3.1.0-1ppa~xenial
Ubuntu	2.3.1.0-1ppa~trusty

nginx_config_fragments

This variable is a list of dict. Keys and values are explained below.

Key	Value	Mandatory?
name	file name	yes
config	the content of the file	yes
state	the state of the file, created if present or removed if absent	yes

Debian

Variable	Default
__nginx_user	www-data
__nginx_group	www-data
__nginx_package	nginx
__nginx_log_dir	/var/log/nginx
__nginx_conf_dir	/etc/nginx

FreeBSD

Variable	Default
__nginx_user	www
__nginx_group	www
__nginx_package	nginx
__nginx_log_dir	/var/log/nginx
__nginx_conf_dir	/usr/local/etc/nginx

OpenBSD

Variable	Default
__nginx_user	www
__nginx_group	www
__nginx_package	nginx--
__nginx_log_dir	/var/www/logs
__nginx_conf_dir	/etc/nginx

RedHat

Variable	Default
__nginx_user	nginx
__nginx_group	nginx
__nginx_package	nginx
__nginx_log_dir	/var/log/nginx
__nginx_conf_dir	/etc/nginx

Dependencies

• reallyenglish.x509-certificate when nginx_include_x509_certificate is true

Example Playbook

- hosts: localhost
  roles:
    - name: reallyenglish.redhat-repo
      when: ansible_os_family == 'RedHat'
    - ansible-role-nginx
  vars:
    www_root_dir: "{% if ansible_os_family == 'FreeBSD' %}/usr/local/www/nginx{% elif ansible_os_family == 'OpenBSD' %}/var/www/htdocs{% elif ansible_os_family == 'Debian' %}/var/www/html{% elif ansible_os_family == 'RedHat' %}/usr/share/nginx/html{% endif %}"
    nginx_flags: -q
    nginx_config: |
      {% if ansible_os_family == 'Debian' or ansible_os_family == 'RedHat' %}
      user {{ nginx_user }};
      pid /run/nginx.pid;
      {% endif %}
      worker_processes 1;
      error_log {{ nginx_error_log_file }};
      events {
        worker_connections 1024;
      }
      http {
        include {{ nginx_conf_dir }}/mime.types;
        include {{ nginx_conf_fragments_dir }}/foo.conf;
        access_log {{ nginx_access_log_file }};
        default_type application/octet-stream;
        sendfile on;
        keepalive_timeout 65;
        server {
          listen 80;
          server_name localhost;
          root {{ www_root_dir }};
          location / {
            index index.html;
          }
          error_page 500 502 503 504 /50x.html;
          location = /50x.html {
          }
        }
      }
    nginx_config_fragments:
      - name: foo.conf
        config: "# FOO"
        state: present
    redhat_repo:
      epel:
        mirrorlist: "http://mirrors.fedoraproject.org/mirrorlist?repo=epel-{{ ansible_distribution_major_version }}&arch={{ ansible_architecture }}"
        gpgcheck: yes
        enabled: yes

License

Copyright (c) 2017 Tomoyuki Sakurai <tomoyukis@reallyenglish.com>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Author Information

Tomoyuki Sakurai tomoyukis@reallyenglish.com

This README was created by qansible