ansible-role-nginx/README.md

👾 Help make the NGINX Ansible role better by participating in our survey! 👾

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.

Deprecation Warnings:

With the advent of Ansible collections and the release of the NGINX Core Ansible collection, the decision has been made to split this role into three smaller roles and reduce the overhead of this role:

• The NGINX Ansible role will keep working as is and be used to install and setup NGINX.
• The NGINX configuration functionalities included in this role will be removed in an upcoming release at some stage after December 1st 2020. There now is a separate role to manage and create NGINX configurations available here. Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on.
• The NGINX Unit functionalities included in this role will be removed in an upcoming release at some stage after November 1st 2020. There now is a separate role to install NGINX Unit available here. Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on.

Requirements

Ansible

• This role is 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 3.x is used to test the various functionalities 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:
  - 3.9
  - 3.10
  - 3.11
  - 3.12
CentOS:
  - 6
  - 7.4+
  - 8
Debian:
  - stretch
  - buster
Red Hat:
  - 6
  - 7.4+
  - 8
SUSE/SLES:
  - 12
  - 15
Ubuntu:
  - xenial
  - bionic
  - eoan
  - focal

NGINX Plus

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

NGINX Amplify Agent

Amazon Linux:
  - 2017.09
CentOS:
  - 6
  - 7
Debian:
  - jessie
  - stretch
Red Hat:
  - 6
  - 7
Ubuntu:
  - xenial
  - bionic
  - focal

NGINX Unit

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

Note: You can also use this role to compile NGINX Open Source from source, install NGINX Open Source on compatible yet unsupported platforms, or install NGINX Open Source on BSD systems at your own risk.

Role Variables

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

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

Similarly, descriptions and defaults for preset variables can be found in the vars/ folder in the following files:

Name	Description
main.yml	List of supported NGINX platforms and modules

Example Playbooks

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

Name	Description
default_converge.yml	Install a specific version of NGINX and set up logrotate
module_converge.yml	Install various NGINX supported modules
plus_converge.yml	Install NGINX Plus and various NGINX Plus supported modules
source_converge.yml	Install NGINX from source
stable_push_converge.yml	Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance
template_converge.yml	Use the NGINX configuration templating variables to create an NGINX configuration file
unit_converge.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 Ansible Collections and Roles

You can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect here.

You can find the Ansible NGINX configuration role to configure NGINX here.

You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect here.

You can find the Ansible NGINX Controller collection of roles to install and configure NGINX Controller here.

You can find the Ansible NGINX Unit role to install NGINX Unit here.

License

Apache License, Version 2.0

Author Information

Alessandro Fael Garcia

Grzegorz Dzien

Tom Gamull

© F5 Networks, Inc. 2018 - 2020