Repository files navigation

This role installs NGINX (NGINX Open Source), NGINX Plus, NGINX Agent and/or the NGINX Amplify agent on your target host(s).

Depending on your target NGINX use case, you might need to obtain a license or API key/token before being able to use the role:

If you want to use this role, you will need to use a supported version of Ansible core and Jinja2 as well as a few Ansible collections.

For ease of use, you can install and/or upgrade Ansible core, Jinja2, and the aforementioned Ansible collections by running the following four commands on your Ansible host:

pip install --upgrade -r https://raw.githubusercontent.com/nginx/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible.txtcurl -O https://raw.githubusercontent.com/nginx/ansible-role-nginx/main/.github/workflows/requirements/requirements_collections.ymlansible-galaxy install --force -r requirements_collections.ymlrm -f requirements_collections.yml

This will also ensure you are deploying/running this role with a fully tested version of the aforementioned packages/collections.

• This role is developed and tested withmaintained versions of Ansible core and Python.

  Note: Ansible2.18 does no longer support theyum module and as such, is not supported by this role until Amazon Linux 2 reaches EoL.

• Instructions on how to install Ansible core can be found in theAnsible docs.

• When using Ansible core, you will also need to install the following Ansible collections:

  ---collections:  -name:ansible.posixversion:2.0.0  -name:community.generalversion:10.7.0  -name:community.crypto# Only required if you plan to install NGINX Plusversion:2.26.2  -name:community.docker# Only required if you plan to use Molecule (see below)version:4.6.0

• Instructions on how to install Ansible collections can be found in theAnsible collections guide.

• You will need to run this role as a root user using Ansible'sbecome parameter. Make sure you have set up the appropriate permissions on your target hosts.

• This role uses Jinja2 templates. Ansible core installs Jinja2 by default, but depending on your install and/or upgrade path, you might be running an outdated version of Jinja2. The minimum version of Jinja2 required for the role to properly function is3.1.
• Instructions on how to install Jinja2 can be found in theJinja2 website.

If you want to contribute to this role, you will also need to install Ansible Lint and Molecule.

• Ansible Lint is used to lint the role for both Ansible best practices and potential Ansible/YAML issues.

• Instructions on how to install Ansible Lint can be found in theAnsible Lint website.

• Once installed, using Ansible Lint is as easy as running:

  ansible-lint

• For ease of use, you can install and/or upgrade Ansible Lint by running the following command on your Ansible host:

  pip install -r https://raw.githubusercontent.com/nginx/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible_lint.txt

• Molecule is used to test the various functionalities of the role.

• Instructions on how to install Molecule can be found in theMolecule website.You will also need to install the Molecule plugins package and the Docker Python SDK.

• To run any of the NGINX Plus Molecule tests, you must first copy your NGINX Plus license to the role'sfiles/license directory.

  You can alternatively add your NGINX Plus repository certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests:

  export NGINX_CRT=$( cat<path to your certificate file>| base64)export NGINX_KEY=$( cat<path to your key file>| base64)moleculetest -s plus

• For ease of use, you can install and/or upgrade Molecule, the Molecule plugins package, and the Docker Python SDK by running the following command on your Ansible host:

  pip install --upgrade -r https://raw.githubusercontent.com/nginx/ansible-role-nginx/main/.github/workflows/requirements/requirements_molecule.txt

This role can be installed via either Ansible Galaxy (the Ansible community marketplace) or by cloning this repo. Once installed, you will need to include the role in your Ansible playbook usingtheroles keyword, theimport_role module, or theinclude_role module.

To install the latest stable release of the role on your system, use:

ansible-galaxy install nginxinc.nginx

Alternatively, if you have already installed the role, you can update the role to the latest release by using:

ansible-galaxy install -f nginxinc.nginx

To use the role, include the following task in your playbook:

-name:Install NGINXansible.builtin.include_role:name:nginxinc.nginx

To pull the latest edge commit of the role from GitHub, use:

git clone https://github.com/nginx/ansible-role-nginx.git

To use the role, include the following task in your playbook:

-name:Install NGINXansible.builtin.include_role:name:<path/to/repo># e.g. <roles/ansible-role-nginx> if you clone the repo inside your project's roles directory

The NGINX Ansible role aims to work on all platforms supported by the latest mainline/stable release ofNGINX Open Source,NGINX Plus,NGINX Agent, and theNGINX Amplify agent.

Older releases might work, but keep in mind that NGINX Open Source only actively develops against thelatest release of the mainline and stable branches, and NGINX Plus onlyofficially supports releases for two years.

AlmaLinux:  -8  -9Alpine:  -3.18  -3.19  -3.20  -3.21Amazon Linux:  -2  -2023Debian:  -bullseye (11)  -bookworm (12)Oracle Linux:  -8  -9Red Hat:  -8  -9Rocky Linux:  -8  -9SUSE/SLES:  -15 SP6+Ubuntu:  -focal (20.04)  -jammy (22.04)  -noble (24.04)  -oracular (24.10)

AlmaLinux:  -8  -9Alpine:  -3.18  -3.19  -3.20  -3.21Amazon Linux:  -2  -2023Debian:  -bullseye (11)  -bookworm (12)FreeBSD:  -13  -14Oracle Linux:  -8.1+  -9Red Hat:  -8.1+  -9Rocky Linux:  -8  -9SUSE/SLES:  -15 SP2+Ubuntu:  -focal (20.04)  -jammy (22.04)  -noble (24.04)

AlmaLinux:  -8  -9Alpine:  -3.17  -3.18  -3.19  -3.20Amazon Linux:  -2  -2023Debian:  -bullseye (11)  -bookwork (12)FreeBSD:  -13  -14Oracle Linux:  -8  -9Red Hat:  -8  -9Rocky Linux:  -8  -9SUSE/SLES:  -12  -15Ubuntu:  -focal (20.04)  -jammy (22.04)  -noble (24.04)

Amazon Linux:  -2Debian:  -buster (10)  -bullseye (11)Red Hat:  -8  -9Ubuntu:  -bionic (18.04)  -focal (20.04)  -jammy (22.04)

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

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

Working functional playbook examples can be found in themolecule/ folder in the following files:

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

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

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

Apache License, Version 2.0

Alessandro Fael Garcia

Grzegorz Dzien

Tom Gamull

©F5, Inc. 2018 - 2025