Skip to content

Commit 283e7e2

Browse files
alessfgalessfg
committed
Markdown updates
1 parent 6fb4c9c commit 283e7e2

File tree

7 files changed

+128
-111
lines changed

7 files changed

+128
-111
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,28 @@ labels: ''
66
assignees: ''
77
---
88
### Describe the bug
9+
910
A clear and concise description of what the bug is.
1011

1112
### To reproduce
13+
1214
Steps to reproduce the behavior:
15+
1316
1. Deploy NGINX App Protect role using playbook.yml
1417
2. View output/logs/configuration on '...'
1518
3. See error
1619

1720
### Expected behavior
21+
1822
A clear and concise description of what you expected to happen.
1923

20-
### Your environment:
21-
- Version of the NGINX App Protect role or specific commit
22-
- Version of Ansible
23-
- Version of Jinja2 (if you are using any templating capability)
24-
- Target deployment platform
24+
### Your environment
25+
26+
- Version of the NGINX App Protect role or specific commit
27+
- Version of Ansible
28+
- Version of Jinja2 (if you are using any templating capability)
29+
- Target deployment platform
2530

2631
### Additional context
32+
2733
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@ labels: ''
66
assignees: ''
77
---
88
### Is your feature request related to a problem? Please describe
9+
910
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
1011

1112
### Describe the solution you'd like
13+
1214
A clear and concise description of what you want to happen.
1315

1416
### Describe alternatives you've considered
17+
1518
A clear and concise description of any alternative solutions or features you've considered.
1619

1720
### Additional context
21+
1822
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
### Proposed changes
2+
23
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) here in this description (not in the title of the PR).
34

45
### Checklist
6+
57
Before creating a PR, run through this checklist and mark each as complete.
68

7-
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/CONTRIBUTING.md) document
8-
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
9-
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
10-
- [ ] I have updated any relevant documentation (`defaults/main.yml`, `README.md` and `CHANGELOG.md`)
9+
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/CONTRIBUTING.md) document
10+
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
11+
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
12+
- [ ] I have updated any relevant documentation (`defaults/main.yml`, `README.md` and `CHANGELOG.md`)

‎CHANGELOG.md

Lines changed: 66 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Remove deprecated variables mentioned in the `0.5.0` release. These involve temp
1414

1515
FEATURES:
1616

17-
* Add support for NGINX App Protect DoS (Denial of Service) product. The `nginx_app_protect_dos_enable` variable must be set to `true` in order to install NGINX App Protect DoS.
18-
* Add support for NGINX App Protect WAF on Amazon Linux 2 (requires NGINX App Protect 3.3).
19-
* Add a `nginx_app_protect_manage_repo` feature flag which can be used to disable NGINX App Protect repo management by this role.
17+
* Add support for NGINX App Protect DoS (Denial of Service) product. The `nginx_app_protect_dos_enable` variable must be set to `true` in order to install NGINX App Protect DoS.
18+
* Add support for NGINX App Protect WAF on Amazon Linux 2 (requires NGINX App Protect 3.3).
19+
* Add a `nginx_app_protect_manage_repo` feature flag which can be used to disable NGINX App Protect repo management by this role.
2020

2121
ENHANCEMENTS:
2222

23-
* Replace Ansible base with Ansible core. Ansible core will be the "core" Ansible release moving forward from Ansible `2.11`.
24-
* Update GitHub actions to add a workflow dispatch option.
25-
* Update the Ansible `community.general` collection to `3.3.2` and `community.docker` collection to `1.8.0`.
26-
* Replace "yes"/"no" boolean values with "true"/"false" to comply with YAML spec `1.2`.
27-
* Update `nginx` role requirement in Molecule tests to `0.20.0`.
23+
* Replace Ansible base with Ansible core. Ansible core will be the "core" Ansible release moving forward from Ansible `2.11`.
24+
* Update GitHub actions to add a workflow dispatch option.
25+
* Update the Ansible `community.general` collection to `3.3.2` and `community.docker` collection to `1.8.0`.
26+
* Replace "yes"/"no" boolean values with "true"/"false" to comply with YAML spec `1.2`.
27+
* Update `nginx` role requirement in Molecule tests to `0.20.0`.
2828

