# Ansible Hieradata

[![Version on Galaxy](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fcodeaffen%2Fhieradata%2F&query=%24.highest_version.version&label=galaxy)](https://galaxy.ansible.com/ui/repo/published/codeaffen/hieradata/)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0372c2bb95e845ce96fa5d4cf13ca1ca)](https://www.codacy.com/gh/codeaffen/ansible-hiera-data/dashboard?utm_source=github.com&utm_medium=referral&utm_content=codeaffen/ansible-hiera-data&utm_campaign=Badge_Grade)
[![Documentation Status](https://readthedocs.org/projects/ansible-hiera-data/badge/?version=develop)](https://ansible-hiera-data.readthedocs.io/en/develop/?badge=develop)

This collection provides plugins to manage your project configuration data in a hierarchical manner like [puppet](https://puppet.com/docs/puppet/6.17/hiera_quick.html) do.

## Installation

The collection is available via [Ansible Galaxy](https://galaxy.ansible.com/codeaffen/hieradata). So you can run

```bash
ansible-galaxy collection install codeaffen.hieradata
```

Alternatively you can build and install the collection from source.

```bash
make dist
ansible-galaxy collection install codeaffen-hieradata-<version>.tar.gz
```

## Configuraton

### vars plugin configuration

The plugin comes with useful defaults to start to use the `hieradata` vars plugin without any configuration.

But if you need to customize the configuration you can see in
[documentation](https://ansible-hiera-data.readthedocs.io/en/develop/plugins/hieradata_vars.html#ansible-collections-codeaffen-hieradata-hieradata-vars)
you can configure the vars plugin eigther via `ansible.cfg` parameter in section `hieradata` or via environment variables.

You have to keep in mind that the paths for `basedir` and `config` are relative to your inventory or playbook directory, depending of the selected stage. Without any configuration you have to place the basedir and config as followed.

```bash
.
├── ansible.cfg
├── hieradata
├── hieradata.yml
└── hosts
```

If you want to use a different base then `hieradata` you can override it by exporting `HIERADATA_BASE_DIR` environment variable. This directory also has to belongs to inventory dirctory.

```bash
.
├── ansible.cfg
└── inventory
    ├── hieradata
    │   └── customer_a
    ├── hieradata.yml
    └── hosts
```

In this example you need to do `export HIERADATA_BASE_DIR=hieradata/customer_a` if you want to use `hieradata/customer_a` as hiera basedir.

## Documentation

### readthedocs.io

Current documentation can be found on [readthedocs.io](https://ansible-hiera-data.readthedocs.io/en/develop).

### repository folder

A last option to read the docs is the docs folder in this repository.

## Dependencies

The following dependencies have to be fulfiled by the Ansible controller.

* ...

## Need help?

If you’ve found any issues in this release please head over to github and open a bug so we can take a look.