Ansible Role: helm_docs

This role installs the helm-docs binary on any supported host.

Requirements

N/A

Role Variables

Available variables are listed below, along with default values (see defaults/main.yaml):

app_ver: '1.4.0'
app_platform: linux
app_arch: x86_64

Controls for the version of Helm to be installed. See available helm-docs releases. You can upgrade or downgrade versions by changing the app_ver.

app_install_dir: /usr/local/bin

The location where the helm-docs binary will be installed.

Dependencies

• andrewrothstein.unarchive-deps

Install dependencies

$ ansible-galaxy role install -r requirements.yaml

Example Playbook

- hosts: all
  roles:
    - role: nicholaswilde.helm_docs

Testing

If you want to use moleculte to test, be sure to check out the repo in a folder titled nicholaswilde.helm_docs

# Checkout
$ git clone https://github.com/nicholaswilde/ansible-role-helm-docs.git nicholaswilde.helm_docs
$ cd nicholaswilde.helm_docs
# Test
$ molecule test
# Converge
$ molecule converge

Pre-commit hook

If you want to automatically lint the files with a pre-commit hook, make sure you install the pre-commit binary, and add a .pre-commit-config.yaml file to your project. Then run:

$ pre-commit install
$ pre-commit install-hooks

Inspiration

Inspiration for this repository has been taken from Andrew Rothstein and Jeff Geerling.

License

Apache 2.0 License

Author Information

This project was started in 2020 by Nicholas Wilde.