Update docs
* Update README * Update Ansible Galaxy metadata * Fix syntax on defaults file
This commit is contained in:
Alessandro Fael Garcia
parent
0fef56b4fa
commit
dcfa8cd43b
238
README.md
238
README.md
@ -17,110 +17,127 @@ It supports all platforms supported by [NGINX Open Source](https://nginx.org/en/
|
||||
|
||||
**NGINX Open Source:**
|
||||
|
||||
CentOS:
|
||||
```yaml
|
||||
CentOS:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
RedHat:
|
||||
RedHat:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
Debian:
|
||||
Debian:
|
||||
versions:
|
||||
- jessie
|
||||
- stretch
|
||||
Ubuntu:
|
||||
Ubuntu:
|
||||
versions:
|
||||
- trusty
|
||||
- xenial
|
||||
- zesty
|
||||
SUSE/SLES:
|
||||
- artful
|
||||
- bionic
|
||||
SUSE/SLES:
|
||||
versions:
|
||||
- 12
|
||||
FreeBSD:
|
||||
versions:
|
||||
- 10
|
||||
- 11
|
||||
```
|
||||
|
||||
**NGINX Plus:**
|
||||
|
||||
Debian:
|
||||
```yaml
|
||||
CentOS:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
RedHat:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
Debian:
|
||||
versions:
|
||||
- jessie
|
||||
- stretch
|
||||
Ubuntu:
|
||||
Ubuntu:
|
||||
versions:
|
||||
- trusty
|
||||
- xenial
|
||||
- zesty
|
||||
- artful
|
||||
CentOS:
|
||||
- bionic
|
||||
Oracle Linux:
|
||||
versions:
|
||||
- 6.5
|
||||
- 7
|
||||
RedHat:
|
||||
Amazon Linux:
|
||||
versions:
|
||||
- 6.5
|
||||
- 7
|
||||
Oracle Linux:
|
||||
versions:
|
||||
- 6.5
|
||||
- 7
|
||||
Amazon Linux:
|
||||
versions:
|
||||
- 2016.09
|
||||
SUSE/SLES:
|
||||
- 2018.03
|
||||
SUSE/SLES:
|
||||
versions:
|
||||
- 12
|
||||
FreeBSD:
|
||||
FreeBSD:
|
||||
versions:
|
||||
- 10.3
|
||||
- 10
|
||||
- 11
|
||||
```
|
||||
|
||||
**NGINX Unit:**
|
||||
|
||||
CentOS:
|
||||
```yaml
|
||||
CentOS:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
RedHat:
|
||||
RedHat:
|
||||
versions:
|
||||
- 6
|
||||
- 7
|
||||
Debian:
|
||||
Debian:
|
||||
versions:
|
||||
- jessie
|
||||
- stretch
|
||||
Ubuntu:
|
||||
Ubuntu:
|
||||
versions:
|
||||
- xenial
|
||||
- artful
|
||||
- bionic
|
||||
Amazon Linux:
|
||||
Amazon Linux:
|
||||
versions:
|
||||
- 2016.09
|
||||
- 2018.03
|
||||
- 2
|
||||
FreeBSD:
|
||||
versions:
|
||||
- 10
|
||||
- 11
|
||||
```
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
This role has multiple variables. The defaults for all these variables are the following:
|
||||
|
||||
---
|
||||
# Install NGINX.
|
||||
# Default is true.
|
||||
nginx_enable: true
|
||||
```yaml
|
||||
---
|
||||
# Install NGINX.
|
||||
# Default is true.
|
||||
nginx_enable: true
|
||||
|
||||
# Specify which version of NGINX you want to install.
|
||||
# Options are 'opensource' or 'plus'.
|
||||
# Default is 'opensource'.
|
||||
type: opensource
|
||||
# Specify which version of NGINX you want to install.
|
||||
# Options are 'opensource' or 'plus'.
|
||||
# Default is 'opensource'.
|
||||
type: opensource
|
||||
|
||||
# Specify repository origin for NGINX Open Source.
|
||||
# Options are 'nginx_repository' or 'os_repository'.
|
||||
# Only works if 'type' is set to 'opensource'.
|
||||
# Default is nginx_repository.
|
||||
install_from: nginx_repository
|
||||
# Specify repository origin for NGINX Open Source.
|
||||
# Options are 'nginx_repository' or 'os_repository'.
|
||||
# Only works if 'type' is set to 'opensource'.
|
||||
# Default is nginx_repository.
|
||||
install_from: nginx_repository
|
||||
|
||||
# Specify source repository for NGINX Open Source.
|
||||
# Only works if 'install_from' is set to 'nginx_repository'.
|
||||
# Defaults are the official NGINX repositories.
|
||||
nginx_repository:
|
||||
# Specify source repository for NGINX Open Source.
|
||||
# Only works if 'install_from' is set to 'nginx_repository'.
|
||||
# Defaults are the official NGINX repositories.
|
||||
nginx_repository:
|
||||
debian:
|
||||
- deb https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
- deb-src https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
@ -129,15 +146,15 @@ This role has multiple variables. The defaults for all these variables are the f
|
||||
suse:
|
||||
- https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}sles/12
|
||||
|
||||
# Specify which branch of NGINX Open Source you want to install.
|
||||
# Options are 'mainline' or 'stable'.
|
||||
# Only works if 'install_from' is set to 'nginx_repository'.
|
||||
# Default is mainline.
|
||||
branch: mainline
|
||||
# Specify which branch of NGINX Open Source you want to install.
|
||||
# Options are 'mainline' or 'stable'.
|
||||
# Only works if 'install_from' is set to 'nginx_repository'.
|
||||
# Default is mainline.
|
||||
branch: mainline
|
||||
|
||||
# Install NGINX JavaScript, Perl, ModSecurity WAF (NGINX Plus only), GeoIP, Image-Filter, RTMP Media Streaming, and/or XSLT modules.
|
||||
# Default is false.
|
||||
modules:
|
||||
# Install NGINX JavaScript, Perl, ModSecurity WAF (NGINX Plus only), GeoIP, Image-Filter, RTMP Media Streaming, and/or XSLT modules.
|
||||
# Default is false.
|
||||
modules:
|
||||
njs: false
|
||||
perl: false
|
||||
waf: false
|
||||
@ -146,58 +163,59 @@ This role has multiple variables. The defaults for all these variables are the f
|
||||
rtmp: false
|
||||
xslt: false
|
||||
|
||||
# Install NGINX Amplify.
|
||||
# Use your NGINX Amplify API key.
|
||||
# Default is null.
|
||||
amplify_enable: false
|
||||
amplify_key: null
|
||||
# Install NGINX Amplify.
|
||||
# Use your NGINX Amplify API key.
|
||||
# Default is null.
|
||||
amplify_enable: false
|
||||
amplify_key: null
|
||||
|
||||
# Enable NGINX status data.
|
||||
# Will enable 'stub_status' in NGINX Open Source and 'status' in NGINX Plus.
|
||||
# Default is false.
|
||||
status_enable: false
|
||||
# Enable NGINX status data.
|
||||
# Will enable 'stub_status' in NGINX Open Source and 'status' in NGINX Plus.
|
||||
# Default is false.
|
||||
status_enable: false
|
||||
|
||||
# Enable NGINX Plus REST API, write access to the REST API, and NGINX Plus dashboard.
|
||||
# Default is false.
|
||||
rest_api_enable: false
|
||||
rest_api_write: false
|
||||
rest_api_dashboard: false
|
||||
# Enable NGINX Plus REST API, write access to the REST API, and NGINX Plus dashboard.
|
||||
# Default is false.
|
||||
rest_api_enable: false
|
||||
rest_api_write: false
|
||||
rest_api_dashboard: false
|
||||
|
||||
# Location of your NGINX Plus license in your local machine.
|
||||
# Default is the files folder within the NGINX Ansible role.
|
||||
license:
|
||||
# Location of your NGINX Plus license in your local machine.
|
||||
# Default is the files folder within the NGINX Ansible role.
|
||||
license:
|
||||
certificate: license/nginx-repo.crt
|
||||
key: license/nginx-repo.key
|
||||
|
||||
# Enable uploading NGINX configuration files to your system.
|
||||
# Default for uploading files is false.
|
||||
# Default location of files is the files folder within the NGINX Ansible role.
|
||||
main_push_enable: false
|
||||
main_push_location: conf/nginx.conf
|
||||
http_push_enable: false
|
||||
http_push_location: conf/http/*.conf
|
||||
stream_push_enable: false
|
||||
stream_push_location: conf/stream/*.conf
|
||||
# Enable uploading NGINX configuration files to your system.
|
||||
# Default for uploading files is false.
|
||||
# Default location of files is the files folder within the NGINX Ansible role.
|
||||
main_push_enable: false
|
||||
main_push_location: conf/nginx.conf
|
||||
http_push_enable: false
|
||||
http_push_location: conf/http/*.conf
|
||||
stream_push_enable: false
|
||||
stream_push_location: conf/stream/*.conf
|
||||
|
||||
# Configuration variables to create a templated NGINX configuration.
|
||||
# Defaults are the values found in a fresh NGINX installation.
|
||||
main_template_enable: false
|
||||
main_template_user: nginx
|
||||
main_template_worker_processes: auto
|
||||
main_template_error_level: warn
|
||||
main_template_worker_connections: 1024
|
||||
http_template_enable: false
|
||||
http_template_keepalive_timeout: 65
|
||||
http_template_listen: 80
|
||||
http_template_server_name: localhost
|
||||
stream_template_enable: false
|
||||
stream_template_listen: 12345
|
||||
# Configuration variables to create a templated NGINX configuration.
|
||||
# Defaults are the values found in a fresh NGINX installation.
|
||||
main_template_enable: false
|
||||
main_template_user: nginx
|
||||
main_template_worker_processes: auto
|
||||
main_template_error_level: warn
|
||||
main_template_worker_connections: 1024
|
||||
http_template_enable: false
|
||||
http_template_keepalive_timeout: 65
|
||||
http_template_listen: 80
|
||||
http_template_server_name: localhost
|
||||
stream_template_enable: false
|
||||
stream_template_listen: 12345
|
||||
|
||||
# Install NGINX Unit and NGINX Unit modules.
|
||||
# Use a list of supported NGINX Unit modules.
|
||||
# Default is false.
|
||||
unit_enable: false
|
||||
unit_modules: null
|
||||
# Install NGINX Unit and NGINX Unit modules.
|
||||
# Use a list of supported NGINX Unit modules.
|
||||
# Default is false.
|
||||
unit_enable: false
|
||||
unit_modules: null
|
||||
```
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
@ -209,34 +227,41 @@ Example Playbook
|
||||
|
||||
This is a sample playbook file for deploying the Ansible Galaxy NGINX role in a localhost and installing the open source version of NGINX.
|
||||
|
||||
---
|
||||
- hosts: localhost
|
||||
```yaml
|
||||
---
|
||||
- hosts: localhost
|
||||
become: true
|
||||
roles:
|
||||
- role: nginxinc.nginx
|
||||
```
|
||||
|
||||
This is a sample playbook file for deploying the Ansible Galaxy NGINX role in a localhost and installing NGINX Plus.
|
||||
|
||||
---
|
||||
- hosts: localhost
|
||||
```yaml
|
||||
---
|
||||
- hosts: localhost
|
||||
become: true
|
||||
roles:
|
||||
- role: nginxinc.nginx
|
||||
vars:
|
||||
type: plus
|
||||
```
|
||||
|
||||
This is a sample playbook file for deploying the Ansible Galaxy NGINX role to a dynamic inventory containing the `nginx` tag.
|
||||
|
||||
---
|
||||
- hosts: tag_nginx
|
||||
```yml
|
||||
---
|
||||
- hosts: tag_nginx
|
||||
remote_user: root
|
||||
roles:
|
||||
- role: nginxinc.nginx
|
||||
```
|
||||
|
||||
This is a sample playbook file for deploying the Ansible Galaxy NGINX role in a localhost to install NGINX Unit and the PHP/Perl NGINX Unit language modules.
|
||||
|
||||
---
|
||||
- hosts: localhost
|
||||
```yml
|
||||
---
|
||||
- hosts: localhost
|
||||
become: true
|
||||
roles:
|
||||
- role: nginxinc.nginx
|
||||
@ -246,6 +271,7 @@ This is a sample playbook file for deploying the Ansible Galaxy NGINX role in a
|
||||
unit_modules:
|
||||
- unit-php
|
||||
- unit-perl
|
||||
```
|
||||
|
||||
To run any of the above sample playbooks create a `setup-nginx.yml` file and paste the contents. Executing the Ansible Playbook is then as simple as executing `ansible-playbook setup-nginx.yml`.
|
||||
|
||||
|
||||
@ -19,12 +19,12 @@ install_from: nginx_repository
|
||||
# Defaults are the official NGINX repositories.
|
||||
nginx_repository:
|
||||
debian:
|
||||
- deb https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
- deb-src https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
- deb https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/', '') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
- deb-src https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/', '') }}{{ ansible_distribution|lower }}/ {{ ansible_distribution_release }} nginx
|
||||
redhat:
|
||||
- https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}{{ (ansible_distribution == "RedHat") | ternary('rhel/', 'centos/') }}{{ ansible_distribution_major_version|int }}/$basearch/
|
||||
- https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/', '') }}{{ (ansible_distribution == "RedHat") | ternary('rhel/', 'centos/') }}{{ ansible_distribution_major_version|int }}/$basearch/
|
||||
suse:
|
||||
- https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/','') }}sles/12
|
||||
- https://nginx.org/packages/{{ (branch == 'mainline') | ternary('mainline/', '') }}sles/12
|
||||
|
||||
# Specify which branch of NGINX Open Source you want to install.
|
||||
# Options are 'mainline' or 'stable'.
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
galaxy_info:
|
||||
author: Alessandro Fael Garcia
|
||||
description: Official Ansible role for NGINX
|
||||
company: NGINX Inc
|
||||
company: NGINX, Inc.
|
||||
|
||||
license: Apache License, Version 2.0
|
||||
|
||||
@ -10,15 +11,14 @@ galaxy_info:
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- wheezy
|
||||
- jessie
|
||||
- stretch
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- precise
|
||||
- trusty
|
||||
- xenial
|
||||
- yakkety
|
||||
- artful
|
||||
- bionic
|
||||
- name: EL
|
||||
versions:
|
||||
- 6
|
||||
@ -26,6 +26,10 @@ galaxy_info:
|
||||
- name: SLES
|
||||
versions:
|
||||
- 12
|
||||
- name: FreeBSD
|
||||
versions:
|
||||
- 10
|
||||
- 11
|
||||
|
||||
galaxy_tags:
|
||||
- nginx
|
||||
|
||||
Loading…
Reference in New Issue
Block a user