Skip to content

Commit 17c44a8

Browse files
alessfgalessfg
committed
Update README
1 parent 3f05ea3 commit 17c44a8

File tree

3 files changed

+43
-41
lines changed

3 files changed

+43
-41
lines changed

‎.github/release-drafter.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ template: |
8888
8989
## Install & Upgrade
9090
91-
* To install the Ansible NGINX config role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_config`.
92-
* To upgrade the Ansible NGINX config role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_config`.
93-
* To install or upgrade to this specific Ansible NGINX config role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_config,v$RESOLVED_VERSION`.
91+
* To install the Ansible NGINX config role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_config`.
92+
* To upgrade the Ansible NGINX config role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_config`.
93+
* To install or upgrade to this specific Ansible NGINX config role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_config,v$RESOLVED_VERSION`.
9494
9595
## Resources
9696
97-
* Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-config/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-config/tree/$RESOLVED_VERSION/molecule).
98-
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx_config).
99-
* NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
100-
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).
97+
* Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-config/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-config/tree/$RESOLVED_VERSION/molecule).
98+
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx_config).
99+
* NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
100+
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

‎README.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ This role configures NGINX Open Source and NGINX Plus on your target host.
1616

1717
### Ansible
1818

19-
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core (above `2.11`) and Ansible (above `2.9.10`).
20-
* When using Ansible base, you will also need to install the following collections:
19+
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core (above `2.11`).
20+
* When using Ansible core, you will also need to install the following collections:
2121

2222
```yaml
2323
---
@@ -33,13 +33,13 @@ This role configures NGINX Open Source and NGINX Plus on your target host.
3333
3434
### Jinja2
3535
36-
* 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`.
36+
* 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 is `2.11`.
3737
* Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/2.11.x/intro/#installation).
3838

39-
### Molecule
39+
### Molecule (Optional)
4040

4141
* Molecule is used to test the various functionalities of the role. The recommended version of Molecule to test this role is `3.3`.
42-
* Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
42+
* Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html). _You will also need to install the Molecule Docker driver._
4343

4444
## Installation
4545

@@ -62,88 +62,90 @@ Alpine:
6262
- 3.11
6363
- 3.12
6464
- 3.13
65+
- 3.14
66+
Amazon Linux:
67+
- 2
6568
CentOS:
6669
- 7.4+
6770
- 8
6871
Debian:
69-
- buster
70-
RedHat:
72+
- buster (10)
73+
- bullseye (11)
74+
Red Hat:
7175
- 7.4+
7276
- 8
7377
SUSE/SLES:
7478
- 12
7579
- 15
7680
Ubuntu:
77-
- bionic
78-
- focal
79-
- hirsute
81+
- bionic (18.04)
82+
- focal (20.04)
83+
- hirsute (21.04)
8084
```
8185

8286
### NGINX Plus
8387

8488
```yaml
8589
Alpine:
86-
- 3.10
8790
- 3.11
8891
- 3.12
8992
- 3.13
90-
Amazon Linux:
91-
- 2018.03
93+
- 3.14
9294
Amazon Linux 2:
9395
- any
9496
CentOS:
9597
- 7.4+
9698
- 8
9799
Debian:
98-
- buster
100+
- buster (10)
101+
- bullseye (11)
99102
FreeBSD:
100-
- 11.2+
101103
- 12.1+
104+
- 13
102105
Oracle Linux:
103106
- 7.4+
104-
RedHat:
107+
Red Hat:
105108
- 7.4+
106109
- 8
107110
SUSE/SLES:
108111
- 12
109112
- 15
110113
Ubuntu:
111-
- xenial
112-
- bionic
113-
- focal
114+
- bionic (18.04)
115+
- focal (20.04)
114116
```
115117

116118
## Role Variables
117119

118120
This role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/)** folder in the following files:
119121

120-
|Name|Description|
121-
|----|-----------|
122-
|**[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/main.yml)**|NGINX simple config variables|
123-
|**[`selinux.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/selinux.yml)**|Set up SELinux to allow the necessary connections to your NGINX setup|
124-
|**[`template.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/template.yml)**|NGINX config template variables|
125-
|**[`upload.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/upload.yml)**|NGINX config/HTML/SSL upload variables|
122+
| Name | Description |
123+
| ---- | ----------- |
124+
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/main.yml)** | NGINX simple config variables |
125+
| **[`selinux.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/selinux.yml)** | Set up SELinux to allow the necessary connections to your NGINX setup |
126+
| **[`template.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/template.yml)** | NGINX config template variables |
127+
| **[`upload.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/upload.yml)** | NGINX config/HTML/SSL upload variables |
126128

127129
## Example Playbooks
128130

129131
Working functional playbook examples can be found in the **[`molecule/`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/)** folder in the following files:
130132

131-
|Name|Description|
132-
|----|-----------|
133-
|**[`cleanup_module/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/cleanup_module/converge.yml)**|Cleanup an NGINX config and configure NGINX supported modules|
134-
|**[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/default/converge.yml)**|Use the NGINX config templating variables to create an NGINX config|
135-
|**[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/plus/converge.yml)**|Use the NGINX config templating variables to create an NGINX Plus config|
136-
|**[`stable_push/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/stable_push/converge.yml)**|Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance|
133+
| Name | Description |
134+
| ---- | ----------- |
135+
| **[`cleanup_module/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/cleanup_module/converge.yml)** | Cleanup an NGINX config and configure NGINX supported modules |
136+
| **[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/default/converge.yml)** | Use the NGINX config templating variables to create an NGINX config |
137+
| **[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/plus/converge.yml)** | Use the NGINX config templating variables to create an NGINX Plus config |
138+
| **[`stable_push/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/stable_push/converge.yml)** | Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance |
137139

138140
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`.
139141

140142
## Other NGINX Ansible Collections and Roles
141143

142144
You can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect [here](https://github.com/nginxinc/ansible-collection-nginx).
143145

144-
You can find the Ansible NGINX role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx).
146+
You can find the Ansible NGINX role to install NGINX OSS and NGINX Plus [here](https://github.com/nginxinc/ansible-role-nginx).
145147

146-
You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect).
148+
You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect WAF and NGINX App Protect DoS [here](https://github.com/nginxinc/ansible-role-nginx-app-protect).
147149

148150
You can find the Ansible NGINX Controller collection of roles to install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller).
149151

‎meta/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ galaxy_info:
88

99
license: Apache License, Version 2.0
1010

11-
min_ansible_version: 2.10
11+
min_ansible_version: 2.11
1212

1313
platforms:
1414
- name: Alpine

0 commit comments

Comments
 (0)