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: .github/pull_request_template.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
6
6
7
7
Before creating a PR, run through this checklist and mark each as complete.
8
8
9
-
-[ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/ansible-role-nms/blob/main/CONTRIBUTING.md) document
9
+
-[ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/CONTRIBUTING.md) document
10
10
-[ ] If applicable, I have added tests that prove my fix is effective or that my feature works
11
11
-[ ] If applicable, I have checked that any relevant tests pass after adding my changes
12
-
-[ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/ansible-role-nms/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/ansible-role-nms/blob/main/CHANGELOG.md))
12
+
-[ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/CHANGELOG.md))
- NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
103
103
- NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -13,22 +13,22 @@ The following is a set of guidelines for contributing to the ansible_role_nginx_
13
13
*[Git Guidelines](#git-guidelines)
14
14
*[Ansible Guidelines](#ansible-guidelines)
15
15
16
-
[Code of Conduct](https://github.com/nginxinc/ansible-role-nms/blob/main/CODE_OF_CONDUCT.md)
16
+
[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/CODE_OF_CONDUCT.md)
17
17
18
18
## Getting Started
19
19
20
-
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nms/blob/main/README.md#Installation) to get the ansible_role_nginx_management_suite up and running.
20
+
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/README.md#Installation) to get the ansible_role_nginx_management_suite up and running.
21
21
22
22
### Project Structure
23
23
24
24
* The NGINX Management Suite Ansible role is written in `yaml` and supports NGINX Management Suite (NMS) Installation.
25
25
* An NGINX Plus license is required in order to install NMS.
26
26
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html):
27
-
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nms/blob/main/tasks/).
28
-
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nms/blob/main/defaults/main/).
29
-
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/vars/main.yml).
30
-
*[Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/).
31
-
* CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible-role-nms/blob/main/.github/workflows/).
27
+
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/tasks/).
28
+
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/defaults/main/).
29
+
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/vars/main.yml).
30
+
*[Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/).
31
+
* CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/.github/workflows/).
32
32
33
33
34
34
<!-- ### Project Structure (OPTIONAL) -->
@@ -46,7 +46,7 @@ To suggest a feature or enhancement, please create an issue on GitHub with the l
46
46
### Open a Pull Request
47
47
48
48
* Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
49
-
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nms/blob/main/.github/pull_request_template.md).
49
+
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/.github/pull_request_template.md).
50
50
51
51
Note: if you'd like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
@@ -29,7 +29,7 @@ Main difference between using NGINX OSS or NGINX Plus depends on which [Authenti
29
29
30
30
### Ansible
31
31
32
-
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core (above `2.14`).
32
+
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible core (above `2.12`).
33
33
* This role was developed and tested using **nginxinc.nginx** version **0.24.0**.
34
34
* When using this role, you will also need to install the following collections below. Additional information installing these collections is below in [Installation](#installation) section
35
35
* ansible.posix
@@ -50,7 +50,7 @@ Main difference between using NGINX OSS or NGINX Plus depends on which [Authenti
50
50
51
51
* Molecule is used to test the various functionalities of the role. The recommended version of Molecule to test this role is `4.0.1`.
52
52
* Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html). *You will also need to install the Molecule Docker driver.*
53
-
* To run the Molecule tests, you must copy your NGINX Plus license to the role's [`files/license`](https://github.com/nginxinc/ansible-role-nms/blob/main/files/license/) folder.
53
+
* To run the Molecule tests, you must copy your NGINX Plus license to the role's [`files/license`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/files/license/) folder.
54
54
55
55
You can alternatively add your NGINX Management Suite 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:
56
56
@@ -89,11 +89,11 @@ There is a couple methods if you want to use the latest edge from this role.
89
89
1. Use the following snippet in your `requirement.yml`.
1. Use `git clone https://github.com/nginxinc/ansible-role-nms.git` to pull the latest edge commit of the role from GitHub.
96
+
1. Use `git clone https://github.com/nginxinc/ansible-role-nginx-management-suite.git` to pull the latest edge commit of the role from GitHub.
97
97
98
98
## Platforms
99
99
@@ -126,29 +126,29 @@ Ubuntu:
126
126
127
127
## Role Variables
128
128
129
-
This role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/main/`](https://github.com/nginxinc/ansible-role-nms/blob/main/defaults/main/)** folder in the following files:
129
+
This role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/defaults/main/)** folder in the following files:
Similarly, descriptions and defaults for preset variables can be found in the **[`vars/`](https://github.com/nginxinc/ansible-role-nms/blob/main/vars/)** folder in the following files:
135
+
Similarly, descriptions and defaults for preset variables can be found in the **[`vars/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/vars/)** folder in the following files:
136
136
137
137
| Name | Description |
138
138
| ---- | ----------- |
139
-
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/vars/main.yml)** | List of supported NMS installation variables |
139
+
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/vars/main.yml)** | List of supported NMS installation variables |
140
140
141
141
## Example Playbooks
142
142
143
-
Working functional playbook examples can be found in the **[`molecule/`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/)** folder in the following files:
143
+
Working functional playbook examples can be found in the **[`molecule/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/)** folder in the following files:
144
144
145
145
| Name | Description |
146
146
| ---- | ----------- |
147
-
| **[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/default/converge.yml)** | Install NGINX OSS and NMS |
148
-
| **[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/plus/converge.yml)** | Install NGINX Plus and NMS |
| **[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/default/converge.yml)** | Install NGINX OSS and NMS |
148
+
| **[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/plus/converge.yml)** | Install NGINX Plus and NMS |
Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from `ansible-role-nms` to `nginxinc.nms`.
151
+
Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from `ansible-role-nginx-management-suite` to `nginxinc.nms`.
152
152
153
153
## Other NGINX Ansible Collections and Roles
154
154
@@ -160,7 +160,7 @@ You can find the Ansible NGINX Unit role to install NGINX Unit [here](https://gi
160
160
161
161
## License
162
162
163
-
[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nms/blob/main/LICENSE)
163
+
[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/LICENSE)
0 commit comments