Skip to content

Commit 35eb733

Browse files
author
Kevin Paulisse
committed
Update catalog doc - you can use the config API
1 parent 006c1a7 commit 35eb733

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

doc/dev/api/v1/calls/catalog.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The `catalog` method takes one argument, which is a Hash containing parameters.
1919

2020
The list of parameters here is not exhaustive. The `.catalog` method accepts most parameters described in [Configuration](/doc/configuration.md), [Building catalogs instead of diffing catalogs](/doc/advanced-catalog-only.md), and [Command line options reference](/doc/optionsref.md).
2121

22+
It is also possible to use the parameters from [OctocatalogDiff::API::V1.config](/doc/dev/api/v1/calls/config.md) for the catalog compilation. Simply combine the hash returned by `.config` with any additional keys, and pass the merged hash to the `.catalog` method.
23+
2224
### Global parameters
2325

2426
#### `:logger` (Logger, Optional)
@@ -37,6 +39,8 @@ The node name whose catalog is to be compiled or obtained. This should be the fu
3739

3840
Directory that contains a git repository with the Puppet code. Use in conjunction with `:to_branch` to specify the branch name that should be checked out.
3941

42+
If your Puppet code is not in a git repository, or you already have the branch checked out via some other process, use `:bootstrapped_to_dir` instead.
43+
4044
#### `:bootstrap_script` (String, Optional)
4145

4246
Path to a script to run after checking out the selected branch of Puppet code from the git repository. See [Bootstrapping your Puppet checkout](/doc/advanced-bootstrap.md) for details.
@@ -72,9 +76,9 @@ Directory within your Puppet installation where Hiera data is stored. Please see
7276

7377
If your Puppet setup is modeled after the [Puppet control repository template](https://github.com/puppetlabs/control-repo), the correct setting for `:hiera_path` is `'hieradata'`.
7478

75-
#### `:puppet_binary` (String, Optional)
79+
#### `:puppet_binary` (String, Required)
7680

77-
Path to the Puppet binary on your system. If not specified, default locations will be checked.
81+
Path to the Puppet binary on your system.
7882

7983
Please refer to [Configuring octocatalog-diff to use Puppet](/doc/configuration-puppet.md) for details of connecting octocatalog-diff to your Puppet installation.
8084

0 commit comments

Comments
 (0)