sjugge / ansible-collection-nginx

Ansible collection for NGINX

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

Ansible NGINX Collection

The Ansible NGINX collection includes a variety of NGINX Ansible roles to help automate the installation and configuration of NGINX. This collection is maintained by NGINX.

Note: This collection is still in active development. There may be unidentified issues as development continues.

Included Content

The current stable release (0.3.0) of the Ansible NGINX collection includes the following roles:

Name	Description	Version
nginxinc.nginx	Install NGINX	0.19.1
nginxinc.nginx_config	Configure NGINX	0.3.2
nginxinc.nginx_app_protect	Install and configure NGINX App Protect	0.4.2

Requirements

This collection has been developed and tested with maintained versions of Ansible bigger than 2.9.10. Backwards compatibility is not guaranteed.

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

Installation

Ansible Galaxy

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

You can also include the collection in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: nginxinc.nginx_core
    version: 0.3.0

Git

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

Usage

Sample playbooks for each use case covered by this collection can be found in the playbooks/ folder in the following files:

Name	Description
deploy-nginx.yml	Install NGINX
deploy-nginx-plus.yml	Install NGINX Plus
deploy-nginx-app-protect.yml	Install NGINX App Protect
deploy-nginx-plus-app-protect.yml	Install NGINX Plus and NGINX App Protect
deploy-nginx-web-server.yml	Install NGINX and configure a simple web server
deploy-nginx-web-server-proxy.yml	Install NGINX and configure a simple reverse proxy in front of two web servers
deploy-nginx-plus-app-protect-web-server-proxy.yml	Install NGINX Plus and NGINX App Protect and configure a simple reverse proxy in front of two web servers protected by NGINX App Protect

Development

Currently, all the NGINX roles included in this collection (found in the roles/ folder) are Git submodules, and work on the roles themselves should take place in the corresponding upstream role repository.

To update the roles included in this collection to their latest version, run git submodule update --recursive --remote.

Other NGINX Ansible Collections and Roles

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

© F5 Networks, Inc. 2020 - 2021