website/docs: document puppet options

This commit is contained in:
Mitchell Hashimoto 2014-01-02 14:49:15 -08:00
parent e29bcba955
commit ab57550291
1 changed files with 39 additions and 0 deletions

View File

@ -20,6 +20,45 @@ calling `puppet apply`, without a Puppet Master.
</p>
</div>
## Options
This section lists the complete set of available options for the Puppet
provisioner. More detailed examples of how to use the provisioner are
available below this section.
* `facter` (hash) - A hash of data to set as available facter variables
within the Puppet run.
* `hiera_config_path` (string) - Path to the Hiera configuration on
the host. Read the section below on how to use Hiera with Vagrant.
* `manifest_file` (string) - The name of the manifest file that will serve
as the entrypoint for the Puppet run. This manifest file is expected to
exist in the configured `manifests_path` (see below). This defaults
to "init.pp"
* `manifest_path` (string) - The path to the directory which contains the
manifest files. This defaults to "manifests"
* `module_path` (string) - Path, on the host, to the directory which
contains Puppet modules, if any.
* `options` (array of strings) - Additionally options to pass to the
Puppet executable when running Puppet.
* `synced_folder_type` (string) - The type of synced folders to use when
sharing the data required for the provisioner to work properly. By default
this will use the default synced folder type. For example, you can set this
to "nfs" to use NFS synced folders.
* `temp_dir` (string) - The directory where all the data associated with
the Puppet run (manifest files, modules, etc.) will be stored on the
guest machine.
* `working_directory` (string) - Path in the guest that will be the working
directory when Puppet is executed. This is usually only set because relative
paths are used in the Hiera configuration.
## Bare Minimum
The quickest way to get started with the Puppet provisioner is to just