README.md in onceover-3.15.2 vs README.md in onceover-3.16.0

- old
+ new

@@ -11,10 +11,11 @@ - [Installation](#installation) - [Config files](#config-files) - [onceover.yaml](#onceoveryaml) - [factsets](#factsets) - [Hiera Data](#hiera-data) + - [r10k](#r10k) - [Spec testing](#spec-testing) - [Adding your own spec tests](#adding-your-own-spec-tests) - [Using Workarounds](#using-workarounds) - [Extra tooling](#extra-tooling) - [Plugins](#plugins) @@ -269,9 +270,24 @@ ### Hiera Data If you have hiera data inside your controlrepo (or somewhere else) Onceover can be configured to use it. It is however worth noting the the `hiera.yaml` file that you currently use may not be applicable for testing right away. For example; if you are using `hiera-eyaml` I recommend creating a `hiera.yaml` purely for testing that simply uses the `yaml` backend, meaning that you don't need to provide the private keys to the testing machines. It is also worth noting that any hiera hierarchies that are based on custom facts will not work unless those facts are part of your factsets. Trusted facts will also not work at all as the catalogs are being compiled without the node's certificate. In these instances it may be worth creating a hierarchy level that simply includes dummy data for testing purposes in order to avoid hiera lookup errors. + +### r10k + +If you have custom r10k config that you want to use, place the `r10k.yaml` file in one of the following locations: + +- `{repo root}/r10k.yaml` +- `{repo root}/spec/r10k.yaml` + +A good use of this is [enabling multi threading](https://github.com/puppetlabs/r10k/blob/master/doc/dynamic-environments/configuration.mkd#pool_size) by creating the following in `r10k.yaml`: + +```yaml +# spec/r10k.yaml +--- +pool_size: 20 +``` #### Creating the config file If your `hiera.yaml` is version 4 or 5 and lives in the root of the controlrepo (as it should), Onceover will pick this up automatically. If you would like to make changes to this file for testing purposes, create a copy under `spec/hiera.yaml`. Onceover will use this version of the hiera config file first if it exists.