From 35eb733c04a91d8e9827d55532b060c14aa7d0cf Mon Sep 17 00:00:00 2001 From: Kevin Paulisse Date: Mon, 9 Jan 2017 13:27:56 -0600 Subject: [PATCH] Update catalog doc - you can use the config API --- doc/dev/api/v1/calls/catalog.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/dev/api/v1/calls/catalog.md b/doc/dev/api/v1/calls/catalog.md index 233a5db3..4aad9215 100644 --- a/doc/dev/api/v1/calls/catalog.md +++ b/doc/dev/api/v1/calls/catalog.md @@ -19,6 +19,8 @@ The `catalog` method takes one argument, which is a Hash containing parameters. 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). +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. + ### Global parameters #### `:logger` (Logger, Optional) @@ -37,6 +39,8 @@ The node name whose catalog is to be compiled or obtained. This should be the fu 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. +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. + #### `:bootstrap_script` (String, Optional) 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 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'`. -#### `:puppet_binary` (String, Optional) +#### `:puppet_binary` (String, Required) -Path to the Puppet binary on your system. If not specified, default locations will be checked. +Path to the Puppet binary on your system. Please refer to [Configuring octocatalog-diff to use Puppet](/doc/configuration-puppet.md) for details of connecting octocatalog-diff to your Puppet installation.