Skip to content
This repository was archived by the owner on May 24, 2023. It is now read-only.

Commit 9668afe

Browse files
committed
Install NGINX Controller dependencies (#28)
1 parent 81477b2 commit 9668afe

File tree

19 files changed

+643
-612
lines changed

19 files changed

+643
-612
lines changed

.ansible-lint

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,27 @@ labels: ''
66
assignees: ''
77
---
88
### Describe the bug
9+
910
A clear and concise description of what the bug is.
1011

1112
### To reproduce
13+
1214
Steps to reproduce the behavior:
15+
1316
1. Deploy NGINX Controller Install role using playbook.yml
1417
2. View output/logs/configuration on '...'
1518
3. See error
1619

1720
### Expected behavior
21+
1822
A clear and concise description of what you expected to happen.
1923

20-
### Your environment:
21-
- Version of the NGINX Controller Install role or specific commit
22-
- Version of Ansible
23-
- Version of Jinja2 (if you are using any templating capability)
24-
- Target deployment platform
24+
### Your environment
25+
26+
- Version of the NGINX Controller Install role or specific commit
27+
- Version of Ansible
28+
- Target deployment platform
2529

2630
### Additional context
31+
2732
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@ labels: ''
66
assignees: ''
77
---
88
### Is your feature request related to a problem? Please describe
9+
910
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
1011

1112
### Describe the solution you'd like
13+
1214
A clear and concise description of what you want to happen.
1315

1416
### Describe alternatives you've considered
17+
1518
A clear and concise description of any alternative solutions or features you've considered.
1619

1720
### Additional context
21+
1822
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
### Proposed changes
2+
23
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) here in this description (not in the title of the PR).
34

45
### Checklist
6+
57
Before creating a PR, run through this checklist and mark each as complete.
68

7-
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/CONTRIBUTING.md) document
8-
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
9-
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
10-
- [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)
9+
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/CONTRIBUTING.md) document
10+
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
11+
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
12+
- [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)

.github/release-drafter.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,12 @@ template: |
8888
8989
## Install & Upgrade
9090
91-
* To install the Ansible NGINX Controller Install role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_controller_install`.
92-
* To upgrade the Ansible NGINX Controller Install role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_controller_install`.
93-
* To install or upgrade to this specific Ansible NGINX Controller Install role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_controller_install,v$RESOLVED_VERSION`.
91+
* To install the Ansible NGINX Controller Install role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_controller_install`.
92+
* To upgrade the Ansible NGINX Controller Install role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_controller_install`.
93+
* To install or upgrade to this specific Ansible NGINX Controller Install role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_controller_install,v$RESOLVED_VERSION`.
9494
9595
## Resources
9696
97-
* Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-controller-install/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-controller-install/tree/$RESOLVED_VERSION/molecule).
98-
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx_controller_install](https://galaxy.ansible.com/nginxinc/nginx_controller_install).
99-
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).
97+
* Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible_role_nginx_controller_install/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible_role_nginx_controller_install/tree/$RESOLVED_VERSION/molecule).
98+
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx_controller_install](https://galaxy.ansible.com/nginxinc/nginx_controller_install).
99+
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

.github/workflows/molecule.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ jobs:
3838
- name: Run Molecule tests
3939
run: molecule test -s ${{ matrix.scenario }}
4040
env:
41-
PY_COLORS: "1"
42-
ANSIBLE_FORCE_COLOR: "1"
41+
PY_COLORS: 1
42+
ANSIBLE_FORCE_COLOR: 1

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
## 0.1.0 (Unreleased)
44

5+
FEATURES:
6+
7+
Install NGINX Controller dependencies.
8+
59
ENHANCEMENTS:
610

7-
* Implement GitHub Actions CI/CD workflow for repo.
8-
* Add Molecule tests for role.
11+
* Implement GitHub Actions CI/CD workflow for repo.
12+
* Add Molecule tests for role.

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ members of the project's leadership.
6868
## Attribution
6969

7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7272

7373
[homepage]: https://www.contributor-covenant.org
7474

7575
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
76+
<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,30 @@ The following is a set of guidelines for contributing to the NGINX Controller In
1111
[Contributing](#contributing)
1212

1313
[Code Guidelines](#code-guidelines)
14-
* [Git Guidelines](#git-guidelines)
15-
* [Ansible Guidelines](#ansible-guidelines)
1614

17-
[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/CODE_OF_CONDUCT.md)
15+
* [Git Guidelines](#git-guidelines)
16+
* [Ansible Guidelines](#ansible-guidelines)
17+
18+
[Code of Conduct](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/CODE_OF_CONDUCT.md)
1819

1920
## Ask a Question
2021

2122
Don't know how something works? Curious if the role can achieve your desired functionality? Please open an Issue on GitHub with the label `question`.
2223

2324
## Getting Started
2425

25-
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Controller Install Ansible role.
26+
Follow our [Installation Guide](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Controller Install Ansible role.
2627

2728
### Project Structure
2829

29-
* The NGINX Controller Install Ansible role is written in `yaml` and supports NGINX Controller.
30-
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
31-
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/tasks/).
32-
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/defaults/main/).
33-
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/vars/main.yml).
34-
* Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/templates/).
35-
* [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/molecule/).
36-
* CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/.github/workflows/).
30+
* The NGINX Controller Install Ansible role is written in `yaml` and supports NGINX Controller.
31+
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
32+
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/tasks/).
33+
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/defaults/main/).
34+
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/vars/main.yml).
35+
* Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/templates/).
36+
* [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/molecule/).
37+
* CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/.github/workflows/).
3738

3839
## Contributing
3940

@@ -47,27 +48,27 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
4748

4849
### Open a Pull Request
4950

50-
* Fork the repo, create a branch, implement your changes, add any relevant Molecule tests, submit a PR when your changes are **tested** (using Molecule) and ready for review.
51-
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/.github/pull_request_template.md).
51+
* Fork the repo, create a branch, implement your changes, add any relevant Molecule tests, submit a PR when your changes are **tested** (using Molecule) and ready for review.
52+
* Fill in [our pull request template](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/.github/pull_request_template.md).
5253

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

5556
## Code Guidelines
5657

5758
### Ansible Guidelines
5859

59-
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues.
60-
* Run `molecule test` on your code before you submit a PR to catch any potential issues. If you are testing a specific molecule scenario, run `molecule test -s <scenario>`.
61-
* Follow these guides on some good practices for Ansible:
62-
* <https://www.ansible.com/blog/ansible-best-practices-essentials>
63-
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>
60+
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues.
61+
* Run `molecule test` on your code before you submit a PR to catch any potential issues. If you are testing a specific molecule scenario, run `molecule test -s <scenario>`.
62+
* Follow these guides on some good practices for Ansible:
63+
* <https://www.ansible.com/blog/ansible-best-practices-essentials>
64+
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>
6465

6566
### Git Guidelines
6667

67-
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
68-
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points
69-
* In the subject line, use the present tense ("Add feature" not "Added feature")
70-
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
71-
* Limit the subject line to 72 characters or less
72-
* Reference issues and pull requests liberally after the subject line
73-
* Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`)
68+
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
69+
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points
70+
* In the subject line, use the present tense ("Add feature" not "Added feature")
71+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
72+
* Limit the subject line to 72 characters or less
73+
* Reference issues and pull requests liberally after the subject line
74+
* Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`)

0 commit comments

Comments
 (0)