@@ -40,133 +40,133 @@ def summary
4040 end
4141
4242 def help
43- <<- HELP
44-
45- puppet-apply(8) -- #{ summary }
46- ========
47-
48- SYNOPSIS
49- --------
50- Applies a standalone Puppet manifest to the local system.
51-
52-
53- USAGE
54- -----
55- puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
56- [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
57- [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
58- [--catalog <catalog>] [--write-catalog-summary] <file>
59-
60-
61- DESCRIPTION
62- -----------
63- This is the standalone puppet execution tool; use it to apply
64- individual manifests.
65-
66- When provided with a modulepath, via command line or config file, puppet
67- apply can effectively mimic the catalog that would be served by puppet
68- master with access to the same modules, although there are some subtle
69- differences. When combined with scheduling and an automated system for
70- pushing manifests, this can be used to implement a serverless Puppet
71- site.
72-
73- Most users should use 'puppet agent' and 'puppet master' for site-wide
74- manifests.
75-
76-
77- OPTIONS
78- -------
79- Any setting that's valid in the configuration
80- file is a valid long argument for puppet apply. For example, 'tags' is a
81- valid setting, so you can specify '--tags <class>,<tag>'
82- as an argument.
83-
84- See the configuration file documentation at
85- https://puppet.com/docs/puppet/latest/configuration.html for the
86- full list of acceptable parameters. You can generate a commented list of all
87- configuration options by running puppet with
88- '--genconfig'.
89-
90- * --debug:
91- Enable full debugging.
92-
93- * --detailed-exitcodes:
94- Provide extra information about the run via exit codes. If enabled, 'puppet
95- apply' will use the following exit codes:
96-
97- 0: The run succeeded with no changes or failures; the system was already in
98- the desired state.
99-
100- 1: The run failed.
101-
102- 2: The run succeeded, and some resources were changed.
103-
104- 4: The run succeeded, and some resources failed.
105-
106- 6: The run succeeded, and included both changes and failures.
107-
108- * --help:
109- Print this help message
110-
111- * --loadclasses:
112- Load any stored classes. 'puppet agent' caches configured classes
113- (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
114- all of those classes to be set in your puppet manifest.
115-
116- * --logdest:
117- Where to send log messages. Choose between 'syslog' (the POSIX syslog
118- service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
119- file. Defaults to 'console'.
120- Multiple destinations can be set using a comma separated list
121- (eg: `/path/file1,console,/path/file2`)"
122-
123- A path ending with '.json' will receive structured output in JSON format. The
124- log file will not have an ending ']' automatically written to it due to the
125- appending nature of logging. It must be appended manually to make the content
126- valid JSON.
127-
128- A path ending with '.jsonl' will receive structured output in JSON Lines
129- format.
130-
131- * --noop:
132- Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
133- is useful for seeing what changes Puppet will make without actually
134- executing the changes.
135-
136- * --execute:
137- Execute a specific piece of Puppet code
138-
139- * --test:
140- Enable the most common options used for testing. These are 'verbose',
141- 'detailed-exitcodes' and 'show_diff'.
142-
143- * --verbose:
144- Print extra information.
145-
146- * --catalog:
147- Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
148- either specify a JSON file or pipe in JSON from standard input.
149-
150- * --write-catalog-summary
151- After compiling the catalog saves the resource list and classes list to the node
152- in the state directory named classes.txt and resources.txt
153-
154- EXAMPLE
155- -------
156- $ puppet apply -l /tmp/manifest.log manifest.pp
157- $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
158- $ puppet apply --catalog catalog.json
159-
160-
161- AUTHOR
162- ------
163- Luke Kanies
164-
165-
166- COPYRIGHT
167- ---------
168- Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
169-
43+ <<~ HELP
44+
45+ puppet-apply(8) -- #{ summary }
46+ ========
47+
48+ SYNOPSIS
49+ --------
50+ Applies a standalone Puppet manifest to the local system.
51+
52+
53+ USAGE
54+ -----
55+ puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
56+ [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
57+ [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
58+ [--catalog <catalog>] [--write-catalog-summary] <file>
59+
60+
61+ DESCRIPTION
62+ -----------
63+ This is the standalone puppet execution tool; use it to apply
64+ individual manifests.
65+
66+ When provided with a modulepath, via command line or config file, puppet
67+ apply can effectively mimic the catalog that would be served by puppet
68+ master with access to the same modules, although there are some subtle
69+ differences. When combined with scheduling and an automated system for
70+ pushing manifests, this can be used to implement a serverless Puppet
71+ site.
72+
73+ Most users should use 'puppet agent' and 'puppet master' for site-wide
74+ manifests.
75+
76+
77+ OPTIONS
78+ -------
79+ Any setting that's valid in the configuration
80+ file is a valid long argument for puppet apply. For example, 'tags' is a
81+ valid setting, so you can specify '--tags <class>,<tag>'
82+ as an argument.
83+
84+ See the configuration file documentation at
85+ https://puppet.com/docs/puppet/latest/configuration.html for the
86+ full list of acceptable parameters. You can generate a commented list of all
87+ configuration options by running puppet with
88+ '--genconfig'.
89+
90+ * --debug:
91+ Enable full debugging.
92+
93+ * --detailed-exitcodes:
94+ Provide extra information about the run via exit codes. If enabled, 'puppet
95+ apply' will use the following exit codes:
96+
97+ 0: The run succeeded with no changes or failures; the system was already in
98+ the desired state.
99+
100+ 1: The run failed.
101+
102+ 2: The run succeeded, and some resources were changed.
103+
104+ 4: The run succeeded, and some resources failed.
105+
106+ 6: The run succeeded, and included both changes and failures.
107+
108+ * --help:
109+ Print this help message
110+
111+ * --loadclasses:
112+ Load any stored classes. 'puppet agent' caches configured classes
113+ (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
114+ all of those classes to be set in your puppet manifest.
115+
116+ * --logdest:
117+ Where to send log messages. Choose between 'syslog' (the POSIX syslog
118+ service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
119+ file. Defaults to 'console'.
120+ Multiple destinations can be set using a comma separated list
121+ (eg: `/path/file1,console,/path/file2`)"
122+
123+ A path ending with '.json' will receive structured output in JSON format. The
124+ log file will not have an ending ']' automatically written to it due to the
125+ appending nature of logging. It must be appended manually to make the content
126+ valid JSON.
127+
128+ A path ending with '.jsonl' will receive structured output in JSON Lines
129+ format.
130+
131+ * --noop:
132+ Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
133+ is useful for seeing what changes Puppet will make without actually
134+ executing the changes.
135+
136+ * --execute:
137+ Execute a specific piece of Puppet code
138+
139+ * --test:
140+ Enable the most common options used for testing. These are 'verbose',
141+ 'detailed-exitcodes' and 'show_diff'.
142+
143+ * --verbose:
144+ Print extra information.
145+
146+ * --catalog:
147+ Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
148+ either specify a JSON file or pipe in JSON from standard input.
149+
150+ * --write-catalog-summary
151+ After compiling the catalog saves the resource list and classes list to the node
152+ in the state directory named classes.txt and resources.txt
153+
154+ EXAMPLE
155+ -------
156+ $ puppet apply -l /tmp/manifest.log manifest.pp
157+ $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
158+ $ puppet apply --catalog catalog.json
159+
160+
161+ AUTHOR
162+ ------
163+ Luke Kanies
164+
165+
166+ COPYRIGHT
167+ ---------
168+ Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
169+
170170 HELP
171171 end
172172
0 commit comments