You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/dev/api/v1/calls/catalog.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@ The `catalog` method takes one argument, which is a Hash containing parameters.
19
19
20
20
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).
21
21
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
+
22
24
### Global parameters
23
25
24
26
#### `:logger` (Logger, Optional)
@@ -37,6 +39,8 @@ The node name whose catalog is to be compiled or obtained. This should be the fu
37
39
38
40
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.
39
41
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
+
40
44
#### `:bootstrap_script` (String, Optional)
41
45
42
46
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
72
76
73
77
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'`.
74
78
75
-
#### `:puppet_binary` (String, Optional)
79
+
#### `:puppet_binary` (String, Required)
76
80
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.
78
82
79
83
Please refer to [Configuring octocatalog-diff to use Puppet](/doc/configuration-puppet.md) for details of connecting octocatalog-diff to your Puppet installation.
0 commit comments