Update readme and set yamllint version (#7)

Author: alessfg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,7 @@ Steps to reproduce the behavior:
 A clear and concise description of what you expected to happen.
 
 **Your environment:**
--   Version of the NGINX Unit Role or specific commit
+-   Version of the NGINX Unit role or specific commit
 -   Version of Ansible
 -   Target deployment platform
 

.github/pull_request_template.md

@@ -4,7 +4,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
 ### 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-unit/blob/master/CONTRIBUTING.md) document
+-   [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/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`)

.travis.yml

@@ -1,15 +1,15 @@
 ---
 language: python
 services: docker
+branches:
+  only:
+    - main
 jobs:
   include:
-    - name: "(Debian/Ubuntu) Install NGINX Unit and NGINX Unit modules"
+    - name: (Debian/Ubuntu) Install NGINX Unit and NGINX Unit modules
       env:
         scenario: default
-    - name: "(Alpine) Install NGINX Unit and NGINX Unit modules"
-      env:
-        scenario: default_alpine
-    - name: "(CentOS) Install NGINX Unit and NGINX Unit modules"
+    - name: (CentOS) Install NGINX Unit and NGINX Unit modules
       env:
         scenario: default_centos
 before_install:
@@ -18,10 +18,11 @@ before_install:
   - sudo apt-get update
   - sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce
 install:
-  - pip install ansible==2.9.13
-  - pip install ansible-lint==4.3.4
-  - pip install yamllint==1.24.2
-  - pip install molecule==3.0.8
+  - pip install ansible-base==2.10.3
+  - pip install ansible==2.10.3
+  - pip install ansible-lint==4.3.7
+  - pip install yamllint==1.25.0
+  - pip install 'molecule[docker]'==3.1.5
   - pip install docker==4.3.1
 script:
   - molecule --version

CHANGELOG.md

@@ -1,27 +1,33 @@
 # Changelog
 
-## 0.2.1 (Unreleased)
+## 0.2.1 (November 19, 2020)
 
 ENHANCEMENTS:
 
-*   Update Ansible to `2.9.13` and Ansible Lint to `4.3.4`.
+*   Update Ansible (now Ansible base) to `2.10.3`, Ansible (now Ansible Community Distribution) to `2.10.3`, Ansible Lint to `4.3.7`, Molecule to `3.1.5`, and yamllint to `1.25.0`.
+*   Moved "constant" variables to `vars/main.yml`.
+*   Switch to using `ansible_facts` wherever possible.
+*   Major backend refactoring to reduce the number of files and tasks.
+*   Improved tasks naming conventions.
+*   Add survey to README.
+*   Improve README structure and use tables where relevant.
 
 ## 0.2.0 (August 27, 2020)
 
 BREAKING CHANGES:
 
-*   The repository names in Debian and RedHat based distros have slightly changed. You may run into some duplication issues when running the role on a preexisting target that already has had NGINX installed using the role. To fix this, manually remove the old repository source.
+The repository names in Debian and RedHat based distros have slightly changed. You may run into some duplication issues when running the role on a preexisting target that already has had NGINX installed using the role. To fix this, manually remove the old repository source.
+
+FEATURES:
+
+TravisCI now always uses the latest version of Docker.
 
 ENHANCEMENTS:
 
 *   Update Ansible to `2.9.12` and Ansible Lint to `4.3.2`.
 *   Explicitly define `mode` in relevant tasks.
 *   Explicitly define the `nginx-unit` `apt_repository` and `yum_repository` filename in Debian and RedHat based distros.
 
-FEATURES:
-
-*   TravisCI now always uses the latest version of Docker.
-
 ## 0.1.0 (August 19, 2020)
 
 Initial release of the NGINX Unit role. Contains all NGINX Unit related features previously available on the [NGINX Ansible role](https://github.com/nginxinc/ansible-role-nginx).

CONTRIBUTING.md

@@ -14,25 +14,26 @@ The following is a set of guidelines for contributing to the NGINX Ansible role.
 *   [Git Guidelines](#git-guidelines)
 *   [Ansible Guidelines](#ansible-guidelines)
 
-[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-unit/blob/master/CODE_OF_CONDUCT.md)
+[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/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`.
+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-unit/blob/master/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
+Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/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 Unit.
-*   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
+*   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`.
+    *   "Constant" variables can be found in `vars/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
 
@@ -46,8 +47,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, 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-unit/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+*   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-unit/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.
 
@@ -63,10 +64,10 @@ Note: if you’d like to implement a new feature, please consider creating a fea
 
 ### 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`)
+*   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`).

README.md

@@ -1,36 +1,38 @@
-Ansible NGINX Unit Role
-=======================
+[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx__unit-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_unit)
+[![Build Status](https://travis-ci.org/nginxinc/ansible-role-nginx-unit.svg?branch=main)](https://travis-ci.org/nginxinc/ansible-role-nginx-unit)
+[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# 👾 *Help make the NGINX config Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
+
+# Ansible NGINX Unit Role
 
 This role installs NGINX Unit on your target host.
 
 **Note:** This role is still in active development. There may be unidentified issues and the role variables may change as development continues.
 
-Requirements
-------------
-
-**Ansible**
+## Requirements
 
-This role was developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
+### Ansible
 
-Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
+*   This role is developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
+*   Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
 
-**Molecule**
+### Molecule
 
-Molecule is used to test the various functionailities of the role. Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
+*   Molecule `3.x` is used to test the various functionalities of the role.
+*   Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
 
-Installation
-------------
+## Installation
 
-**Ansible Galaxy**
+### Ansible Galaxy
 
 Use `ansible-galaxy install nginxinc.nginx_unit` to install the latest stable release of the role on your system.
 
-**Git**
+### Git
 
 Use `git clone https://github.com/nginxinc/ansible-role-nginx-unit.git` to pull the latest edge commit of the role from GitHub.
 
-Platforms
----------
+## Platforms
 
 The NGINX Ansible role supports all platforms supported by [NGINX Unit](https://unit.nginx.org/installation/#official-packages):
 
@@ -62,43 +64,44 @@ Ubuntu:
     - focal
 ```
 
-Role Variables
---------------
+## Role Variables
 
-This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main`** directory 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-unit/blob/main/defaults/main/)** folder in the following files:
 
--   **[defaults/main/main.yml](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/main.yml):** NGINX Unit installation variables
--   **[defaults/main/selinux.yml](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/unit.yml):** NGINX Unit SELinux variables
--   **[defaults/main/bsd.yml](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/bsd.yml):** BSD specific installation variables
+|Name|Description|
+|----|-----------|
+|**[`defaults/main/main.yml`](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/main.yml)**|NGINX Unit installation variables|
+|**[`defaults/main/selinux.yml`](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/unit.yml)**|NGINX Unit SELinux variables|
+|**[`defaults/main/bsd.yml`](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/defaults/main/bsd.yml)**|BSD specific installation variables|
 
-Example Playbooks
------------------
+## Example Playbooks
 
-A working functional playbook example can be found in the **`molecule/common`** directory in the following file:
+A working functional playbook example can be found in the **[`molecule/common/playbooks`](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/molecule/common/)** folder in the following file:
 
-**[molecule/common/playbooks/default_converge.yml](https://github.com/nginxinc/ansible-role-nginx-unit/blob/master/molecule/common/playbooks/default_converge.yml):** Install NGINX Unit
+|Name|Description|
+|----|-----------|
+|**[`molecule/common/playbooks/default_converge.yml`](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/molecule/common/playbooks/default_converge.yml)**|Install NGINX Unit|
 
 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-unit` to `nginxinc.nginx_unit`.
 
-Other NGINX Roles
------------------
+## Other NGINX Ansible Collections and Roles
 
-You can find an Ansible role to install and configure NGINX [here](https://github.com/nginxinc/ansible-role-nginx)
+You can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect [here](https://github.com/nginxinc/ansible-collection-nginx).
 
-You can find an Ansible role to install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect)
+You can find the Ansible NGINX role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx).
 
-You can find an Ansible collection of roles to install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller)
+You can find the Ansible NGINX configuration role to configure NGINX [here](https://github.com/nginxinc/ansible-role-nginx-config).
 
-License
--------
+You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect).
 
-[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx/blob/main/LICENSE)
+You can find the Ansible NGINX Controller collection of roles to install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller).
 
-Author Information
-------------------
+## License
 
-[Alessandro Fael Garcia](https://github.com/alessfg)
+[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx-unit/blob/main/LICENSE)
+
+## Author Information
 
-[Tom Gamull](https://github.com/magicalyak)
+[Alessandro Fael Garcia](https://github.com/alessfg)
 
 © [F5 Networks, Inc.](https://www.f5.com/) 2020

defaults/main/bsd.yml

@@ -8,6 +8,3 @@ nginx_unit_bsd_install_packages: true
 # Options are true for use packages or false for do not use packages.
 # Default is true.
 nginx_unit_bsd_portinstall_use_packages: true
-
-# FreeBSD extra packages
-nginx_unit_freebsd_extra_packages: ['security/ca_root_nss']

defaults/main/main.yml

@@ -7,4 +7,4 @@ nginx_unit_modules: []
 
 # Choose where to fetch the NGINX signing key from.
 # Default is the official NGINX signing key host.
-# nginx_signing_key: http://nginx.org/keys/nginx_signing.key
+# nginx_unit_signing_key: http://nginx.org/keys/nginx_signing.key

handlers/main.yml

@@ -1,11 +1,11 @@
 ---
-- name: "(Handler: Debian/Ubuntu/CentOS/RedHat) Start NGINX Unit"
+- name: (Handler - Amazon Linux/CentOS/Debian/RedHat/Ubuntu) Start NGINX Unit
   service:
     name: unit
     state: started
     enabled: yes
 
-- name: "(Handler: FreeBSD) Start NGINX Unit"
+- name: (Handler - FreeBSD) Start NGINX Unit
   service:
     name: unitd
     state: started

molecule/common/Dockerfile.j2

@@ -17,27 +17,27 @@ ENV {{ var }} {{ value }}
 RUN \
   if [ $(command -v apt-get) ]; then \
     apt-get update \
-    && DEBIAN_FRONTEND=noninteractive apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd systemd-sysv procps curl \
+    && DEBIAN_FRONTEND=noninteractive apt-get install -y aptitude bash ca-certificates curl iproute2 python-apt python3 python3-apt procps sudo systemd systemd-sysv vim \
     && apt-get clean; \
   elif [ $(command -v dnf) ]; then \
     dnf makecache \
-    && dnf --assumeyes install /usr/bin/python3 /usr/bin/python3-config /usr/bin/dnf-3 bash iproute \
+    && dnf --assumeyes install bash iproute /usr/bin/dnf-3 /usr/bin/python3 /usr/bin/python3-config vim \
     && dnf clean all; \
   elif [ $(command -v yum) ]; then \
     yum makecache fast \
-    && yum install -y /usr/bin/python /usr/bin/python2-config sudo yum-plugin-ovl bash iproute \
+    && yum install -y bash iproute /usr/bin/python /usr/bin/python2-config sudo vim yum-plugin-ovl \
     && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf \
     && yum clean all; \
   elif [ $(command -v zypper) ]; then \
     zypper refresh \
-    && zypper install -y python3 sudo bash iproute2 \
+    && zypper install -y bash iproute2 python3 sudo vim \
     && zypper clean -a; \
   elif [ $(command -v apk) ]; then \
     apk update \
-    && apk add --no-cache python3 sudo bash ca-certificates curl openrc; \
+    && apk add --no-cache bash ca-certificates curl openrc python3 sudo vim; \
     echo 'rc_provide="loopback net"' >> /etc/rc.conf; \
   elif [ $(command -v xbps-install) ]; then \
     xbps-install -Syu \
-    && xbps-install -y python3 sudo bash ca-certificates iproute2 \
+    && xbps-install -y bash ca-certificates iproute2 python3 sudo vim \
     && xbps-remove -O; \
   fi