👾 Help make the NGINX config Ansible role better by participating in our survey! 👾
This role configures NGINX Open Source and NGINX Plus 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.
- This role is developed and tested with maintained versions of Ansible base (bigger than
2.10
) and Ansible (bigger than2.9.10
). - When using Ansible base, you will also need to install the following collections:
Note: You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
--- collections: - name: community.general version: 2.3.0 - name: ansible.posix version: 1.2.0
- Instructions on how to install Ansible can be found in the Ansible website.
- This role uses Jinja2 templates. Ansible base 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 is
2.11
. - Instructions on how to install Jinja2 can be found in the Jinja2 website.
- Molecule is used to test the various functionalities of the role. The recommended version of Molecule to test this role is
3.3
. - Instructions on how to install Molecule can be found in the Molecule website.
Use ansible-galaxy install nginxinc.nginx_config
to install the latest stable release of the role on your system.
Use git clone https://github.com/nginxinc/ansible-role-nginx-config.git
to pull the latest edge commit of the role from GitHub.
The NGINX config Ansible role supports all platforms supported by NGINX Open Source and NGINX Plus:
Alpine:
- 3.10
- 3.11
- 3.12
- 3.13
CentOS:
- 7.4+
- 8
Debian:
- buster
RedHat:
- 7.4+
- 8
SUSE/SLES:
- 12
- 15
Ubuntu:
- xenial
- bionic
- focal
- groovy
Alpine:
- 3.10
- 3.11
- 3.12
- 3.13
Amazon Linux:
- 2018.03
Amazon Linux 2:
- any
CentOS:
- 7.4+
- 8
Debian:
- buster
FreeBSD:
- 11.2+
- 12.1+
Oracle Linux:
- 7.4+
RedHat:
- 7.4+
- 8
SUSE/SLES:
- 12
- 15
Ubuntu:
- xenial
- bionic
- focal
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 simple config variables |
selinux.yml |
Set up SELinux to allow the necessary connections to your NGINX setup |
template.yml |
NGINX config template variables |
upload.yml |
NGINX config/HTML/SSL upload variables |
Working functional playbook examples can be found in the molecule/
folder in the following files:
Name | Description |
---|---|
cleanup_module/converge.yml |
Cleanup an NGINX config and configure NGINX supported modules |
default/converge.yml |
Use the NGINX config templating variables to create an NGINX config |
plus/converge.yml |
Use the NGINX config templating variables to create an NGINX Plus config |
stable_push/converge.yml |
Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance |
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-config
to nginxinc.nginx_config
.
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 role to install 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.
© F5 Networks, Inc. 2020 - 2021