Class: Puppet::Application::Apply

Inherits:
Puppet::Application show all
Includes:
Util::Splayer
Defined in:
lib/puppet/application/apply.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Instance Attribute Summary

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods included from Util::Splayer

#splay, #splayed?

Methods inherited from Puppet::Application

[], available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, #deprecate, #deprecated?, environment_mode, exit, find, get_environment_mode, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #name, option, option_parser_commands, #parse_options, #preinit, restart!, restart_requested?, #run, run_mode, #set_log_level, #setup_logs, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Method Details

#app_defaults ⇒ Object 



174
175
176
177
178
179
 
# File 'lib/puppet/application/apply.rb', line 174

def app_defaults
  super.merge({
                :default_file_terminus => :file_server,
                :write_catalog_summary => false
              })
end

#apply ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/puppet/application/apply.rb', line 194

def apply
  if options[:catalog] == "-"
    text = $stdin.read
  else
    text = Puppet::FileSystem.read(options[:catalog], :encoding => 'utf-8')
  end
  env = Puppet.lookup(:environments).get(Puppet[:environment])
  Puppet.override(:current_environment => env, :loaders => create_loaders(env)) do
    catalog = read_catalog(text)
    apply_catalog(catalog)
  end
end

#help ⇒ Object 



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/puppet/application/apply.rb', line 42

def help
  <<~HELP

    puppet-apply(8) -- #{summary}
    ========

    SYNOPSIS
    --------
    Applies a standalone Puppet manifest to the local system.


    USAGE
    -----
    puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
      [-e|--execute] [--detailed-exitcodes] [-L|--loadclasses]
      [-l|--logdest syslog|eventlog|<ABS FILEPATH>|console] [--noop]
      [--catalog <catalog>] [--write-catalog-summary] <file>


    DESCRIPTION
    -----------
    This is the standalone puppet execution tool; use it to apply
    individual manifests.

    When provided with a modulepath, via command line or config file, puppet
    apply can effectively mimic the catalog that would be served by puppet
    master with access to the same modules, although there are some subtle
    differences. When combined with scheduling and an automated system for
    pushing manifests, this can be used to implement a serverless Puppet
    site.

    Most users should use 'puppet agent' and 'puppet master' for site-wide
    manifests.


    OPTIONS
    -------
    Any setting that's valid in the configuration
    file is a valid long argument for puppet apply. For example, 'tags' is a
    valid setting, so you can specify '--tags <class>,<tag>'
    as an argument.

    See the configuration file documentation at
    https://puppet.com/docs/puppet/latest/configuration.html for the
    full list of acceptable parameters. You can generate a commented list of all
    configuration options by running puppet with
    '--genconfig'.

    * --debug:
      Enable full debugging.

    * --detailed-exitcodes:
      Provide extra information about the run via exit codes. If enabled, 'puppet
      apply' will use the following exit codes:

      0: The run succeeded with no changes or failures; the system was already in
      the desired state.

      1: The run failed.

      2: The run succeeded, and some resources were changed.

      4: The run succeeded, and some resources failed.

      6: The run succeeded, and included both changes and failures.

    * --help:
      Print this help message

    * --loadclasses:
      Load any stored classes. 'puppet agent' caches configured classes
      (usually at /etc/puppetlabs/puppet/classes.txt), and setting this option causes
      all of those classes to be set in your puppet manifest.

    * --logdest:
      Where to send log messages. Choose between 'syslog' (the POSIX syslog
      service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
      file. Defaults to 'console'.
      Multiple destinations can be set using a comma separated list
      (eg: `/path/file1,console,/path/file2`)"

      A path ending with '.json' will receive structured output in JSON format. The
      log file will not have an ending ']' automatically written to it due to the
      appending nature of logging. It must be appended manually to make the content
      valid JSON.

      A path ending with '.jsonl' will receive structured output in JSON Lines
      format.

    * --noop:
      Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This
      is useful for seeing what changes Puppet will make without actually
      executing the changes.

    * --execute:
      Execute a specific piece of Puppet code

    * --test:
      Enable the most common options used for testing. These are 'verbose',
      'detailed-exitcodes' and 'show_diff'.

    * --verbose:
      Print extra information.

    * --catalog:
      Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
      either specify a JSON file or pipe in JSON from standard input.

    * --write-catalog-summary
      After compiling the catalog saves the resource list and classes list to the node
      in the state directory named classes.txt and resources.txt

    EXAMPLE
    -------
        $ puppet apply -e 'notify { "hello world": }'
        $ puppet apply -l /tmp/manifest.log manifest.pp
        $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
        $ puppet apply --catalog catalog.json


    AUTHOR
    ------
    Luke Kanies


    COPYRIGHT
    ---------
    Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License

  HELP
end

#main ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/puppet/application/apply.rb', line 207

def main
  # rubocop:disable Layout/ExtraSpacing
  manifest          = get_manifest() # Get either a manifest or nil if apply should use content of Puppet[:code]
  splay                              # splay if needed
  facts             = get_facts()    # facts or nil
  node              = get_node()     # node or error
  apply_environment = get_configured_environment(node, manifest)
  # rubocop:enable Layout/ExtraSpacing

  # TRANSLATORS "puppet apply" is a program command and should not be translated
  Puppet.override({ :current_environment => apply_environment, :loaders => create_loaders(apply_environment) }, _("For puppet apply")) do
    configure_node_facts(node, facts)

    # Allow users to load the classes that puppet agent creates.
    if options[:loadclasses]
      file = Puppet[:classfile]
      if Puppet::FileSystem.exist?(file)
        unless FileTest.readable?(file)
          $stderr.puts _("%{file} is not readable") % { file: file }
          exit(63)
        end
        node.classes = Puppet::FileSystem.read(file, :encoding => 'utf-8').split(/\s+/)
      end
    end

    begin
      # Compile the catalog
      starttime = Time.now

      # When compiling, the compiler traps and logs certain errors
      # Those that do not lead to an immediate exit are caught by the general
      # rule and gets logged.
      #
      catalog =
        begin
          Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
        rescue Puppet::Error
          # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
          exit(1)
        end

      # Resolve all deferred values and replace them / mutate the catalog
      Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, catalog, apply_environment, Puppet[:preprocess_deferred])

      # Translate it to a RAL catalog
      catalog = catalog.to_ral

      catalog.finalize

      catalog.retrieval_duration = Time.now - starttime

      # We accept either the global option `--write_catalog_summary`
      # corresponding to the new setting, or the application option
      # `--write-catalog-summary`. The latter is needed to maintain backwards
      # compatibility.
      #
      # Puppet settings parse global options using PuppetOptionParser, but it
      # only recognizes underscores, not dashes.
      # The base application parses app specific options using ruby's builtin
      # OptionParser. As of ruby 2.4, it will accept either underscores or
      # dashes, but prefer dashes.
      #
      # So if underscores are used, the PuppetOptionParser will parse it and
      # store that in Puppet[:write_catalog_summary]. If dashes are used,
      # OptionParser will parse it, and set Puppet[:write_catalog_summary]. In
      # either case, settings will contain the correct value.
      if Puppet[:write_catalog_summary]
        catalog.write_class_file
        catalog.write_resource_file
      end

      exit_status = apply_catalog(catalog)

      if !exit_status
        exit(1)
      elsif options[:detailed_exitcodes] then
        exit(exit_status)
      else
        exit(0)
      end
    rescue => detail
      Puppet.log_exception(detail)
      exit(1)
    end
  end
