diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0ca7101..672aacc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,11 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' -assignees: '' +title: "" +labels: "" +assignees: "" --- + ### Describe the bug A clear and concise description of what the bug is. @@ -13,8 +14,8 @@ A clear and concise description of what the bug is. Steps to reproduce the behavior: -1. Deploy NGINX collection using playbook.yml -2. View output/logs/configuration on '...' +1. Deploy the Ansible NGINX Core collection using `playbook.yml` +2. View output/logs/configuration on ... 3. See error ### Expected behavior @@ -23,7 +24,7 @@ A clear and concise description of what you expected to happen. ### Your environment -- Version of the NGINX collection or specific commit +- Version of the Ansible NGINX Core collection or specific commit - Version of Ansible - Version of Jinja2 (if you are using any templating capability) - Target deployment platform diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d27aba8..e2242ab 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,11 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' +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 ... diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..b5cebf9 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,26 @@ +# Security Policy + +## Versions + +### Latest Versions + +We advise users to run or update to the most recent release of the Ansible NGINX Core collection. Older versions of this collection may not have all enhancements and/or bug fixes applied to them. + +### Supported Versions + +This codebase mainly consists of an Ansible collection. Ansible applies security fixes to the most recent three releases. Please find more information in [the Ansible docs](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#release-status). + +## Reporting a Vulnerability + +### Ansible + +If you find a security vulnerability that affects Ansible directly, we encourage you to report it according to the [Ansible guidelines](https://docs.ansible.com/ansible/devel/community/reporting_bugs_and_features.html#reporting-a-bug). + +### Codebase + +If you find a security vulnerability that affects the codebase, we encourage you to report it to the F5 Security Incident Response Team (F5 SIRT): + +- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support). +- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities to the F5 SIRT at . + +For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability) diff --git a/.yamllint b/.yamllint deleted file mode 100644 index ff6d5ce..0000000 --- a/.yamllint +++ /dev/null @@ -1,12 +0,0 @@ ---- -extends: default - -rules: - braces: - max-spaces-inside: 1 - level: error - brackets: - max-spaces-inside: 1 - level: error - comments-indentation: disable - line-length: disable diff --git a/CHANGELOG.md b/CHANGELOG.md index 2af35cb..5c873f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,36 +1,44 @@ # CHANGELOG +## 0.8.0 (January 29, 2023) + +Update `nginx` role to `0.24.0`, `nginx_config` role to `0.6.0`, and `nginx_app_protect` role to `0.9.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release: + +- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.24.0/CHANGELOG.md) +- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.6.0/CHANGELOG.md) +- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.9.0/CHANGELOG.md) + ## 0.7.0 (October 17, 2022) Update `nginx` role to `0.23.2`, `nginx_config` role to `0.5.2`, and `nginx_app_protect` role to `0.8.1`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release: -* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.2/CHANGELOG.md) -* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.2/CHANGELOG.md) -* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.1/CHANGELOG.md) +- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.2/CHANGELOG.md) +- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.2/CHANGELOG.md) +- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.1/CHANGELOG.md) ## 0.6.0 (April 7, 2022) Update `nginx` role to `0.23.1`, `nginx_config` role to `0.5.1`, and `nginx_app_protect` role to `0.8.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release: -* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.1/CHANGELOG.md) -* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.1/CHANGELOG.md) -* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.0/CHANGELOG.md) +- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.1/CHANGELOG.md) +- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.1/CHANGELOG.md) +- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.0/CHANGELOG.md) ## 0.5.0 (February 17, 2022) Update `nginx` role to `0.23.0`, `nginx_config` role to `0.5.0`, and `nginx_app_protect` role to `0.7.1`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release: -* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.0/CHANGELOG.md) -* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.0/CHANGELOG.md) -* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.1/CHANGELOG.md) +- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.0/CHANGELOG.md) +- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.0/CHANGELOG.md) +- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.1/CHANGELOG.md) ## 0.4.0 (October 28, 2021) Update `nginx` role to `0.21.3`, `nginx_config` role to `0.4.2`, and `nginx_app_protect` role to `0.7.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release: -* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.21.3/CHANGELOG.md) -* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.4.2/CHANGELOG.md) -* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.0/CHANGELOG.md) +- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.21.3/CHANGELOG.md) +- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.4.2/CHANGELOG.md) +- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.0/CHANGELOG.md) ## 0.3.0 (January 11, 2021) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1cbfc7a..a1e1dff 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -14,22 +14,19 @@ appearance, race, religion, or sexual identity and orientation. 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 +- 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 +- 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99b0933..f5f7698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,8 @@ The following is a set of guidelines for contributing to the NGINX Ansible colle [Code Guidelines](#code-guidelines) -* [Git Guidelines](#git-guidelines) -* [Ansible Guidelines](#ansible-guidelines) +- [Git Guidelines](#git-guidelines) +- [Ansible Guidelines](#ansible-guidelines) [Code of Conduct](ttps://github.com/nginxinc/ansible-collection-nginx/blob/main/CODE_OF_CONDUCT.md) @@ -27,10 +27,10 @@ Follow our [Installation Guide](https://github.com/nginxinc/ansible-collection-n ### Project Structure -* The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect. -* The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html): - * The main code is found in [`roles/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/roles/) directory (do note that all roles are Git submodules). - * Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory. +- The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect. +- The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html): + - The main code is found in [`roles/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/roles/) directory (do note that all roles are Git submodules). + - Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory. ## Contributing @@ -44,8 +44,8 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha ### Open a Pull Request -* Fork the repo, create a branch, implement your changes, submit a PR when your changes are **tested** and ready for review. -* Fill in [our pull request template](https://github.com/nginxinc/ansible-collection-nginx/blob/main/.github/PULL_REQUEST_TEMPLATE.md). +- Fork the repo, create a branch, implement your changes, submit a PR when your changes are **tested** and ready for review. +- Fill in [our pull request template](https://github.com/nginxinc/ansible-collection-nginx/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. @@ -53,18 +53,18 @@ Note: if you'd like to implement a new feature, please consider creating a featu ### Ansible Guidelines -* Run `molecule lint` in each role directory to automatically resolve a lot of `yaml` and Ansible style issues. -* Run `molecule test --all` in each role directory to catch any other issues. -* Follow these guides on some good practices for Ansible: - * - * +- Run `molecule lint` in each role directory to automatically resolve a lot of `yaml` and Ansible style issues. +- Run `molecule test --all` in each role directory to catch any other issues. +- Follow these guides on some good practices for Ansible: + - + - ### 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 and summarized 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`). +- 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 and summarized 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`). diff --git a/README.md b/README.md index e5d6d10..48b6c1d 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ The Ansible NGINX collection includes a variety of NGINX Ansible roles to help a ## Included Content -The current stable release (`0.7.0`) of the Ansible NGINX collection includes the following roles: +The current stable release (`0.8.0`) of the Ansible NGINX collection includes the following roles: | Name | Description | Version | | ---- | ----------- | ------- | -| [nginxinc.nginx](https://github.com/nginxinc/ansible-role-nginx) | Install NGINX | 0.23.2 | -| [nginxinc.nginx_config](https://github.com/nginxinc/ansible-role-nginx-config) | Configure NGINX | 0.5.2 | -| [nginxinc.nginx_app_protect](https://github.com/nginxinc/ansible-role-nginx-app-protect) | Install and configure NGINX App Protect | 0.8.1 | +| [nginxinc.nginx](https://github.com/nginxinc/ansible-role-nginx) | Install NGINX | 0.24.0 | +| [nginxinc.nginx_config](https://github.com/nginxinc/ansible-role-nginx-config) | Configure NGINX | 0.6.0 | +| [nginxinc.nginx_app_protect](https://github.com/nginxinc/ansible-role-nginx-app-protect) | Install and configure NGINX App Protect | 0.9.0 | ## Requirements @@ -31,64 +31,84 @@ If you wish to install NGINX App Protect WAF or NGINX App Protect DoS using this ### Ansible -* This collection 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`). -* When using Ansible core, you will also need to install the following collections: +- This collection 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`). +- When using Ansible core, you will also need to install the following collections: - ```yaml + ```yaml --- collections: - name: ansible.posix version: 1.4.0 - name: community.crypto - version: 2.5.0 + version: 2.10.0 - name: community.general - version: 5.5.0 - - name: community.docker # Only required if you plan to use Molecule (see below) - version: 3.1.0 + version: 6.2.0 + - name: community.docker # Only required if you plan to use Molecule (see below) + version: 3.4.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. -* You will need to run this collection as a root user using Ansible's `become` parameter. Make sure you have set up the appropriate permissions on your target hosts. -* 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). +- You will need to run this collection as a root user using Ansible's `become` parameter. Make sure you have set up the appropriate permissions on your target hosts. +- 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). ### Jinja2 -* This collection uses Jinja2 templates. Ansible core installs Jinja2 by default, but depending on your install and/or upgrade path, you might be running an outdated version of Jinja2. The minimum version of Jinja2 required for the collection to properly function is `2.11`. -* Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/2.11.x/intro/#installation). +- This collection uses Jinja2 templates. Ansible core installs Jinja2 by default, but depending on your install and/or upgrade path, you might be running an outdated version of Jinja2. The minimum version of Jinja2 required for the collection to properly function is `3.1`. +- Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/3.1.x/intro/#installation). ### Molecule (Optional) -* Molecule is used to test the various roles included in the collection. The recommended version of Molecule to test this role is `3.3`. -* At the moment, there are no end to end integration tests. You will need to change directory into each role's respective directory. -* 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 NGINX Plus and/or NGINX App Protect Molecule tests, you must copy your corresponding license to the respective role's [`files/license`](https://github.com/nginxinc/ansible-role-nginx/blob/main/files/license/) folder. +- Molecule is used to test the various roles included in the collection. The recommended version of Molecule to test this role is `4.x`. +- At the moment, there are no end to end integration tests. You will need to change directory into each role's respective directory. +- 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 NGINX Plus and/or NGINX App Protect Molecule tests, you must copy your corresponding license to the respective role's [`files/license`](https://github.com/nginxinc/ansible-role-nginx/blob/main/files/license/) folder. -You can alternatively add your NGINX certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests: + You can alternatively add your NGINX certificate and key to the local environment. Run the following commands to export these files as base64-encoded variables and execute the Molecule tests: -```bash -export NGINX_CRT=$( cat | base64 ) -export NGINX_KEY=$( cat | base64 ) -molecule test --all -``` + ```bash + export NGINX_CRT=$( cat | base64 ) + export NGINX_KEY=$( cat | base64 ) + molecule test --all + ``` ## Installation ### Ansible Galaxy -Use `ansible-galaxy collection install nginxinc.nginx_core` to install the latest stable release of the collection on your system. +To install the latest stable release of the collection on your system, use: + +```bash +ansible-galaxy collection install nginxinc.nginx_core +``` + +Alternatively, if you have already installed the collection, update the collection to the latest release: -You can also include the collection in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format: +```bash +ansible-galaxy collection install -f nginxinc.nginx_core +``` + +You can also include the collection in a `requirements.yml` file: ```yaml --- collections: - name: nginxinc.nginx_core - version: 0.7.0 + version: 0.8.0 +``` + +And install the collection: + +```bash +ansible-galaxy collection install -r requirements.yml ``` ### Git -Use `git clone https://github.com/nginxinc/ansible-collection-nginx.git` to pull the latest edge commit of the collection from GitHub. +To pull the latest edge commit of the role from GitHub, use: + +```bash +git clone https://github.com/nginxinc/ansible-collection-nginx.git +``` ## Usage @@ -97,18 +117,22 @@ Sample playbooks for each use case covered by this collection can be found in th | Name | Description | | ---- | ----------- | | **[`deploy-nginx.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx.yml)** | Install NGINX | +| **[`deploy-nginx-web-server.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-web-server.yml)** | Install NGINX and configure a simple web server | +| **[`deploy-nginx-web-server-proxy.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-web-server-proxy.yml)** | Install NGINX and configure a simple reverse proxy in front of two web servers | | **[`deploy-nginx-plus.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-plus.yml)** | Install NGINX Plus | | **[`deploy-nginx-app-protect.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-app-protect.yml)** | Install NGINX App Protect WAF/DoS | | **[`deploy-nginx-plus-app-protect.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-plus-app-protect.yml)** | Install NGINX Plus and NGINX App Protect WAF | -| **[`deploy-nginx-web-server.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-web-server.yml)** | Install NGINX and configure a simple web server | -| **[`deploy-nginx-web-server-proxy.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-web-server-proxy.yml)** | Install NGINX and configure a simple reverse proxy in front of two web servers | | **[`deploy-nginx-plus-app-protect-web-server-proxy.yml`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/deploy-nginx-plus-app-protect-web-server-proxy.yml)** | Install NGINX Plus and NGINX App Protect and configure a simple reverse proxy in front of two web servers protected by NGINX App Protect WAF/DoS | ## Development Currently, all the NGINX roles included in this collection (found in the [`roles/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/roles/) folder) are Git submodules, and work on the roles themselves should take place in the corresponding upstream role repository. -To update the roles included in this collection to their latest version, run `git submodule update --recursive --remote`. +To update the roles included in this collection to their latest version, use: + +```bash +git submodule update --recursive --remote +``` ## Other NGINX Ansible Collections and Roles @@ -122,4 +146,4 @@ You can find the Ansible NGINX Unit role to install NGINX Unit [here](https://gi [Alessandro Fael Garcia](https://github.com/alessfg) -© [F5, Inc.](https://www.f5.com/) 2020 - 2022 +© [F5, Inc.](https://www.f5.com/) 2020 - 2023 diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..a211492 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,33 @@ +# Support + +We use GitHub for tracking bugs and feature requests related to the Ansible NGINX Core collection. + +## Ask a Question + +Don't know how something works? Curious if the Ansible NGINX Core collection can achieve your desired functionality? Please open an issue on GitHub with the label `question`. + +## NGINX Specific Questions and/or Issues + +This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding! + +### Community Slack + +We have a community [Slack](https://nginxcommunity.slack.com/)! + +If you are not a member click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!) + +Once you join, check out the `#beginner-questions` and `nginx-users` channels :) + +### Documentation + +For a comprehensive list of all NGINX directives, check out . + +For a comprehensive list of admin and deployment guides for all NGINX products, check out . + +### Mailing List + +Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at ! + +## Contributing + +Please see the [contributing guide](https://github.com/nginxinc/ansible-collection-nginx/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project. diff --git a/galaxy.yml b/galaxy.yml index fb0c83a..a19e0e7 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -2,7 +2,7 @@ namespace: nginxinc name: nginx_core description: Install and configure NGINX and NGINX App Protect using Ansible -version: 0.7.0 +version: 0.8.0 readme: README.md license_file: LICENSE authors: @@ -10,8 +10,8 @@ authors: dependencies: ansible.posix: ">=1.4.0" - community.crypto: ">=2.5.0" - community.general: ">=5.5.0" + community.crypto: ">=2.10.0" + community.general: ">=6.2.0" repository: https://github.com/nginxinc/ansible-collection-nginx homepage: https://github.com/nginxinc/ansible-collection-nginx diff --git a/meta/runtime.yml b/meta/runtime.yml index 3283db3..27137f3 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,2 +1,2 @@ --- -requires_ansible: '>=2.11' \ No newline at end of file +requires_ansible: '>=2.12' diff --git a/playbooks/deploy-nginx-app-protect.yml b/playbooks/deploy-nginx-app-protect.yml index 97b2f13..6f30184 100644 --- a/playbooks/deploy-nginx-app-protect.yml +++ b/playbooks/deploy-nginx-app-protect.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX App Protect WAF/DoS + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx-plus-app-protect-web-server-proxy.yml b/playbooks/deploy-nginx-plus-app-protect-web-server-proxy.yml index 5ceec7c..660aec3 100644 --- a/playbooks/deploy-nginx-plus-app-protect-web-server-proxy.yml +++ b/playbooks/deploy-nginx-plus-app-protect-web-server-proxy.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX Plus and NGINX App Protect and configure a simple reverse proxy in front of two web servers protected by NGINX App Protect WAF/DoS + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx-plus-app-protect.yml b/playbooks/deploy-nginx-plus-app-protect.yml index 3ec868f..5bc0c80 100644 --- a/playbooks/deploy-nginx-plus-app-protect.yml +++ b/playbooks/deploy-nginx-plus-app-protect.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX Plus and NGINX App Protect WAF + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx-plus.yml b/playbooks/deploy-nginx-plus.yml index ded8076..f53176e 100644 --- a/playbooks/deploy-nginx-plus.yml +++ b/playbooks/deploy-nginx-plus.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX Plus + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx-web-server-proxy.yml b/playbooks/deploy-nginx-web-server-proxy.yml index d94d97a..1d716df 100644 --- a/playbooks/deploy-nginx-web-server-proxy.yml +++ b/playbooks/deploy-nginx-web-server-proxy.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX and configure a simple reverse proxy in front of two web servers + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx-web-server.yml b/playbooks/deploy-nginx-web-server.yml index b4c5fa3..26c9d56 100644 --- a/playbooks/deploy-nginx-web-server.yml +++ b/playbooks/deploy-nginx-web-server.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX and configure a simple web server + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/playbooks/deploy-nginx.yml b/playbooks/deploy-nginx.yml index 2ac211a..159a06f 100644 --- a/playbooks/deploy-nginx.yml +++ b/playbooks/deploy-nginx.yml @@ -1,5 +1,6 @@ --- -- hosts: all +- name: Install NGINX + hosts: all collections: - nginxinc.nginx_core tasks: diff --git a/roles/nginx b/roles/nginx index 285b745..0bbb634 160000 --- a/roles/nginx +++ b/roles/nginx @@ -1 +1 @@ -Subproject commit 285b7454895cf8145cb0559b51e42e74b63a18d5 +Subproject commit 0bbb634f94ac72e4ce97e29fddf2f959f9d56b36 diff --git a/roles/nginx_app_protect b/roles/nginx_app_protect index cf0b6ea..26959a0 160000 --- a/roles/nginx_app_protect +++ b/roles/nginx_app_protect @@ -1 +1 @@ -Subproject commit cf0b6ea4fd22aa9111600fd3e3b7f83df86d9618 +Subproject commit 26959a0508b22fffc0eeb27f8960ac5a39dfc513 diff --git a/roles/nginx_config b/roles/nginx_config index d01d172..c60afdc 160000 --- a/roles/nginx_config +++ b/roles/nginx_config @@ -1 +1 @@ -Subproject commit d01d17268399a52e4b0c556d9cf4f91c8bb1f8c8 +Subproject commit c60afdc0fcd369a662645b0986978640f89333f1