Skip to content

Commit 018c7d7

Browse files
committed
Update docs for hiera
1 parent 4d5e240 commit 018c7d7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

doc/configuration-hiera.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# Configuring octocatalog-diff to use Hiera
22

3-
## Hiera 5 with per-environment configuration only
3+
## Hiera 5
44

5-
Hiera 5 can recognize and use `hiera.yaml` file in the base directory of the environment. There is more information about this in Puppet's documentation:
5+
Hiera 5 is included with Puppet 4.9 and higher.
66

7-
- [Enable the environment layer for existing Hiera data](https://puppet.com/docs/puppet/5.3/hiera_migrate_environments.html)
7+
If there is a `hiera.yaml` file in the base directory of the environment that is in hiera 5 format, and you are running Puppet 4.9 or higher, then that file will be recognized by Puppet (and therefore, by octocatalog-diff). There is no special configuration for octocatalog-diff needed to make this work. Similarly, there is no command line option or setting to changed this behavior, because there is no corresponding option to change Puppet's behavior.
8+
9+
If you are running Puppet 4.8 or lower, then the `hiera.yaml` file in the base directory of the environment will be ignored (unless you use `--hiera-config` to specify it as your global configuration file).
810

9-
There is no special configuration for octocatalog-diff needed to make this work. If you have no global hiera configuration, make sure that you are *not* using any of the following command line options or [configuration settings](/doc/configuration.md):
11+
If you have no global hiera configuration and you wish to rely on a `hiera.yaml` file in the base directory of your environment, make sure that you are *not* using any of the following command line options or [configuration settings](/doc/configuration.md):
1012

1113
- `--hiera-path` or `settings[:hiera_path]`
1214
- `--hiera-path-strip` or `settings[:hiera_path_strip]`
1315
- `--hiera-config` or `settings[:hiera_config]`
1416

15-
## Hiera 3 or before, or Hiera 5 with global configuration
17+
There is more information about Hiera 5 in Puppet's documentation:
18+
19+
- [Enable the environment layer for existing Hiera data](https://puppet.com/docs/puppet/5.3/hiera_migrate_environments.html)
20+
21+
## Hiera global configuration
1622

1723
If you are using Hiera 5 with a global configuration, or you are using Hiera 3 or before, then you must already have a [`hiera.yaml`](https://docs.puppet.com/puppet/latest/reference/config_file_hiera.html) file to configure it. These instructions will guide you through pointing octocatalog-diff at that configuration file.
1824

0 commit comments

Comments
 (0)