PUPPET-CONFIG(8)

✨ NAME ✨

puppet-config β€” it's the Puppet manual girlie (section 8, iykyk) that lets you interact with Puppet's settings πŸ’…


🌸 SYNOPSIS 🌸

puppet config action [--section SECTION_NAME]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so bestie, this subcommand can inspect and modify settings straight out of Puppet's puppet.conf configuration file ✨

and like, for the actual documentation about individual settings, go look at https://puppet.com/docs/puppet/latest/configuration.html πŸ“–


πŸŽ€ OPTIONS πŸŽ€

heads up bestie: any setting that's valid in the configuration file is also a valid long argument, even if it may or may not be relevant to the present action. for example, server and run_mode are valid settings, so you can specify --server <servername>, or --run_mode <runmode> as an argument πŸ’–

see the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html for the full list of acceptable parameters πŸ‘‘ and ngl, a commented list of all configuration options can also be generated by running puppet with --genconfig ⭐

  • --render-as FORMAT β€” the format in which to render output ✨ the most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available πŸŽ€
  • --verbose β€” whether to log verbosely πŸ—£οΈ
  • --debug β€” whether to log debug information πŸ”
  • --section SECTION_NAME β€” the section of the puppet.conf configuration file to interact with πŸ’«

the three most commonly used sections are main, server, and agent 🫢 main is the default, and is used by all Puppet applications. other sections can override main values for specific applications --- the server section affects Puppet Server, and the agent section affects puppet agent 🌈

less commonly used is the user section, which affects puppet apply 🧚 any other section will be treated as the name of a legacy environment (a deprecated feature), and can only include the manifest and modulepath settings 😭


πŸ’– ACTIONS πŸ’–

🌟 delete β€” Delete a Puppet setting 🌟

SYNOPSIS

puppet config delete [--section SECTION_NAME] setting

DESCRIPTION

deletes a setting from the specified section πŸ—‘οΈ (the default is the section main) ✨

NOTES

by default, this action deletes the configuration setting from the main configuration domain πŸ‘‘ use the --section flags to delete settings from other configuration domains πŸ’…


SYNOPSIS

puppet config print [--section SECTION_NAME] all | setting
[setting ...]

DESCRIPTION

prints the value of a single setting or a list of settings πŸ“œ

this action is a replacement interface to the information available with puppet <subcommand> --configprint πŸ”

NOTES

by default, this action reads the general configuration in the main section 🫢 use the --section and --environment flags to examine other configuration domains 🌈


🌟 set β€” Set Puppet's settings 🌟

SYNOPSIS

puppet config set [--section SECTION_NAME] [setting_name]
[setting_value]

DESCRIPTION

updates values in the puppet.conf configuration file ✍️

NOTES

by default, this action manipulates the configuration in the main section πŸ’« use the --section flag to manipulate other configuration domains πŸŽ€


πŸ“ EXAMPLES πŸ“

delete

delete the setting setting_name from the main configuration domain:

$ puppet config delete setting_name

delete the setting setting_name from the server configuration domain:

$ puppet config delete setting_name --section server

print

get puppet's runfile directory:

$ puppet config print rundir

get a list of important directories from the server's config:

$ puppet config print all --section server | grep -E "(path|dir)"

set

set puppet's runfile directory:

$ puppet config set rundir /var/run/puppetlabs

set the vardir for only the agent:

$ puppet config set vardir /var/lib/puppet --section agent

Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING πŸ’œ


and that's a wrap bestie ✨ this lil masterpiece came to you from Puppet, Inc., dated September 2024 πŸŽ€ no cap, go forth and configure πŸ¦‹πŸ’–

πŸ“¦ where this page comes from