You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-27Lines changed: 35 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ This role installs NGINX Open Source, NGINX Plus, NGINX Agent or the NGINX Ampli
18
18
19
19
### NGINX
20
20
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:
22
22
23
23
#### NGINX Open Source (NGINX OSS)
24
24
@@ -40,40 +40,48 @@ If you wish to install the NGINX Amplify agent, you will need the API key provid
40
40
41
41
### Ansible
42
42
43
+
#### Ansible core
44
+
43
45
- 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
46
- When using Ansible core, you will also need to install the following collections:
45
47
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.
48
+
```yaml
49
+
---
50
+
collections:
51
+
- name: ansible.posix
52
+
version: 1.5.4
53
+
- name: community.general
54
+
version: 9.0.1
55
+
- name: community.crypto # Only required if you plan to install NGINX Plus
56
+
version: 2.20.0
57
+
- name: community.docker # Only required if you plan to use Molecule (see below)
58
+
version: 3.10.3
59
+
```
60
+
61
61
- 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
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).
63
63
64
+
> [!TIP]
65
+
> 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. Do note that there might be potential issues when using Ansible instead of Ansible core, as the former is not tested as part of this role's CI/CD pipeline.
66
+
64
67
#### Jinja2
65
68
66
69
- 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`.
67
70
- Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/3.1.x/intro/#installation).
68
71
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:
72
+
#### Installation
73
+
74
+
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:
Alternatively, you can install Molecule and the aforementioned Molecule plugins and Docker Python SDK packages by running the following command on your Ansible host:
119
+
- 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:
0 commit comments