Markdown updates
This commit is contained in:
parent
2681fbf67f
commit
ac6f23aa1f
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -6,22 +6,28 @@ labels: ''
|
|||||||
assignees: ''
|
assignees: ''
|
||||||
---
|
---
|
||||||
### Describe the bug
|
### Describe the bug
|
||||||
|
|
||||||
A clear and concise description of what the bug is.
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
### To reproduce
|
### To reproduce
|
||||||
|
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
1. Deploy NGINX role using playbook.yml
|
1. Deploy NGINX role using playbook.yml
|
||||||
2. View output/logs/configuration on '...'
|
2. View output/logs/configuration on '...'
|
||||||
3. See error
|
3. See error
|
||||||
|
|
||||||
### Expected behavior
|
### Expected behavior
|
||||||
|
|
||||||
A clear and concise description of what you expected to happen.
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
### Your environment:
|
### Your environment
|
||||||
|
|
||||||
- Version of the NGINX role or specific commit
|
- Version of the NGINX role or specific commit
|
||||||
- Version of Ansible
|
- Version of Ansible
|
||||||
- Version of Jinja2 (if you are using any templating capability)
|
- Version of Jinja2 (if you are using any templating capability)
|
||||||
- Target deployment platform
|
- Target deployment platform
|
||||||
|
|
||||||
### Additional context
|
### Additional context
|
||||||
|
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
4
.github/ISSUE_TEMPLATE/feature_request.md
vendored
4
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -6,13 +6,17 @@ labels: ''
|
|||||||
assignees: ''
|
assignees: ''
|
||||||
---
|
---
|
||||||
### Is your feature request related to a problem? Please describe
|
### 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 ...
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
|
||||||
|
|
||||||
### Describe the solution you'd like
|
### Describe the solution you'd like
|
||||||
|
|
||||||
A clear and concise description of what you want to happen.
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
### Describe alternatives you've considered
|
### Describe alternatives you've considered
|
||||||
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
### Additional context
|
### Additional context
|
||||||
|
|
||||||
Add any other context or screenshots about the feature request here.
|
Add any other context or screenshots about the feature request here.
|
||||||
|
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@ -1,7 +1,9 @@
|
|||||||
### Proposed changes
|
### 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).
|
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
|
### Checklist
|
||||||
|
|
||||||
Before creating a PR, run through this checklist and mark each as complete.
|
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/blob/main/CONTRIBUTING.md) document
|
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx/blob/main/CONTRIBUTING.md) document
|
||||||
|
@ -49,6 +49,7 @@ Change the url used to grep the latest NGINX version when installing from source
|
|||||||
FEATURES:
|
FEATURES:
|
||||||
|
|
||||||
* Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are:
|
* Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
@ -59,6 +60,7 @@ FEATURES:
|
|||||||
- name: community.docker # This collection is only used as part of the Molecule testing suite
|
- name: community.docker # This collection is only used as part of the Molecule testing suite
|
||||||
version: 1.5.0
|
version: 1.5.0
|
||||||
```
|
```
|
||||||
|
|
||||||
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
|
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
|
||||||
* Add support for Dependabot.
|
* Add support for Dependabot.
|
||||||
* Initial implementation of Release Drafter.
|
* Initial implementation of Release Drafter.
|
||||||
@ -127,11 +129,13 @@ BREAKING CHANGES:
|
|||||||
ENHANCEMENTS:
|
ENHANCEMENTS:
|
||||||
|
|
||||||
Implement a new syntax to specify modules to be installed. You can now use the following format if you want further fine grained control over how you install modules:
|
Implement a new syntax to specify modules to be installed. You can now use the following format if you want further fine grained control over how you install modules:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: njs # Required
|
- name: njs # Required
|
||||||
state: present # Optional
|
state: present # Optional
|
||||||
version: =1.19.4+0.4.4-1~bionic # Optional
|
version: =1.19.4+0.4.4-1~bionic # Optional
|
||||||
```
|
```
|
||||||
|
|
||||||
The old method of specifying modules (using a list of names) still works as expected.
|
The old method of specifying modules (using a list of names) still works as expected.
|
||||||
|
|
||||||
## 0.17.3 (November 9, 2020)
|
## 0.17.3 (November 9, 2020)
|
||||||
@ -224,6 +228,7 @@ Building OpenSSL from source should now work properly in CentOS 8.
|
|||||||
DEPRECATION WARNING:
|
DEPRECATION WARNING:
|
||||||
|
|
||||||
With the advent of Ansible collections and to reduce the overhead of this role, the decision has been made to split this role into three smaller roles:
|
With the advent of Ansible collections and to reduce the overhead of this role, the decision has been made to split this role into three smaller roles:
|
||||||
|
|
||||||
* The NGINX Ansible role will keep working as is and be used to install and setup NGINX.
|
* The NGINX Ansible role will keep working as is and be used to install and setup NGINX.
|
||||||
* There now is a separate role to manage and create NGINX configurations available [here](https://github.com/nginxinc/ansible-role-nginx-config). Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on. The NGINX configuration functionalities included in this role will be removed in an upcoming release.
|
* There now is a separate role to manage and create NGINX configurations available [here](https://github.com/nginxinc/ansible-role-nginx-config). Any new issues or PRs related to configuring NGINX should be submitted in the new NGINX Config repository. New issues or PRs related to configuring NGINX submitted in this repository will not be worked on. The NGINX configuration functionalities included in this role will be removed in an upcoming release.
|
||||||
* NGINX Unit now has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. The NGINX Unit functionalities included in this role will be removed in an upcoming release.
|
* NGINX Unit now has a separate role available [here](https://github.com/nginxinc/ansible-role-nginx-unit). Any new issues or PRs related to NGINX Unit should be submitted in the new NGINX Unit repository. New issues or PRs related to NGINX Unit submitted in this repository will not be worked on. The NGINX Unit functionalities included in this role will be removed in an upcoming release.
|
||||||
@ -236,6 +241,7 @@ BREAKING CHANGES:
|
|||||||
* The listen directive structure in the `stream` template has been updated to the listen directive structure found in the `http` template. You can now specify multiple `listen` directives in the same `server` block as well as include any extra `listen` options you might need.
|
* The listen directive structure in the `stream` template has been updated to the listen directive structure found in the `http` template. You can now specify multiple `listen` directives in the same `server` block as well as include any extra `listen` options you might need.
|
||||||
|
|
||||||
Old configuration example
|
Old configuration example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
listen_address: localhost
|
listen_address: localhost
|
||||||
listen_port: 80
|
listen_port: 80
|
||||||
@ -243,6 +249,7 @@ BREAKING CHANGES:
|
|||||||
```
|
```
|
||||||
|
|
||||||
New configuration example
|
New configuration example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
listen:
|
listen:
|
||||||
listen_localhost:
|
listen_localhost:
|
||||||
@ -336,6 +343,7 @@ BUG FIXES:
|
|||||||
FEATURES:
|
FEATURES:
|
||||||
|
|
||||||
Improve NGINX http templating - following parameters are now supported:
|
Improve NGINX http templating - following parameters are now supported:
|
||||||
|
|
||||||
* Websockets.
|
* Websockets.
|
||||||
* Basic authentication.
|
* Basic authentication.
|
||||||
* Proxy cache.
|
* Proxy cache.
|
||||||
|
@ -67,10 +67,8 @@ members of the project's leadership.
|
|||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
|
||||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
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
|
For answers to common questions about this code of conduct, see
|
||||||
https://www.contributor-covenant.org/faq
|
<https://www.contributor-covenant.org/faq>
|
||||||
|
@ -11,6 +11,7 @@ The following is a set of guidelines for contributing to the NGINX Ansible role.
|
|||||||
[Contributing](#contributing)
|
[Contributing](#contributing)
|
||||||
|
|
||||||
[Code Guidelines](#code-guidelines)
|
[Code Guidelines](#code-guidelines)
|
||||||
|
|
||||||
* [Git Guidelines](#git-guidelines)
|
* [Git Guidelines](#git-guidelines)
|
||||||
* [Ansible Guidelines](#ansible-guidelines)
|
* [Ansible Guidelines](#ansible-guidelines)
|
||||||
|
|
||||||
|
@ -16,6 +16,7 @@ This role installs NGINX Open Source, NGINX Plus, or the NGINX Amplify agent on
|
|||||||
|
|
||||||
* 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.11`) and Ansible (above `2.9.10`).
|
* 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.11`) and Ansible (above `2.9.10`).
|
||||||
* When using Ansible base, you will also need to install the following collections:
|
* When using Ansible base, you will also need to install the following collections:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
@ -24,6 +25,7 @@ This role installs NGINX Open Source, NGINX Plus, or the NGINX Amplify agent on
|
|||||||
- name: ansible.posix
|
- name: ansible.posix
|
||||||
version: 1.2.0
|
version: 1.2.0
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note:** You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
|
**Note:** You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
|
||||||
* Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later).
|
* Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later).
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user