1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc => "A reference for all configuration parameters") do
docs = {}
Puppet.settings.each do |name, object|
docs[name] = object
end
str = ""
docs.sort { |a, b|
a[0].to_s <=> b[0].to_s
}.each do |name, object|
# Make each name an anchor
header = name.to_s
str += h(header, 3)
# Print the doc string itself
begin
str += object.desc.gsub(/\n/, " ")
rescue => detail
puts detail.backtrace
puts detail
end
str += "\n\n"
# Now print the data about the item.
str += ""
val = object.default
if name.to_s == "vardir"
val = "/var/lib/puppet"
elsif name.to_s == "confdir"
val = "/etc/puppet"
end
# Leave out the section information; it was apparently confusing people.
#str += "- **Section**: %s\n" % object.section
unless val == ""
str += "- **Default**: %s\n" % val
end
str += "\n"
end
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``, or
``user`` sections.
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 parameters (e.g., reset the mode or owner), do
so within curly braces on the same line::
[main]
myfile = /tmp/whatever {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 agent --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.
"
|