end

#run_command ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/puppet/application/apply.rb', line 181

def run_command
  if options[:catalog]
    apply
  else
    main
  end
ensure
  if @profiler
    Puppet::Util::Profiler.remove_profiler(@profiler)
    @profiler.shutdown
  end
end

#setup ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/puppet/application/apply.rb', line 302

def setup
  setup_test if options[:test]

  exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?

  handle_logdest_arg(Puppet[:logdest])
  Puppet::Util::Log.newdestination(:console) unless options[:setdest]

  Signal.trap(:INT) do
    $stderr.puts _("Exiting")
    exit(1)
  end

  Puppet.settings.use :main, :agent, :ssl

  if Puppet[:catalog_cache_terminus]
    Puppet::Resource::Catalog.indirection.cache_class = Puppet[:catalog_cache_terminus]
  end

  # we want the last report to be persisted locally
  Puppet::Transaction::Report.indirection.cache_class = :yaml

  set_log_level

  if Puppet[:profile]
    @profiler = Puppet::Util::Profiler.add_profiler(Puppet::Util::Profiler::Aggregate.new(Puppet.method(:info), "apply"))
  end
end

#setup_test ⇒ Object

Enable all of the most common test options.



295
296
297
298
299
300
 
# File 'lib/puppet/application/apply.rb', line 295

def setup_test
  Puppet.settings.handlearg("--no-splay")
  Puppet.settings.handlearg("--show_diff")
  options[:verbose] = true
  options[:detailed_exitcodes] = true
end

#summary ⇒ Object 



38
39
40
 
# File 'lib/puppet/application/apply.rb', line 38

def summary
  _("Apply Puppet manifests locally")
end