Skip to content

Commit d0acf2d

Browse files
committed
Prepare 0.1.0 release
1 parent c4e89fd commit d0acf2d

File tree

10 files changed

+40
-48
lines changed

10 files changed

+40
-48
lines changed

Diff for: .github/pull_request_template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
66

77
Before creating a PR, run through this checklist and mark each as complete.
88

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
1010
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
1111
- [ ] 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))

Diff for: .github/release-drafter.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ template: |
9797
9898
## Resources
9999
100-
- Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nms/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nms/tree/$RESOLVED_VERSION/molecule).
100+
- Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-management-suite/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-management-suite/tree/$RESOLVED_VERSION/molecule).
101101
- Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx).
102102
- NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
103103
- NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

Diff for: CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Changelog
22

3-
## 0.1.0 - Initial release (Month Date, Year)
3+
## 0.1.0 - Initial release (March 9th, 2023)
44

55
Initial release of the NGINX Management Suite Ansible role. Features include:
66

77
* Install NGINX Management Suite (NMS).
8-
* Create initial NMS password
8+
* Create initial NMS password.

Diff for: CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ The following is a set of guidelines for contributing to the ansible_role_nginx_
1313
* [Git Guidelines](#git-guidelines)
1414
* [Ansible Guidelines](#ansible-guidelines)
1515

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)
1717

1818
## Getting Started
1919

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.
2121

2222
### Project Structure
2323

2424
* The NGINX Management Suite Ansible role is written in `yaml` and supports NGINX Management Suite (NMS) Installation.
2525
* An NGINX Plus license is required in order to install NMS.
2626
* 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/).
3232

3333

3434
<!-- ### Project Structure (OPTIONAL) -->
@@ -46,7 +46,7 @@ To suggest a feature or enhancement, please create an issue on GitHub with the l
4646
### Open a Pull Request
4747

4848
* 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).
5050

5151
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.
5252

Diff for: README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- [![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx) -->
2-
[![Molecule CI/CD](https://github.com/nginxinc/ansible-role-nms/workflows/Molecule%20CI/CD/badge.svg)](https://github.com/nginxinc/ansible-role-nms/actions)
2+
[![Molecule CI/CD](https://github.com/nginxinc/ansible-role-nginx-management-suite/workflows/Molecule%20CI/CD/badge.svg)](https://github.com/nginxinc/ansible-role-nginx-management-suite/actions)
33
[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44

55
# Ansible NGINX Management Suite Role
@@ -29,7 +29,7 @@ Main difference between using NGINX OSS or NGINX Plus depends on which [Authenti
2929

3030
### Ansible
3131

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`).
3333
* This role was developed and tested using **nginxinc.nginx** version **0.24.0**.
3434
* 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
3535
* ansible.posix
@@ -50,7 +50,7 @@ Main difference between using NGINX OSS or NGINX Plus depends on which [Authenti
5050

5151
* Molecule is used to test the various functionalities of the role. The recommended version of Molecule to test this role is `4.0.1`.
5252
* 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.
5454

5555
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:
5656

@@ -89,11 +89,11 @@ There is a couple methods if you want to use the latest edge from this role.
8989
1. Use the following snippet in your `requirement.yml`.
9090
```yaml
9191
roles:
92-
- src: https://github.com/nginxinc/ansible-role-nms.git
92+
- src: https://github.com/nginxinc/ansible-role-nginx-management-suite.git
9393
version: main
9494
```
9595

96-
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.
9797

9898
## Platforms
9999

@@ -126,29 +126,29 @@ Ubuntu:
126126

127127
## Role Variables
128128

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:
130130

131131
| Name | Description |
132132
| ---- | ----------- |
133-
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/defaults/main/main.yml)** | NMS installation variables |
133+
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/defaults/main/main.yml)** | NMS installation variables |
134134

135-
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:
136136

137137
| Name | Description |
138138
| ---- | ----------- |
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 |
140140

141141
## Example Playbooks
142142

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:
144144

145145
| Name | Description |
146146
| ---- | ----------- |
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 |
149-
| **[`upgrade/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/upgrade/converge.yml)** | Upgrade NMS |
147+
| **[`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 |
149+
| **[`upgrade/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/upgrade/converge.yml)** | Upgrade NMS |
150150

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-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`.
152152

153153
## Other NGINX Ansible Collections and Roles
154154

@@ -160,7 +160,7 @@ You can find the Ansible NGINX Unit role to install NGINX Unit [here](https://gi
160160

161161
## License
162162

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)
164164

165165
## Author Information
166166

Diff for: meta/main.yml

+8-16
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,26 @@
11
galaxy_info:
2-
role_name: nms
32
author: nginxinc
4-
description: Official Ansible role for installing NGINX Management Suite
3+
description: Official Ansible role for the NGINX Management Suite
4+
role_name: nginx_management_suite
55
company: F5, Inc.
66

77
license: Apache License, Version 2.0
88

9-
min_ansible_version: "2.13"
9+
min_ansible_version: '2.12'
1010

1111
platforms:
1212
- name: Amazon Linux 2
13-
versions:
14-
- all
13+
versions: [all]
1514
- name: Debian
16-
versions:
17-
- buster
18-
- bullseye
15+
versions: [bullseye]
1916
- name: EL
20-
versions:
21-
- "7"
22-
- "8"
23-
- "9"
17+
versions: ['7', '8', '9']
2418
- name: Ubuntu
25-
versions:
26-
- bionic
27-
- focal
28-
- jammy
19+
versions: [bionic, focal, jammy]
2920

3021
galaxy_tags:
3122
- nms
23+
- nginx
3224
- development
3325
- install
3426

Diff for: molecule/default/converge.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
tasks:
55
- name: Install NMS
66
ansible.builtin.include_role:
7-
name: ansible-role-nms
7+
name: ansible-role-nginx-management-suite
88
vars:
99
nms_setup: install
1010
nms_user_passwd: 'Password123'

Diff for: molecule/plus/converge.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
tasks:
55
- name: Install NMS
66
ansible.builtin.include_role:
7-
name: ansible-role-nms
7+
name: ansible-role-nginx-management-suite
88
vars:
99
nms_setup: install
1010
nms_user_passwd: 'Password123'

Diff for: molecule/upgrade/converge.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
tasks:
55
- name: Upgrade NMS
66
ansible.builtin.include_role:
7-
name: ansible-role-nms
7+
name: ansible-role-nginx-management-suite
88
vars:
99
nms_setup: upgrade
1010
nms_user_passwd: 'Password123'

Diff for: molecule/upgrade/prepare.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
tasks:
2323
- name: Install NMS
2424
ansible.builtin.include_role:
25-
name: ansible-role-nms
25+
name: ansible-role-nginx-management-suite
2626
vars:
2727
nms_version: 2.4.0*
2828
nms_setup: install

0 commit comments

Comments
 (0)