Skip to content

Commit

Permalink
Prepare 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
alessfg committed Mar 9, 2023
1 parent c4e89fd commit d0acf2d
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 48 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on

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

- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/ansible-role-nms/blob/main/CONTRIBUTING.md) document
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/CONTRIBUTING.md) document
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
- [ ] 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))
- [ ] 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))
2 changes: 1 addition & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ template: |
## Resources
- 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).
- 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).
- Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx).
- NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
- NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Changelog

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

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

* Install NGINX Management Suite (NMS).
* Create initial NMS password
* Create initial NMS password.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ The following is a set of guidelines for contributing to the ansible_role_nginx_
* [Git Guidelines](#git-guidelines)
* [Ansible Guidelines](#ansible-guidelines)

[Code of Conduct](https://github.com/nginxinc/ansible-role-nms/blob/main/CODE_OF_CONDUCT.md)
[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/CODE_OF_CONDUCT.md)

## Getting Started

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

### Project Structure

* The NGINX Management Suite Ansible role is written in `yaml` and supports NGINX Management Suite (NMS) Installation.
* An NGINX Plus license is required in order to install NMS.
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html):
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nms/blob/main/tasks/).
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nms/blob/main/defaults/main/).
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/vars/main.yml).
* [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/).
* 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/).
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/tasks/).
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/defaults/main/).
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/vars/main.yml).
* [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/).
* 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/).


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

* 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.
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nms/blob/main/.github/pull_request_template.md).
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/.github/pull_request_template.md).

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.

Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- [![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx) -->
[![Molecule CI/CD](https://github.com/nginxinc/ansible-role-nms/workflows/Molecule%20CI/CD/badge.svg)](https://github.com/nginxinc/ansible-role-nms/actions)
[![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)
[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

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

### Ansible

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

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

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:

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

1. Use `git clone https://github.com/nginxinc/ansible-role-nms.git` to pull the latest edge commit of the role from GitHub.
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.

## Platforms

Expand Down Expand Up @@ -126,29 +126,29 @@ Ubuntu:

## Role Variables

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

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

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

| Name | Description |
| ---- | ----------- |
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/vars/main.yml)** | List of supported NMS installation variables |
| **[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/vars/main.yml)** | List of supported NMS installation variables |

## Example Playbooks

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

| Name | Description |
| ---- | ----------- |
| **[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/default/converge.yml)** | Install NGINX OSS and NMS |
| **[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/plus/converge.yml)** | Install NGINX Plus and NMS |
| **[`upgrade/converge.yml`](https://github.com/nginxinc/ansible-role-nms/blob/main/molecule/upgrade/converge.yml)** | Upgrade NMS |
| **[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/default/converge.yml)** | Install NGINX OSS and NMS |
| **[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/plus/converge.yml)** | Install NGINX Plus and NMS |
| **[`upgrade/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/molecule/upgrade/converge.yml)** | Upgrade 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`.
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`.

## Other NGINX Ansible Collections and Roles

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

## License

[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nms/blob/main/LICENSE)
[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx-management-suite/blob/main/LICENSE)

## Author Information

Expand Down
24 changes: 8 additions & 16 deletions meta/main.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,26 @@
galaxy_info:
role_name: nms
author: nginxinc
description: Official Ansible role for installing NGINX Management Suite
description: Official Ansible role for the NGINX Management Suite
role_name: nginx_management_suite
company: F5, Inc.

license: Apache License, Version 2.0

min_ansible_version: "2.13"
min_ansible_version: '2.12'

platforms:
- name: Amazon Linux 2
versions:
- all
versions: [all]
- name: Debian
versions:
- buster
- bullseye
versions: [bullseye]
- name: EL
versions:
- "7"
- "8"
- "9"
versions: ['7', '8', '9']
- name: Ubuntu
versions:
- bionic
- focal
- jammy
versions: [bionic, focal, jammy]

galaxy_tags:
- nms
- nginx
- development
- install

Expand Down
2 changes: 1 addition & 1 deletion molecule/default/converge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
tasks:
- name: Install NMS
ansible.builtin.include_role:
name: ansible-role-nms
name: ansible-role-nginx-management-suite
vars:
nms_setup: install
nms_user_passwd: 'Password123'
Expand Down
2 changes: 1 addition & 1 deletion molecule/plus/converge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
tasks:
- name: Install NMS
ansible.builtin.include_role:
name: ansible-role-nms
name: ansible-role-nginx-management-suite
vars:
nms_setup: install
nms_user_passwd: 'Password123'
Expand Down
2 changes: 1 addition & 1 deletion molecule/upgrade/converge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
tasks:
- name: Upgrade NMS
ansible.builtin.include_role:
name: ansible-role-nms
name: ansible-role-nginx-management-suite
vars:
nms_setup: upgrade
nms_user_passwd: 'Password123'
Expand Down
2 changes: 1 addition & 1 deletion molecule/upgrade/prepare.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
tasks:
- name: Install NMS
ansible.builtin.include_role:
name: ansible-role-nms
name: ansible-role-nginx-management-suite
vars:
nms_version: 2.4.0*
nms_setup: install
Expand Down

0 comments on commit d0acf2d

Please sign in to comment.