Skip to content

Commit 9fba60c

Browse files
alessfgalessfg
authored
Add survey to README (#35)
1 parent fdaa5c8 commit 9fba60c

File tree

2 files changed

+57
-52
lines changed

2 files changed

+57
-52
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
## 0.3.3 (Unreleased)
4+
5+
ENHANCEMENTS:
6+
7+
* Add survey to README.
8+
* Improve README structure and use tables where relevant.
9+
310
## 0.3.2 (September 30, 2020)
411

512
BUG FIXES:

‎README.md

Lines changed: 50 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,45 @@
1-
<img src="images/nap-logo.png" width="60">
1+
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx__app__protect-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_app_protect)
2+
[![Build Status](https://travis-ci.org/nginxinc/ansible-role-nginx-app-protect.svg?branch=main)](https://travis-ci.org/nginxinc/ansible-role-nginx-app-protect)
3+
[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
24

3-
NGINX App Protect Ansible Role
4-
==============================
5+
# 👾 *Help make the NGINX App Protect Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
56

6-
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_app_protect)
7-
[![Build Status](https://travis-ci.org/nginxinc/ansible-role-nginx-app-protect.svg?branch=main)](https://travis-ci.org/nginxinc/ansible-role-nginx-app-protect)
7+
# NGINX App Protect Ansible Role <img src="images/nap-logo.png" width="30">
88

99
This role installs and configures NGINX App Protect (WAF) for NGINX Plus on your target host.
1010

1111
**Note:** This role is still in active development. There may be unidentified issues and the role variables may change as development continues.
1212

13-
Requirements
14-
------------
13+
## Requirements
1514

16-
**Ansible**
15+
### Ansible
1716

18-
This role was developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
17+
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
18+
* Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
1919

20-
Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
20+
### Molecule
2121

22-
**Molecule**
22+
* Molecule `3.x` is used to test the various functionalities of the role.
23+
* Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
24+
* To run the Molecule tests, you must first add your NGINX repository certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests:
25+
``` bash
26+
export NGINX_CRT=$( cat <path to your certificate file> | base64 )
27+
export NGINX_KEY=$( cat <path to your key file> | base64 )
28+
molecule test
29+
```
30+
You can alternatively copy your NGINX license to the role's [`files/license`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/files/license/) folder.
2331
24-
Molecule is used to test the various functionalities of the role. Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/stable/installation.html).
32+
## Installation
2533
26-
To run the Molecule tests, you must first add your NGINX repository certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests:
27-
28-
``` bash
29-
export NGINX_CRT=$( cat <path to your certificate file> | base64 )
30-
export NGINX_KEY=$( cat <path to your key file> | base64 )
31-
molecule test
32-
```
33-
34-
Installation
35-
------------
36-
37-
**Ansible Galaxy**
34+
### Ansible Galaxy
3835
3936
Use `ansible-galaxy install nginxinc.nginx_app_protect` to install the latest stable release of the role on your system.
4037
41-
**Git**
38+
### Git
4239
4340
Use `git clone https://github.com/nginxinc/ansible-role-nginx-app-protect.git` to pull the latest edge commit of the role from GitHub.
4441
45-
Platforms
46-
---------
42+
## Platforms
4743
4844
The NGINX App Protect Ansible role supports all platforms supported by [NGINX Plus](https://www.nginx.com/products/technical-specs/) that intersect with the following list:
4945
@@ -58,51 +54,53 @@ Ubuntu:
5854
- 18.04
5955
```
6056
61-
Role Variables
62-
--------------
57+
## Role Variables
58+
59+
This role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/defaults/)** folder in the following files:
6360
64-
This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults`** directory in the following files:
61+
|Name|Description|
62+
|----|-----------|
63+
|**[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/defaults/main.yml):|NGINX App Protect installation and configuration variables|
6564
66-
- **[defaults/main.yml](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/defaults/main.yml)**: NGINX App Protect installation and configuration variables
65+
Similarly, descriptions and defaults for preset variables can be found in the **`vars/`** folder in the following files:
6766
68-
Similarly, descriptions and defaults for preset variables can be found in the **`vars`** directory in the following files:
67+
|Name|Description|
68+
|----|-----------|
69+
|**[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/vars/main.yml)**|List of supported NGINX App Protect platforms|
6970
70-
- **[vars/main.yml](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/vars/main.yml):** List of supported NGINX App Protect platforms
71+
## Dependencies
7172
72-
Dependencies
73-
------------
73+
* Since this role uses the [package_facts](https://docs.ansible.com/ansible/latest/modules/package_facts_module.html) module, on debian-based systems the `python-apt` package must be installed on targeted hosts.
7474
75-
- Since this role uses the [package_facts](https://docs.ansible.com/ansible/latest/modules/package_facts_module.html) module, on debian-based systems the `python-apt` package must be installed on targeted hosts.
75+
* If NGINX Plus is *not* already installed on the system, this role will install the version of NGINX Plus that is dependent on the version of NGINX App Protect set with the `nginx_app_protect_version` variable. If none is specified, the latest version of NGINX Plus and NGINX App Protect will be installed.
7676
77-
- If NGINX Plus is *not* already installed on the system, this role will install the version of NGINX Plus that is dependent on the version of NGINX App Protect set with the `nginx_app_protect_version` variable. If none is specified, the latest version of NGINX Plus and NGINX App Protect will be installed.
77+
* When using the `nginx_app_protect_version` variable, a specific version of NGINX Plus must already be installed on the target system.
7878
79-
- When using the `nginx_app_protect_version` variable, a specific version of NGINX Plus must already be installed on the target system.
79+
## Example Playbook
8080
81-
Example Playbook
82-
----------------
81+
A working functional playbook example can be found in the **`molecule/default/`** folder in the following file:
8382
84-
A working functional playbook example can be found in the **`molecule/default`** directory in the following file:
83+
|Name|Description|
84+
|----|-----------|
85+
|**[`molecule/default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/molecule/default/converge.yml)**|Install and configure NGINX App Protect|
8586
86-
- **[molecule/default/converge.yml](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/molecule/default/converge.yml):** Install and configure NGINX App Protect
87+
## Other NGINX Ansible Collections and Roles
8788
88-
Other NGINX Roles
89-
-----------------
89+
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).
9090
91-
You can find an Ansible role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx)
91+
You can find the Ansible NGINX role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx).
9292
93-
You can find an Ansible role to configure NGINX [here](https://github.com/nginxinc/ansible-role-nginx-config)
93+
You can find the Ansible NGINX configuration role to configure NGINX [here](https://github.com/nginxinc/ansible-role-nginx-config).
9494
95-
You can find an Ansible collection of roles to help you install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller)
95+
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).
9696
97-
You can find an Ansible role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit)
97+
You can find the Ansible NGINX Unit role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit).
9898
99-
License
100-
-------
99+
## License
101100
102101
[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/main/LICENSE)
103102
104-
Author Information
105-
------------------
103+
## Author Information
106104
107105
[Daniel Edgar](https://github.com/aknot242)
108106

0 commit comments

Comments
 (0)