bolt-project.yaml options

Whether to disable analytics. Setting this option to 'false' in the system-wide or user-level configuration will disable analytics for all projects, even if this option is set to 'true' at the project level.

• Type: Boolean

analytics: false

A map of Puppet settings to use when applying Puppet code using the apply plan function or the bolt apply command.

• Type: Hash

Whether to use colored output when printing messages to the console.

• Type: Boolean

• Default: true

color: false

The maximum number of simultaneous manifest block compiles.

• Type: Integer

• Default: Number of cores.

compile-concurrency: 5

The number of threads to use when executing on remote targets.

• Type: Integer

• Default: 100 or 1/7 the ulimit, whichever is lower.

concurrency: 50

An array of IDs of warnings to suppress. Warnings with a matching ID will not be logged by Bolt. If you are upgrading Bolt to a new major version, you should re-enable all warnings until you have finished upgrading.

• Type: Array

disable-warnings:
- powershell_2

The format to use when printing results.

• Type: String

• Available values: human, json, rainbow

• Default: human

format: json

Enable new Bolt features that may include breaking changes.

• Type: Hash

The path to the Hiera configuration file.

• Type: String

• Default: project/hiera.yaml

hiera-config: "~/.puppetlabs/bolt/hiera.yaml"

A map of configuration for the logfile output. Under log, you can configure log options for console and add configuration for individual log files, such as ~/.puppetlabs/bolt/debug.log. Individual log files must be valid filepaths. If the log file does not exist, then Bolt will create it before logging information. Set the value to disable to remove a log file defined at an earlier level of the config hierarchy. By default, Bolt logs to a bolt-debug.log file in the Bolt project directory.

• Type: Hash

An array of directories that Bolt loads content such as plans and tasks from. Read more about modules in Module structure.

• Type: Array, String

• Default: ["project/modules"]

modulepath:
- "~/.puppetlabs/bolt/modules"
- "~/.puppetlabs/bolt/site-modules"

Options that configure where Bolt downloads modules from. This option is only used when installing modules using the bolt module add|install commands and Add|Install-BoltModule cmdlets.

• Type: Hash

A list of module dependencies for the project. Each dependency is a map of data specifying the module to install. To install the project's module dependencies, run the bolt module install command. For more information about specifying modules, see the documentation.

• Type: Array

• Default: []

modules:
- puppetlabs-facts
- name: puppetlabs-mysql
- name: puppetlabs-apache
  version_requirement: 5.5.0
- name: puppetlabs-puppetdb
  version_requirement: 7.x
- name: puppetlabs-firewall
  version_requirement: ">= 1.0.0 < 3.0.0"
- git: https://github.com/puppetlabs/puppetlabs-apt
  ref: 7.6.0

The name of the Bolt project. When this option is configured, the project is considered a Bolt project, allowing Bolt to load content from the project directory as though it were a module.

• Type: String

name: myproject

A list of plan names and glob patterns to filter the project's plans by. This option is used to limit the visibility of plans for users of the project. For example, project authors might want to limit the visibility of plans that are bundled with Bolt or plans that should only be run as part of another plan. When this option is not configured, all plans are visible. This option does not prevent users from running plans that are not part of this list.

• Type: Array

plans:
- myproject
- myproject::foo
- myproject::bar
- myproject::deploy::*

This feature is experimental. Enable plugin caching and set the time-to-live.

• Type: Hash

A map of plugin hooks and which plugins a hook should use. The only configurable plugin hook is puppet_library, which can use two possible plugins: puppet_agent and task.

• Type: Hash

• Pluggable: true

plugin-hooks:
  puppet_library:
    plugin: puppet_agent
    version: 6.15.0
    _run_as: root

A map of plugins and their configuration data, where each key is the name of a plugin and its value is a map of configuration data. Configurable options are specified by the plugin. Read more about configuring plugins in Using plugins.

• Type: Hash

plugins:
  pkcs7:
    keysize: 1024

A list of policy names and glob patterns to filter the project's policies by. This option is used to specify which policies are available to a project and can be applied to targets. When this option is not configured, policies are not available to the project and cannot be applied to targets.

• Type: Array

policies:
- myproject::apache
- myproject::postgres

A map containing options for configuring the Bolt PuppetDB client.

• Type: Hash

• Pluggable: true

A map of named PuppetDB instances and their configuration, where keys are the name of a PuppetDB instance and values are maps of configuration options. For more information, see Connecting Bolt to PuppetDB.

• Type: Hash

• Pluggable: true

The path to the project's rerun file. The rerun file is used to store information about targets from the most recent run. Expands relative to the project directory.

• Type: String

• Pluggable: true

rerunfile: "/Users/bolt/project/rerun.json"

Whether to update .rerun.json in the Bolt project directory. If your target names include passwords, set this value to false to avoid writing passwords to disk.

• Type: Boolean

• Default: true

save-rerun: false

Whether to print a spinner to the console for long-running Bolt operations.

• Type: Boolean

• Default: true

spinner: false

Whether to stream output from scripts and commands to the console. This option is experimental.

• Type: Boolean

• Default: false

stream: true

A list of task names and glob patterns to filter the project's tasks by. This option is used to limit the visibility of tasks for users of the project. For example, project authors might want to limit the visibility of tasks that are bundled with Bolt or plans that should only be run as part of a larger workflow. When this option is not configured, all tasks are visible. This option does not prevent users from running tasks that are not part of this list.

• Type: Array

tasks:
- myproject
- myproject::foo
- myproject::bar
- myproject::deploy_*

The path to an executable on the Bolt controller that can produce external trusted facts. External trusted facts are experimental in both Puppet and Bolt and this API might change or be removed.

• Type: String

trusted-external-command: "/etc/puppetlabs/facts/trusted_external.sh"