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
+54-45Lines changed: 54 additions & 45 deletions
Original file line number
Diff line number
Diff line change
@@ -18,62 +18,71 @@ 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
-
#### NGINX Open Source (NGINX OSS)
23
+
-**NGINX Open Source (NGINX OSS):**
24
24
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.
26
26
27
-
#### NGINX Plus
27
+
-**NGINX Plus:**
28
28
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.
30
30
31
-
#### NGINX Agent
31
+
-**NGINX Agent:**
32
32
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.
34
34
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.
36
36
37
-
#### NGINX Amplify
37
+
-**NGINX Amplify:**
38
38
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.
40
40
41
41
### Ansible
42
42
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:
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
+
43
58
- 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
+
61
74
- 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.
63
80
64
81
#### Jinja2
65
82
66
83
- 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
84
- Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/3.1.x/intro/#installation).
68
85
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:
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:
> 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.
0 commit comments