2929
## 0.5.0 (May 12, 2021)
3030

@@ -34,20 +34,20 @@ The NGINX App Protect repository has been updated. This might cause some issues
3434

3535
DEPRECATION WARNINGS:
3636

37-
* **The ability to create an NGINX config including some basic App Protect directives will be removed in the upcoming `0.6.0` release at some stage after June 2021.** Please use the [NGINX config role](https://github.com/nginxinc/ansible-role-nginx-config) instead for this (and much more) functionality. This will include the removal of the following variables: `nginx_app_protect_conf_template_enable`, `nginx_app_protect_conf_template`, `nginx_app_protect_demo_workload_protocol`, `nginx_app_protect_demo_workload_host`, `nginx_app_protect_log_policy_syslog_target`, `nginx_app_protect_log_policy_target`.
37+
* **The ability to create an NGINX config including some basic App Protect directives will be removed in the upcoming `0.6.0` release at some stage after June 2021.** Please use the [NGINX config role](https://github.com/nginxinc/ansible-role-nginx-config) instead for this (and much more) functionality. This will include the removal of the following variables: `nginx_app_protect_conf_template_enable`, `nginx_app_protect_conf_template`, `nginx_app_protect_demo_workload_protocol`, `nginx_app_protect_demo_workload_host`, `nginx_app_protect_log_policy_syslog_target`, `nginx_app_protect_log_policy_target`.
3838

39-
* **The ability to dynamically create App Protect security and log policies via Jinja2 templates will be removed in the `0.6.0` release at some stage after June 2021 due to relative inflexibility.** The `nginx_app_protect_security_policy_file_enable`, `nginx_app_protect_security_policy_file_*`, `nginx_app_protect_log_policy_file_enable` and `nginx_app_protect_log_policy_file_*` variables should be used instead of the following variables which are to be removed: `nginx_app_protect_security_policy_template_enable`, `nginx_app_protect_security_policy_template`, `nginx_app_protect_security_policy_enforcement_mode`, `nginx_app_protect_log_policy_template_enable`, `nginx_app_protect_log_policy_template`, `nginx_app_protect_log_policy_filter_request_type`.
39+
* **The ability to dynamically create App Protect security and log policies via Jinja2 templates will be removed in the `0.6.0` release at some stage after June 2021 due to relative inflexibility.** The `nginx_app_protect_security_policy_file_enable`, `nginx_app_protect_security_policy_file_*`, `nginx_app_protect_log_policy_file_enable` and `nginx_app_protect_log_policy_file_*` variables should be used instead of the following variables which are to be removed: `nginx_app_protect_security_policy_template_enable`, `nginx_app_protect_security_policy_template`, `nginx_app_protect_security_policy_enforcement_mode`, `nginx_app_protect_log_policy_template_enable`, `nginx_app_protect_log_policy_template`, `nginx_app_protect_log_policy_filter_request_type`.
4040

4141
FEATURES:
4242

43-
* Implement Release Drafter.
44-
* Add warning re having to install NGINX Plus beforehand on Alpine distros if NGINX Plus releases a security patch.
43+
* Implement Release Drafter.
44+
* Add warning re having to install NGINX Plus beforehand on Alpine distros if NGINX Plus releases a security patch.
4545

4646
ENHANCEMENTS:
4747

48-
* Changing the default policy directory from `/etc/nginx` to `/etc/app_protect/conf` to align with this change introduced in App Protect 3.2.
49-
* Update Ansible base to `2.10.9`, Ansible Lint to `5.0.8`, yamllint to `1.26.1` and Docker Python SDK to `5.0.0`.
50-
* Update the Ansible `community.general` collection to `3.0.2` and `community.docker` collection to `1.6.0`.
48+
* Changing the default policy directory from `/etc/nginx` to `/etc/app_protect/conf` to align with this change introduced in App Protect 3.2.
49+
* Update Ansible base to `2.10.9`, Ansible Lint to `5.0.8`, yamllint to `1.26.1` and Docker Python SDK to `5.0.0`.
50+
* Update the Ansible `community.general` collection to `3.0.2` and `community.docker` collection to `1.6.0`.
5151

5252
## 0.4.3 (April 6, 2021)
5353

@@ -57,8 +57,9 @@ The `nginx_app_protect_version` variable has been removed, as it cannot be imple
5757

5858
FEATURES:
5959

60-
* Add support for Dependabot.
61-
* Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are:
60+
* Add support for Dependabot.
61+
* Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are:
62+
6263
```yaml
6364
---
6465
collections:
@@ -67,22 +68,23 @@ FEATURES:
6768
- name: ansible.posix
6869
version: 1.2.0
6970
```
70-
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
71-
* You can now specify an `nginx_app_protect_repository` for NGINX App Protect.
72-
* You can now specify an `nginx_app_protect_security_updates_repository` for NGINX App Protect signatures and threat campaigns packages.
73-
* You can now specify NGINX App Protect signatures and threat campaigns package versions using the `nginx_app_protect_signatures_version` and `nginx_app_protect_threat_campaigns_version` variables.
71+
72+
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
73+
* You can now specify an `nginx_app_protect_repository` for NGINX App Protect.
74+
* You can now specify an `nginx_app_protect_security_updates_repository` for NGINX App Protect signatures and threat campaigns packages.
75+
* You can now specify NGINX App Protect signatures and threat campaigns package versions using the `nginx_app_protect_signatures_version` and `nginx_app_protect_threat_campaigns_version` variables.
7476

7577
ENHANCEMENTS:
7678

77-
* Support for NGINX App Protect 3.1 -- Adds support for Debian 10, Ubuntu 20.04 and Alpine 3.10.
78-
* Add test coverage for new platforms and testing scenario.
79-
* Consolidate dependencies into a single tasks file.
80-
* Remove requirement for `package_facts` module when using this role.
81-
* Update Signatures repository URL.
82-
* Update Ansible base to `2.10.7`, Ansible Lint to `5.0.6`, Molecule to `3.3.0`, yamllint to `1.26.0` and Docker Python SDK to `4.4.4`.
83-
* Specify GitHub actions Ubuntu release.
84-
* Minor GitHub template tweaks, including the creation of a SECURITY doc.
85-
* Only run GitHub actions Galaxy CI/CD workflow when a new release is published.
79+
* Support for NGINX App Protect 3.1 -- Adds support for Debian 10, Ubuntu 20.04 and Alpine 3.10.
80+
* Add test coverage for new platforms and testing scenario.
81+
* Consolidate dependencies into a single tasks file.
82+
* Remove requirement for `package_facts` module when using this role.
83+
* Update Signatures repository URL.
84+
* Update Ansible base to `2.10.7`, Ansible Lint to `5.0.6`, Molecule to `3.3.0`, yamllint to `1.26.0` and Docker Python SDK to `4.4.4`.
85+
* Specify GitHub actions Ubuntu release.
86+
* Minor GitHub template tweaks, including the creation of a SECURITY doc.
87+
* Only run GitHub actions Galaxy CI/CD workflow when a new release is published.
8688

8789
KNOWN ISSUES:
8890

@@ -92,9 +94,9 @@ Service manager support is not included in NGINX App Protect for Alpine. When us
9294

9395
ENHANCEMENTS:
9496

95-
* Replace TravisCI with GitHub actions.
96-
* Update Ansible base to `2.10.4`, Ansible to `2.10.5`, Molecule to `3.2.2` and Docker Python SDK to `4.4.1`.
97-
* Update copyright notice.
97+
* Replace TravisCI with GitHub actions.
98+
* Update Ansible base to `2.10.4`, Ansible to `2.10.5`, Molecule to `3.2.2` and Docker Python SDK to `4.4.1`.
99+
* Update copyright notice.
98100

99101
BUG FIXES:
100102

@@ -114,12 +116,12 @@ The ability to dynamically create App Protect security and log policies via Jinj
114116

115117
ENHANCEMENTS:
116118

117-
* Add survey to README.
118-
* Improve README structure and use tables where relevant.
119-
* Update Ansible (now Ansible base) to `2.10.2`, Ansible (now Ansible Community Distribution) to `2.10.0`, and yamllint to `1.25.0`.
120-
* Ability to deploy static security policy files via the `nginx_app_protect_security_policy_file_enable` and `nginx_app_protect_security_policy_file_*` variables. NOTE: `nginx_app_protect_configure` must be set to true.
121-
* Ability to deploy static log policy files via the `nginx_app_protect_log_policy_file_enable` and `nginx_app_protect_log_policy_file_*` variables. NOTE: `nginx_app_protect_configure` must be set to true.
122-
* Add CentOS/RHEL 7.9 to list of supported platforms.
119+
* Add survey to README.
120+
* Improve README structure and use tables where relevant.
121+
* Update Ansible (now Ansible base) to `2.10.2`, Ansible (now Ansible Community Distribution) to `2.10.0`, and yamllint to `1.25.0`.
122+
* Ability to deploy static security policy files via the `nginx_app_protect_security_policy_file_enable` and `nginx_app_protect_security_policy_file_*` variables. NOTE: `nginx_app_protect_configure` must be set to true.
123+
* Ability to deploy static log policy files via the `nginx_app_protect_log_policy_file_enable` and `nginx_app_protect_log_policy_file_*` variables. NOTE: `nginx_app_protect_configure` must be set to true.
124+
* Add CentOS/RHEL 7.9 to list of supported platforms.
123125

124126
## 0.3.2 (September 30, 2020)
125127

@@ -131,19 +133,19 @@ Prevent TravisCI from trying to build (and failing) NGINX App Protect images on
131133

132134
FEATURES:
133135

134-
* Two new variables have been introduced:
135-
* `nginx_app_protect_service_modify` -- Setting this variable to true/false will determine whether the default service timeout value gets modified.
136-
* `nginx_app_protect_log_policy_target` -- This variable is intended as an eventual replacement for `nginx_app_protect_log_policy_syslog_target` and allows using different destinations for NGINX App Protect's log files.
136+
* Two new variables have been introduced:
137+
* `nginx_app_protect_service_modify` -- Setting this variable to true/false will determine whether the default service timeout value gets modified.
138+
* `nginx_app_protect_log_policy_target` -- This variable is intended as an eventual replacement for `nginx_app_protect_log_policy_syslog_target` and allows using different destinations for NGINX App Protect's log files.
137139

138140
ENHANCEMENTS:
139141

140142
Split the default Molecule scenario into a simple and advanced scenario to solve timeout issues encountered in TravisCI.
141143

142144
BUG FIXES:
143145

144-
* Rename handlers to use more specific role related naming and prevent namespace collision issues.
145-
* Set NGINX handler to `state: restarted` to prevent some compatibility issues when NGINX App Protect is installed on an instance already running NGINX beforehand.
146-
* Using `update_cache: true` by itself in the `apt` module is not always idempotent. Moved the NGINX App Protect installation task to a corresponding `apt` or `yum` module to avoid this scenario.
146+
* Rename handlers to use more specific role related naming and prevent namespace collision issues.
147+
* Set NGINX handler to `state: restarted` to prevent some compatibility issues when NGINX App Protect is installed on an instance already running NGINX beforehand.
148+
* Using `update_cache: true` by itself in the `apt` module is not always idempotent. Moved the NGINX App Protect installation task to a corresponding `apt` or `yum` module to avoid this scenario.
147149

148150
## 0.3.0 (September 21, 2020)
149151

@@ -158,16 +160,17 @@ BREAKING CHANGES:
158160
FEATURES:
159161

160162
A new variable has been introduced:
161-
* `nginx_app_protect_setup_license` -- Determine whether you want to use this role to upload your NGINX App Protect license to your target host.
163+
164+
* `nginx_app_protect_setup_license` -- Determine whether you want to use this role to upload your NGINX App Protect license to your target host.
162165

163166
ENHANCEMENTS:
164167

165-
* Switch to using `ansible_facts` wherever possible.
166-
* Simplified overall role structure by:
167-
* Reducing signing key setup tasks to a single file.
168-
* Merging all install steps to a single file.
169-
* Added handlers to check for NGINX syntax validity and fail if any errors are detected.
170-
* Update Ansible Lint to `4.3.5`.
168+
* Switch to using `ansible_facts` wherever possible.
169+
* Simplified overall role structure by:
170+
* Reducing signing key setup tasks to a single file.
171+
* Merging all install steps to a single file.
172+
* Added handlers to check for NGINX syntax validity and fail if any errors are detected.
173+
* Update Ansible Lint to `4.3.5`.
171174

172175
## 0.2.2 (September 15, 2020)
173176

@@ -183,31 +186,31 @@ Fixed newly appearing linting issues in role.
183186

184187
ENHANCEMENTS:
185188

186-
* Bring docs up to speed with other NGINX roles.
187-
* Move some default variables into the vars subfolder.
189+
* Bring docs up to speed with other NGINX roles.
190+
* Move some default variables into the vars subfolder.
188191

189192
## 0.2.0 (September 10, 2020)
190193

191194
BREAKING CHANGES:
192195

193-
* All of the variables have been updated to prevent naming collisions when using other roles. Please see README.MD for new variable names.
194-
* Example playbook has been removed by collection authors in favor of using the Molecule configuration as a 'known-working' implementation.
196+
* All of the variables have been updated to prevent naming collisions when using other roles. Please see README.MD for new variable names.
197+
* Example playbook has been removed by collection authors in favor of using the Molecule configuration as a 'known-working' implementation.
195198

196199
FEATURES:
197200

198-
* Molecule 3 testing foundation is in the project, and linting is being performed by TravisCI. Now time to write tests!
201+
* Molecule 3 testing foundation is in the project, and linting is being performed by TravisCI. Now time to write tests!
199202

200203
ENHANCEMENTS:
201204

202-
* Huge refactoring by @alessfg to better unify this role with the structures present in the other nginxinc Ansible roles.
203-
* Update Ansible to `2.9.13` and Ansible Lint to `4.3.4`.
204-
* Explicitly defined mode in relevant tasks for breaking changes in Ansible.
205-
* Role refactored to separate install and configure operations in preparation for an upcoming role split.
205+
* Huge refactoring by @alessfg to better unify this role with the structures present in the other nginxinc Ansible roles.
206+
* Update Ansible to `2.9.13` and Ansible Lint to `4.3.4`.
207+
* Explicitly defined mode in relevant tasks for breaking changes in Ansible.
208+
* Role refactored to separate install and configure operations in preparation for an upcoming role split.
206209

207210
BUG FIXES:
208211

209-
* The CentOS, RHEL, Debian and Ubuntu repositories have slightly changed to respond to a NAP repository deprecation activity. You may run into some duplication issues when running the role on a preexisting target that already has had NGINX installed using the role. To fix this, manually remove the old repository source.
210-
* The RHEL and CentOS repository setups were incorrectly using a static gpgkey instead of using the variable as a source.
212+
* The CentOS, RHEL, Debian and Ubuntu repositories have slightly changed to respond to a NAP repository deprecation activity. You may run into some duplication issues when running the role on a preexisting target that already has had NGINX installed using the role. To fix this, manually remove the old repository source.
213+
* The RHEL and CentOS repository setups were incorrectly using a static gpgkey instead of using the variable as a source.
211214

212215
## 0.1.0 (September 9, 2020)
213216

‎CODE_OF_CONDUCT.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,8 @@ members of the project's leadership.
6767

6868
## Attribution
6969

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72-
73-
[homepage]: https://www.contributor-covenant.org
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7472

7573
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
74+
<https://www.contributor-covenant.org/faq>

0 commit comments

Comments
 (0)