Skip to content

Commit 3bfd238

Browse files
committed
docs: Tweak README
1 parent 3c4bfd0 commit 3bfd238

File tree

1 file changed

+54
-45
lines changed

1 file changed

+54
-45
lines changed

README.md

Lines changed: 54 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,62 +18,71 @@ This role installs NGINX Open Source, NGINX Plus, NGINX Agent or the NGINX Ampli
1818

1919
### NGINX
2020

21-
Depending on your target NGINX use case, you might need to obtain some data before being able to use the role.
21+
Depending on your target NGINX use case, you might need to obtain a license or API key/token before being able to use the role:
2222

23-
#### NGINX Open Source (NGINX OSS)
23+
- **NGINX Open Source (NGINX OSS):**
2424

25-
You do not need to do anything beforehand if you want to install NGINX OSS.
25+
You do not need to do anything beforehand if you want to install NGINX OSS.
2626

27-
#### NGINX Plus
27+
- **NGINX Plus:**
2828

29-
If you wish to install NGINX Plus using this role, you will need to obtain an NGINX Plus license beforehand.
29+
If you wish to install NGINX Plus using this role, you will need to obtain an NGINX Plus license beforehand.
3030

31-
#### NGINX Agent
31+
- **NGINX Agent:**
3232

33-
If you wish to install and configure the NGINX Agent, you will need: to have previously set up a compatible control plane. Check out the [NGINX Agent docs](https://docs.nginx.com/nginx-agent/overview/) for more info.
33+
If you wish to install and configure the NGINX Agent, you will need: to have previously set up a compatible control plane. Check out the [NGINX Agent docs](https://docs.nginx.com/nginx-agent/overview/) for more info.
3434

35-
In addition, if you wish to connect the NGINX Agent to the NGINX One SaaS control plane available in the F5 Distributed Cloud, you will also need the data plane token provided by the NGINX One SaaS control plane.
35+
In addition, if you wish to connect the NGINX Agent to the NGINX One SaaS control plane available in the F5 Distributed Cloud, you will also need the data plane token provided by the NGINX One SaaS control plane.
3636

37-
#### NGINX Amplify
37+
- **NGINX Amplify:**
3838

39-
If you wish to install the NGINX Amplify agent, you will need the API key provided within the NGINX Amplify SaaS console.
39+
If you wish to install the NGINX Amplify agent, you will need the API key provided within the NGINX Amplify SaaS console.
4040

4141
### Ansible
4242

43+
If you want to use this role, you will need to use a supported version of Ansible core and Jinja2 as well as a few Ansible collections.
44+
45+
For ease of use, you can install and/or upgrade Ansible core, Jinja2, and the aforementioned Ansible collections by running the following four commands on your Ansible host:
46+
47+
```bash
48+
pip install --upgrade -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible.txt
49+
curl -O https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_collections.yml
50+
ansible-galaxy install --force -r requirements_collections.yml
51+
rm -f requirements_collections.yml
52+
```
53+
54+
This will also ensure you are deploying/running this role with a fully tested version of the aforementioned packages/collections.
55+
56+
#### Ansible core
57+
4358
- This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core and Python.
44-
- When using Ansible core, you will also need to install the following collections:
45-
46-
```yaml
47-
---
48-
collections:
49-
- name: ansible.posix
50-
version: 1.5.4
51-
- name: community.general
52-
version: 9.0.1
53-
- name: community.crypto # Only required if you plan to install NGINX Plus
54-
version: 2.20.0
55-
- name: community.docker # Only required if you plan to use Molecule (see below)
56-
version: 3.10.3
57-
```
58-
59-
> [!TIP]
60-
> You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
59+
- When using Ansible core, you will also need to install the following Ansible collections:
60+
61+
```yaml
62+
---
63+
collections:
64+
- name: ansible.posix
65+
version: 1.5.4
66+
- name: community.general
67+
version: 9.0.1
68+
- name: community.crypto # Only required if you plan to install NGINX Plus
69+
version: 2.20.0
70+
- name: community.docker # Only required if you plan to use Molecule (see below)
71+
version: 3.10.3
72+
```
73+
6174
- You will need to run this role as a root user using Ansible's `become` parameter. Make sure you have set up the appropriate permissions on your target hosts.
62-
- Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later).
75+
- Instructions on how to install Ansible core can be found in the [Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later) docs.
76+
- Instructions on how to install Ansible collections can be found in the [Ansible collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html) guide.
77+
78+
> [!TIP]
79+
> You can alternatively install the [Ansible community distribution](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#selecting-an-ansible-package-and-version-to-install) (what is still known Ansible -- instead of Ansible core) if you don't want to manage individual collections.
6380

6481
#### Jinja2
6582

6683
- 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 `3.1`.
6784
- Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/3.1.x/intro/#installation).
6885

69-
Alternatively, you can install `ansible-core`, a supported version of Jinja2, and the aforementioned collections by running the following three commands on your Ansible host:
70-
71-
```bash
72-
pip install -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible.txt
73-
curl -O https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_collections.yml
74-
ansible-galaxy install -r requirements_collections.yml
75-
```
76-
7786
### Testing suite (Optional)
7887

7988
If you want to contribute to this role, you will also need to install Ansible Lint and Molecule.
@@ -88,11 +97,11 @@ If you want to contribute to this role, you will also need to install Ansible Li
8897
ansible-lint
8998
```
9099

91-
Alternatively, you can install Ansible Lint by running the following command on your Ansible host:
100+
- For ease of use, you can install and/or upgrade Ansible Lint by running the following command on your Ansible host:
92101

93-
```bash
94-
pip install -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible_lint.txt
95-
```
102+
```bash
103+
pip install -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_ansible_lint.txt
104+
```
96105

97106
#### Molecule (Optional)
98107

@@ -108,11 +117,11 @@ pip install -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/mai
108117
molecule test -s plus
109118
```
110119

111-
Alternatively, you can install Molecule and the aforementioned Molecule plugins and Docker Python SDK packages by running the following command on your Ansible host:
120+
- You can install and/or upgrade Molecule, the Molecule plugins package, and the Docker Python SDK by running the following command on your Ansible host:
112121

113-
```bash
114-
pip install -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_molecule.txt
115-
```
122+
```bash
123+
pip install --upgrade -r https://raw.githubusercontent.com/nginxinc/ansible-role-nginx/main/.github/workflows/requirements/requirements_molecule.txt
124+
```
116125

117126
## Role Installation
118127

@@ -288,7 +297,7 @@ Ubuntu:
288297
- jammy (22.04)
289298
```
290299

291-
> [!WARNing]
300+
> [!WARNING]
292301
> At your own risk, you can also use this role to compile NGINX Open Source from source, install NGINX Open Source on "compatible" yet unsupported platforms, install NGINX from your respective distribution package manager, or install NGINX Open Source on BSD systems.
293302

294303
## Role Variables

0 commit comments

Comments
 (0)