Go to file

Iyad Kandalaft f76441f5d4 Add events_custom_options to template.yml defaults (#208 ) Co-authored-by: Alessandro Fael Garcia <alessfg@hotmail.com>		2020-06-17 14:48:29 +02:00
.github	Update docs (#257 )	2020-06-04 13:05:38 +02:00
defaults/main	Add events_custom_options to template.yml defaults (#208 )	2020-06-17 14:48:29 +02:00
files	Buildfromsource (#233 )	2020-03-25 18:43:32 +01:00
handlers	Issue238 - validate configs (#241 )	2020-04-21 20:52:31 +02:00
meta	Add support for Ubuntu Focal (#258 )	2020-06-08 15:46:01 +02:00
molecule	Add events_custom_options to template.yml defaults (#208 )	2020-06-17 14:48:29 +02:00
tasks	Improve config cleanup tasks (#262 )	2020-06-12 23:42:14 +02:00
templates	Fix bug on debian logrotate scripts (#260 )	2020-06-10 21:22:44 +02:00
vars	Initial role commit	2018-01-10 14:40:01 -08:00
.gitignore	Buildfromsource (#233 )	2020-03-25 18:43:32 +01:00
.travis.yml	Add support for Ubuntu Focal (#258 )	2020-06-08 15:46:01 +02:00
.yamllint	Buildfromsource (#233 )	2020-03-25 18:43:32 +01:00
CHANGELOG.md	Update docs (#257 )	2020-06-04 13:05:38 +02:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2019-12-12 14:22:11 -08:00
CONTRIBUTING.md	Update docs (#257 )	2020-06-04 13:05:38 +02:00
LICENSE	Initial commit	2018-01-10 14:37:00 -08:00
README.md	Add support for Ubuntu Focal (#258 )	2020-06-08 15:46:01 +02:00

README.md

Ansible NGINX Role

This role installs NGINX Open Source, NGINX Plus, the NGINX Amplify agent, or NGINX Unit on your target host.

Note: This role is still in active development. There may be unidentified issues and the role variables may change as development continues.

Requirements

Ansible

This role was developed and tested with maintained versions of Ansible. Backwards compatibility is not guaranteed.

Instructions on how to install Ansible can be found in the Ansible website.

Molecule

Molecule is used to test the various functionailities of the role. Instructions on how to install Molecule can be found in the Molecule website.

Installation

Ansible Galaxy

Use ansible-galaxy install nginxinc.nginx to install the latest stable release of the role on your system.

Git

Use git clone https://github.com/nginxinc/ansible-role-nginx.git to pull the latest edge commit of the role from GitHub.

Platforms

The NGINX Ansible role supports all platforms supported by NGINX Open Source, NGINX Plus, the NGINX Amplify agent, and NGINX Unit:

NGINX Open Source

Alpine:
  versions:
    - 3.8
    - 3.9
    - 3.10
    - 3.11
CentOS:
  versions:
    - 6
    - 7
    - 8
Debian:
  versions:
    - stretch
    - buster
FreeBSD:
  versions:
    - 11.2+
    - 12
RedHat:
  versions:
    - 6
    - 7.4+
    - 8
SUSE/SLES:
  versions:
    - 12
    - 15
Ubuntu:
  versions:
    - xenial
    - bionic
    - focal

NGINX Plus

Alpine:
  versions:
    - 3.8
    - 3.9
    - 3.10
    - 3.11
Amazon Linux:
  versions:
    - 2018.03
Amazon Linux 2:
  versions:
    - any
CentOS:
  versions:
    - 6.5+
    - 7.4+
    - 8
Debian:
  versions:
    - stretch
    - buster
FreeBSD:
  versions:
    - 11.2+
    - 12
Oracle Linux:
  versions:
    - 6.5+
    - 7.4+
RedHat:
  versions:
    - 6.5+
    - 7.4+
    - 8
SUSE/SLES:
  versions:
    - 12
    - 15
Ubuntu:
  versions:
    - xenial
    - bionic
    - focal

NGINX Amplify Agent

Amazon Linux:
  versions:
    - 2017.09
CentOS:
  versions:
    - 6
    - 7
Debian:
  versions:
    - jessie
    - stretch
Ubuntu:
  versions:
    - xenial
    - bionic
RedHat:
  versions:
    - 6
    - 7

NGINX Unit

Amazon Linux:
  versions:
    - 2018.03
Amazon Linux 2:
  versions:
    - any
CentOS:
  versions:
    - 6
    - 7
    - 8
Debian:
  versions:
    - stretch
    - buster
RedHat:
  versions:
    - 6
    - 7
    - 8
Ubuntu:
  versions:
    - xenial
    - bionic
    - focal

Role Variables

This role has multiple variables. The descriptions and defaults for all these variables can be found in the defaults/main directory in the following files:

defaults/main/main.yml: NGINX installation variables
defaults/main/amplify.yml: NGINX Amplify agent installation variables
defaults/main/template.yml: NGINX configuration templating variables
defaults/main/upload.yml: NGINX configuration/HTML/SSL upload variables
defaults/main/linux.yml: Linux installation variables
defaults/main/bsd.yml: BSD installation variables
defaults/main/unit.yml: NGINX Unit installation variables

Example Playbooks

Working functional playbook examples can be found in the molecule/common directory in the following files:

molecule/common/playbook_default.yml: Install a specific version of NGINX and set up logrotate
molecule/common/playbook_module.yml: Install various NGINX supported modules
molecule/common/playbook_source.yml: Install NGINX from source
molecule/common/playbook_stable_push.yml: Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance
molecule/common/playbook_template.yml: Use the NGINX configuration templating variables to create an NGINX configuration file
molecule/common/playbook_unit.yml: Install NGINX Unit

Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from ansible-role-nginx to nginxinc.nginx.

Other NGINX Roles

You can find an Ansible collection of roles to help you install and configure NGINX Controller here

You can find an Ansible role to help you install and configure NGINX App Protect here

License

Apache License, Version 2.0

Author Information

Alessandro Fael Garcia

Grzegorz Dzien