Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 90c2ff3
Showing
54 changed files
with
3,531 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To reproduce** | ||
Steps to reproduce the behavior: | ||
1. Deploy NGINX Config role using playbook.yml | ||
2. View output/logs/configuration on '...' | ||
3. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Your environment:** | ||
- Version of the NGINX Config Role or specific commit | ||
- Version of Ansible | ||
- Target deployment platform | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
### Proposed changes | ||
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). | ||
|
||
### Checklist | ||
Before creating a PR, run through this checklist and mark each as complete. | ||
|
||
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/CONTRIBUTING.md) document | ||
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works | ||
- [ ] I have checked that all Molecule tests pass after adding my changes | ||
- [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Any private crt and keys # | ||
############################ | ||
*.crt | ||
*.key | ||
*~ | ||
\#* | ||
|
||
# OS Specific | ||
Thumbs.db | ||
.DS_Store | ||
.vscode | ||
|
||
# Ansible specific | ||
*.retry | ||
|
||
# Python specific | ||
__pycache__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
language: python | ||
services: docker | ||
jobs: | ||
include: | ||
- name: "(Debian/Ubuntu) Test config templates" | ||
env: | ||
scenario: default | ||
- name: "(Alpine) Test config templates" | ||
env: | ||
scenario: default_alpine | ||
- name: "(CentOS) Test config templates" | ||
env: | ||
scenario: default_centos | ||
- name: "(Debian/Ubuntu) Install Modules" | ||
env: | ||
scenario: module | ||
- name: "(Alpine) Install Modules" | ||
env: | ||
scenario: module_alpine | ||
- name: "(CentOS) Install Modules" | ||
env: | ||
scenario: module_centos | ||
- name: "(Debian/Ubuntu) Install Stable Branch and Push Configuration" | ||
env: | ||
scenario: stable_push | ||
- name: "(Alpine) Install Stable Branch and Push Configuration" | ||
env: | ||
scenario: stable_push_alpine | ||
- name: "(CentOS) Install Stable Branch and Push Configuration" | ||
env: | ||
scenario: stable_push_centos | ||
before_install: sudo apt-get -qq update | ||
install: | ||
- pip install ansible==2.9.11 | ||
- pip install molecule==3.0.6 | ||
- pip install docker==4.2.2 | ||
- pip install ansible-lint==4.2.0 | ||
script: | ||
- molecule --version | ||
- ansible --version | ||
- travis_wait 50 molecule test -s $scenario | ||
notifications: | ||
webhooks: https://galaxy.ansible.com/api/v1/notifications/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
extends: default | ||
|
||
rules: | ||
braces: | ||
max-spaces-inside: 1 | ||
level: error | ||
brackets: | ||
max-spaces-inside: 1 | ||
level: error | ||
comments-indentation: disable | ||
line-length: disable | ||
truthy: disable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Changelog | ||
|
||
## 0.1.0 (Unreleased) | ||
|
||
Initial release of the NGINX Config role. Contains all NGINX Config related features previously available on the [NGINX Ansible role](https://github.com/nginxinc/ansible-role-nginx). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at nginx@nginx.org. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Contributing Guidelines | ||
|
||
The following is a set of guidelines for contributing to the NGINX Ansible role. We really appreciate that you are considering contributing! | ||
|
||
#### Table Of Contents | ||
|
||
[Ask a Question](#ask-a-question) | ||
|
||
[Getting Started](#getting-started) | ||
|
||
[Contributing](#contributing) | ||
|
||
[Code Guidelines](#code-guidelines) | ||
* [Git Guidelines](#git-guidelines) | ||
* [Ansible Guidelines](#ansible-guidelines) | ||
|
||
[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/CODE_OF_CONDUCT.md) | ||
|
||
## Ask a Question | ||
|
||
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`. | ||
|
||
## Getting Started | ||
|
||
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role. | ||
|
||
### Project Structure | ||
|
||
* The NGINX Ansible role is written in `yaml` and supports NGINX Open Source and NGINX Plus. | ||
* 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/` | ||
* The main variables can be found in `defaults/main/*.yml` | ||
* Configuration templates for NGINX can be found in `templates/` | ||
* [Molecule](https://molecule.readthedocs.io/) tests can be found in `molecule/`. | ||
* CI/CD is done via Travis using `.travis.yml` deployment yaml files | ||
|
||
## Contributing | ||
|
||
### Report a Bug | ||
|
||
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the issue has not already been reported. | ||
|
||
### Suggest an Enhancement | ||
|
||
To suggest an enhancement, please create an issue on GitHub with the label `enhancement` using the available feature issue template. | ||
|
||
### Open a Pull Request | ||
|
||
* Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review | ||
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/.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. | ||
|
||
## Code Guidelines | ||
|
||
### Ansible Guidelines | ||
|
||
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues. | ||
* Run `molecule test --all` on your code before you submit a PR to catch any potential issues. | ||
* Follow these guides on some good practices for Ansible: | ||
* <https://www.ansible.com/blog/ansible-best-practices-essentials> | ||
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html> | ||
|
||
### Git Guidelines | ||
|
||
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR | ||
* 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 | ||
* In the subject line, use the present tense ("Add feature" not "Added feature") | ||
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
* Limit the subject line to 72 characters or less | ||
* Reference issues and pull requests liberally after the subject line | ||
* 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`) |
Oops, something went wrong.