summaryrefslogtreecommitdiffstats
path: root/lib/puppet/reference
diff options
context:
space:
mode:
authorMax Martin <max@puppetlabs.com>2011-06-02 15:56:22 -0700
committerMax Martin <max@puppetlabs.com>2011-06-02 15:56:22 -0700
commit4801e10c81264b20c2d35b0d44c10cfb0668d1b9 (patch)
tree3e3024bbd4a46a3ab2af5bf29ec2f3b30db270d7 /lib/puppet/reference
parent520cbc0292ec0cf75b6871bb0a4bc12bce506bb0 (diff)
parent4ad88017d3b8b8000325f5165520a6c21b48c469 (diff)
downloadpuppet-4801e10c81264b20c2d35b0d44c10cfb0668d1b9.tar.gz
puppet-4801e10c81264b20c2d35b0d44c10cfb0668d1b9.tar.xz
puppet-4801e10c81264b20c2d35b0d44c10cfb0668d1b9.zip
Merge branch '2.7.x'
* 2.7.x: (40 commits) (#7746) Fix bootstrap issues from #7717 fix. (#7683) Use ronn, when available, to render the output. (#7683) Add a 'man' face and subcommand to Puppet. maint: remove obsolete work-around code from help face. (#7699) Don't duplicate inherited action names on faces. (#7177) Deprecate implicit 'puppet apply' for 2.7.0 (#7717) Layout cleanup for subcommand extraction. #7211: Test unknown options don't shadow unknown actions. #7211: nasty logic error with global Face options taking arguments. #7211: more helpful error messages in various cases. maint: Fix order dependent test failure (#5966) Add support for hostname regular expressions in auth.conf (#7708) Delete extended documentation from configuration reference (#7707) Document signals in puppet agent and puppet master help add puppet master polling step for ticket 7117 (#5318) Always notice changes to manifests when compiling. (#5318) Always notice changes to manifests when compiling. (#7557) Remove Faces Application maint: Fix order dependent spec failure for face indirection (#7690) Don't blow up when listing terminuses available for faces ... Conflicts (resolved manually): acceptance/tests/ticket_7117_broke_env_criteria_authconf.rb
Diffstat (limited to 'lib/puppet/reference')
-rw-r--r--lib/puppet/reference/configuration.rb127
1 files changed, 26 insertions, 101 deletions
diff --git a/lib/puppet/reference/configuration.rb b/lib/puppet/reference/configuration.rb
index 6581427ff..18efb6fe7 100644
--- a/lib/puppet/reference/configuration.rb
+++ b/lib/puppet/reference/configuration.rb
@@ -41,104 +41,29 @@ config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc
return str
end
-config.header = "
-## Specifying Configuration Parameters
-
-### On The Command-Line
-
-Every Puppet executable (with the exception of `puppetdoc`) accepts all of
-the parameters below, but not all of the arguments make sense for every executable.
-
-I have tried to be as thorough as possible in the descriptions of the
-arguments, so it should be obvious whether an argument is appropriate or not.
-
-These parameters can be supplied to the executables either as command-line
-options or in the configuration file. For instance, the command-line
-invocation below would set the configuration directory to `/private/puppet`:
-
- $ puppet agent --confdir=/private/puppet
-
-Note that boolean options are turned on and off with a slightly different
-syntax on the command line:
-
- $ puppet agent --storeconfigs
-
- $ puppet agent --no-storeconfigs
-
-The invocations above will enable and disable, respectively, the storage of
-the client configuration.
-
-### Configuration Files
-
-As mentioned above, the configuration parameters can also be stored in a
-configuration file, located in the configuration directory. As root, the
-default configuration directory is `/etc/puppet`, and as a regular user, the
-default configuration directory is `~user/.puppet`. As of 0.23.0, all
-executables look for `puppet.conf` in their configuration directory
-(although they previously looked for separate files). For example,
-`puppet.conf` is located at `/etc/puppet/puppet.conf` as `root` and
-`~user/.puppet/puppet.conf` as a regular user by default.
-
-All executables will set any parameters set within the `[main]` section,
-and each executable will also use one of the `[master]`, `[agent]`.
-
-#### File Format
-
-The file follows INI-style formatting. Here is an example of a very simple
-`puppet.conf` file:
-
- [main]
- confdir = /private/puppet
- storeconfigs = true
-
-Note that boolean parameters must be explicitly specified as `true` or
-`false` as seen above.
-
-If you need to change file or directory parameters (e.g., reset the mode or owner), do
-so within curly braces on the same line:
-
- [main]
- vardir = /new/vardir {owner = root, mode = 644}
-
-If you're starting out with a fresh configuration, you may wish to let
-the executable generate a template configuration file for you by invoking
-the executable in question with the `--genconfig` command. The executable
-will print a template configuration to standard output, which can be
-redirected to a file like so:
-
- $ puppet agent --genconfig > /etc/puppet/puppet.conf
-
-Note that this invocation will replace the contents of any pre-existing
-`puppet.conf` file, so make a backup of your present config if it contains
-valuable information.
-
-Like the `--genconfig` argument, the executables also accept a `--genmanifest`
-argument, which will generate a manifest that can be used to manage all of
-Puppet's directories and files and prints it to standard output. This can
-likewise be redirected to a file:
-
- $ puppet agent --genmanifest > /etc/puppet/manifests/site.pp
-
-Puppet can also create user and group accounts for itself (one `puppet` group
-and one `puppet` user) if it is invoked as `root` with the `--mkusers` argument:
-
- $ puppet master --mkusers
-
-## Signals
-
-The `puppet agent` and `puppet master` executables catch some signals for special
-handling. Both daemons catch (`SIGHUP`), which forces the server to restart
-tself. Predictably, interrupt and terminate (`SIGINT` and `SIGTERM`) will shut
-down the server, whether it be an instance of `puppet agent` or `puppet master`.
-
-Sending the `SIGUSR1` signal to an instance of `puppet agent` will cause it to
-immediately begin a new configuration transaction with the server. This
-signal has no effect on `puppet master`.
-
-## Configuration Parameter Reference
-
-Below is a list of all documented parameters. Not all of them are valid with all
-Puppet executables, but the executables will ignore any inappropriate values.
-
-"
-
+config.header = <<EOT
+## Configuration Settings
+
+* Each of these settings can be specified in `puppet.conf` or on the
+ command line.
+* When using boolean settings on the command line, use `--setting` and
+ `--no-setting` instead of `--setting (true|false)`.
+* Settings can be interpolated as `$variables` in other settings; `$environment`
+ is special, in that puppet master will interpolate each agent node's
+ environment instead of its own.
+* Multiple values should be specified as comma-separated lists; multiple
+ directories should be separated with the system path separator (usually
+ a colon).
+* Settings that take a single file or directory can optionally set the owner,
+ group, and mode for their value: `rundir = $vardir/run { owner = puppet,
+ group = puppet, mode = 644 }`
+* The Puppet executables will ignore any setting that isn't relevant to
+ their function.
+
+See the [configuration guide][confguide] for more details.
+
+[confguide]: http://docs.puppetlabs.com/guides/configuring.html
+
+* * *
+
+EOT