Optimize

CHANGES.rst

@@ -6,9 +6,9 @@ Changelog
 **debops.hashicorp**
 
 This project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`__
-and `human-readable changelog <http://keepachangelog.com/>`_.
+and `human-readable changelog <http://keepachangelog.com/en/0.3.0/>`__.
 
-The current role maintainer is drybjed_.
+The current role maintainer_ is drybjed_.
 
 
 `debops.hashicorp master`_ - unreleased

COPYRIGHT

@@ -1,7 +1,7 @@
 debops.hashicorp - Securely install HashiCorp applications
 
 Copyright (C) 2016 Maciej Delmanowski <[email protected]>
-Copyright (C) 2016 DebOps Project http://debops.org/
+Copyright (C) 2016 DebOps https://debops.org/
 
 This Ansible role is part of DebOps.
 
@@ -15,4 +15,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with DebOps. If not, see http://www.gnu.org/licenses/.
+along with DebOps. If not, see https://www.gnu.org/licenses/.

README.md

@@ -1,11 +1,11 @@
-## [![DebOps project](http://debops.org/images/debops-small.png)](http://debops.org) hashicorp
+## [![DebOps](https://debops.org/images/debops-small.png)](https://debops.org) hashicorp
 
 <!-- This file was generated by Ansigenome. Do not edit this file directly but
      instead have a look at the files in the ./meta/ directory. -->
 
