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

Ansible NGINX Role

This role installs NGINX Open Source, NGINX Plus, or the NGINX Amplify agent 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 have been removed as of release 0.19.0. 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 configuration Ansible role repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on. This disclaimer will be removed in a future release.
• The NGINX Unit functionalities included in this role have been removed as of release 0.18.0. 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 Ansible role repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. This disclaimer will be removed in a future release.

Requirements

Ansible

• This role is developed and tested with maintained versions of Ansible base. When using Ansible base, you will also need to install the following collections:

  ---
  collections:
    - name: community.general
      version: 2.0.0
    - name: ansible.posix
      version: 1.1.1
  

  Note: You can alternatively install the Ansible community distribution if you don't want to manage individual collections.
• 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, and the NGINX Amplify agent:

NGINX Open Source

Alpine:
  - 3.10
  - 3.11
  - 3.12
CentOS:
  - 7.4+
  - 8
Debian:
  - stretch
  - buster
Red Hat:
  - 7.4+
  - 8
SUSE/SLES:
  - 12
  - 15
Ubuntu:
  - xenial
  - bionic
  - focal
  - groovy

NGINX Plus

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

NGINX Amplify Agent

Amazon Linux:
  - 2017.09
CentOS:
  - 7
Debian:
  - jessie
  - stretch
Red Hat:
  - 7
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
linux.yml	Linux installation variables
bsd.yml	BSD 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

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 - 2021