-[![Travis CI](http://img.shields.io/travis/debops/ansible-hashicorp.svg?style=flat)](http://travis-ci.org/debops/ansible-hashicorp)
-[![test-suite](http://img.shields.io/badge/test--suite-ansible--hashicorp-blue.svg?style=flat)](https://github.com/debops/test-suite/tree/master/ansible-hashicorp/)
-[![Ansible Galaxy](http://img.shields.io/badge/galaxy-debops.hashicorp-660198.svg?style=flat)](https://galaxy.ansible.com/debops/hashicorp)
+[![Travis CI](https://img.shields.io/travis/debops/ansible-hashicorp.svg?style=flat)](https://travis-ci.org/debops/ansible-hashicorp)
+[![test-suite](https://img.shields.io/badge/test--suite-ansible--hashicorp-blue.svg?style=flat)](https://github.com/debops/test-suite/tree/master/ansible-hashicorp/)
+[![Ansible Galaxy](https://img.shields.io/badge/galaxy-debops.hashicorp-660198.svg?style=flat)](https://galaxy.ansible.com/debops/hashicorp)
 
 
 The `debops.hashicorp` Ansible role can be used to securely install
@@ -28,7 +28,7 @@ ansible-galaxy install debops.hashicorp
 ### Documentation
 
 More information about `debops.hashicorp` can be found in the
-[official debops.hashicorp documentation](http://docs.debops.org/en/latest/ansible/roles/ansible-hashicorp/docs/).
+[official debops.hashicorp documentation](https://docs.debops.org/en/latest/ansible/roles/ansible-hashicorp/docs/).
 
 
 
@@ -38,20 +38,18 @@ You may need to include missing roles from the [DebOps common
 playbook](https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml)
 into your playbook.
 
-[Try DebOps now](https://github.com/debops/debops) for a complete solution to run your Debian-based infrastructure.
+[Try DebOps now](https://debops.org/) for a complete solution to run your Debian-based infrastructure.
 
 
 
 
 
 ### Authors and license
 
-`hashicorp` role was written by:
+- Maciej Delmanowski (maintainer) | [e-mail](mailto:[email protected]) | [Twitter](https://twitter.com/drybjed) | [GitHub](https://github.com/drybjed)
 
-- Maciej Delmanowski | [e-mail](mailto:[email protected]) | [Twitter](https://twitter.com/drybjed) | [GitHub](https://github.com/drybjed)
-
-License: [GPLv3](https://tldrlegal.com/license/gnu-general-public-license-v3-%28gpl-3%29)
+License: [GPL-3.0](https://tldrlegal.com/license/gnu-general-public-license-v3-%28gpl-3%29)
 
 ***
 
-This role is part of the [DebOps](http://debops.org/) project. README generated by [ansigenome](https://github.com/nickjj/ansigenome/).
+This role is part of [DebOps](https://debops.org/). README generated by [ansigenome](https://github.com/nickjj/ansigenome/).

docs/ansible-integration.rst

@@ -12,13 +12,13 @@ Ansible integration
 Support for other Ansible roles
 -------------------------------
 
-The debops.hashicorp_ Ansible role is designed to be used by other Ansible
+The ``debops.hashicorp`` Ansible role is designed to be used by other Ansible
 roles as role dependency. By design, the application binaries are installed in
 the specified path and the rest of the service configuration, including service
 process manager configuration, firewall, TCP/UDP port registration in
 :file:`/etc/services`, etc. is left to the user or other Ansible roles.
 
-To facilitate seamless role integration, debops.hashicorp_ role provides
+To facilitate seamless role integration, ``debops.hashicorp`` role provides
 a set of default variables and Ansible local facts that can be used by other
 Ansible roles idempotently. Thus, the modification of the role itself shouldn't
 be needed, and it can should be easily integrated in the different playbooks
@@ -29,15 +29,15 @@ Default variables available to other roles
 ------------------------------------------
 
 You can use these variables in the playbook to influence the operation of the
-debops.hashicorp_ role from another role:
+``debops.hashicorp`` role from another role:
 
 :envvar:`hashicorp__dependent_packages`
-  List of APT packages which should be installed when the debops.hashicorp_
+  List of APT packages which should be installed when the ``debops.hashicorp``
   role is executed.
 
 :envvar:`hashicorp__dependent_applications`
   List of HashiCorp_ applications which should be installed by the
-  debops.hashicorp_ role. For the list of available applications, refer to
+  ``debops.hashicorp`` role. For the list of available applications, refer to
   the :envvar:`hashicorp__default_version_map` variable.
 
 :envvar:`hashicorp__consul_webui`
@@ -54,7 +54,7 @@ In a hypothetical ``consul`` Ansible role create a default variable:
 
    consul__hashicorp_application: 'consul'
 
-Next, in the playbook that executes your role, include the debops.hashicorp_
+Next, in the playbook that executes your role, include the ``debops.hashicorp``
 role with your custom variable:
 
 .. code-block:: yaml
@@ -73,7 +73,7 @@ role with your custom variable:
 
 This playbook will then install the Consul_ application after verification,
 and configure it using your own Ansible role. Make sure that you use YAML list
-syntax correctly, otherwise the debops.hashicorp_ role will fail due to
+syntax correctly, otherwise the ``debops.hashicorp`` role will fail due to
 wrong variable type mismatch. To install multiple applications at once, you can
 use a different variant of the variables and playbook.
 
@@ -104,7 +104,7 @@ The playbook:
 Ansible local facts
 -------------------
 
-The debops.hashicorp_ role maintains a set of Ansible local facts with
+The ``debops.hashicorp`` role maintains a set of Ansible local facts with
 information about the installed applications. Other roles can use these facts
 in an idempotent way to prepare their own configuration. These facts are:
 

docs/getting-started.rst

@@ -10,7 +10,7 @@ Getting started
 Initial configuration
 ---------------------
 
-The debops.hashicorp_ role does not install any HashiCorp_ applications by
+The ``debops.hashicorp`` role does not install any HashiCorp_ applications by
 default, even if enabled in the Ansible inventory. You need to specify the
 application names you wish to install using the :envvar:`hashicorp__applications`
 list. For example, to install ``consul`` on all hosts that use the role, create
@@ -40,7 +40,7 @@ more details.
 Example inventory
 -----------------
 
-The debops.hashicorp_ Ansible role is not enabled by default. To enable it
+The ``debops.hashicorp`` Ansible role is not enabled by default. To enable it
 on a host, you need to include that host in the ``[debops_service_hashicorp]``
 inventory group:
 
@@ -54,7 +54,7 @@ Example playbook
 ----------------
 
 If you are using this role without DebOps, here's an example Ansible playbook
-that uses the debops.hashicorp_ role:
+that uses the ``debops.hashicorp`` role:
 
 .. literalinclude:: playbooks/hashicorp.yml
    :language: yaml

docs/introduction.rst

@@ -3,7 +3,7 @@ Introduction
 
 .. include:: includes/all.rst
 
-The debops.hashicorp_ Ansible role can be used to securely install HashiCorp_
+The ``debops.hashicorp`` Ansible role can be used to securely install HashiCorp_
 applications, such as `Consul`_, `Terraform`_, `Vault`_ and others.
 
 The selected applications are downloaded from the HashiCorp_ release repository,

docs/security.rst

@@ -12,7 +12,7 @@ debops.hashicorp security considerations
 Role security guidelines
 ------------------------
 
-Because the debops.hashicorp_ role can be used to install binary Go
+Because the ``debops.hashicorp`` role can be used to install binary Go
 applications on production systems, it was designed to check and validate the
 archives used for application deployment against a known Trust Path. This
 document explains the steps taken by the role to authenticate and verify the
@@ -28,7 +28,7 @@ Debian Software Repository. The Debian packages for different applications
 should be the preferred installation method when they are readily available on
 the Debian Stable release.
 
-The debops.hashicorp_ role is written in the belief that the verified and
+The ``debops.hashicorp`` role is written in the belief that the verified and
 authenticated access to the upstream versions of HashiCorp_ applications, even
 though installed using binary packages, can still be useful, for example to
 provide secure installation path to the software not packaged in Debian.
@@ -66,7 +66,7 @@ key used by HashiCorp_ is:
 
    91A6 E7F8 5D05 C656 30BE F189 5185 2D87 348F FC4C
 
-The HashiCorp_ OpenPGP key is published on the `keybase.io`_ website, on the
+The HashiCorp_ OpenPGP key is published on the keybase.io_ website, on the
 `hashicorp account <https://keybase.io/hashicorp>`_. The key is tracked by
 several other users of the site.
 
@@ -82,11 +82,11 @@ and can be imported from there using the :command:`gpg` command:
 Software installation procedure
 -------------------------------
 
-The steps outlined below describe the method used by the debops.hashicorp_
+The steps outlined below describe the method used by the ``debops.hashicorp``
 role to verify and install the HashiCorp_ applications selected by the user or
 another Ansible role:
 
-- The debops.hashicorp_ Ansible role creates a separate, unprivileged system
+- The ``debops.hashicorp`` Ansible role creates a separate, unprivileged system
   group and UNIX user account, by default both named ``hashicorp``. The account
   does not provide shell access and uses :file:`/usr/sbin/nologin` shell by
   default.