File: resource.rb

package info (click to toggle)
puppet-agent 8.10.0-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,404 kB
  • sloc: ruby: 286,820; sh: 492; xml: 116; makefile: 88; cs: 68
file content (262 lines) | stat: -rw-r--r-- 8,041 bytes parent folder | download | duplicates (2)
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
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
# frozen_string_literal: true

require_relative '../../puppet/application'

class Puppet::Application::Resource < Puppet::Application
  environment_mode :not_required

  attr_accessor :host, :extra_params

  def preinit
    @extra_params = [:provider]
  end

  option("--debug", "-d")
  option("--verbose", "-v")
  option("--edit", "-e")
  option("--to_yaml", "-y")
  option('--fail', '-f')

  option("--types", "-t") do |_arg|
    env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment
    types = []
    Puppet::Type.typeloader.loadall(env)
    Puppet::Type.eachtype do |t|
      next if t.name == :component

      types << t.name.to_s
    end
    puts types.sort
    exit(0)
  end

  option("--param PARAM", "-p") do |arg|
    @extra_params << arg.to_sym
  end

  def summary
    _("The resource abstraction layer shell")
  end

  def help
    <<~HELP

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

      SYNOPSIS
      --------
      Uses the Puppet RAL to directly interact with the system.


      USAGE
      -----
      puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
        [-p|--param <parameter>] [-t|--types] [-y|--to_yaml] <type>
        [<name>] [<attribute>=<value> ...]


      DESCRIPTION
      -----------
      This command provides simple facilities for converting current system
      state into Puppet code, along with some ability to modify the current
      state using Puppet's RAL.

      By default, you must at least provide a type to list, in which case
      puppet resource will tell you everything it knows about all resources of
      that type. You can optionally specify an instance name, and puppet
      resource will only describe that single instance.

      If given a type, a name, and a series of <attribute>=<value> pairs,
      puppet resource will modify the state of the specified resource.
      Alternately, if given a type, a name, and the '--edit' flag, puppet
      resource will write its output to a file, open that file in an editor,
      and then apply the saved file as a Puppet transaction.


      OPTIONS
      -------
      Note that any setting that's valid in the configuration
      file is also a valid long argument. For example, 'ssldir' is a valid
      setting, so you can specify '--ssldir <directory>' as an
      argument.

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

      * --debug:
        Enable full debugging.

      * --edit:
        Write the results of the query to a file, open the file in an editor,
        and read the file back in as an executable Puppet manifest.

      * --help:
        Print this help message.

      * --param:
        Add more parameters to be outputted from queries.

      * --types:
        List all available types.

      * --verbose:
        Print extra information.

      * --to_yaml:
        Output found resources in yaml format, suitable to use with Hiera and
        create_resources.

      * --fail:
        Fails and returns an exit code of 1 if the resource could not be modified.

      EXAMPLE
      -------
      This example uses `puppet resource` to return a Puppet configuration for
      the user `luke`:

          $ puppet resource user luke
          user { 'luke':
           home => '/home/luke',
           uid => '100',
           ensure => 'present',
           comment => 'Luke Kanies,,,',
           gid => '1000',
           shell => '/bin/bash',
           groups => ['sysadmin','audio','video','puppet']
          }


      AUTHOR
      ------
      Luke Kanies


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

    HELP
  end

  def main
    # If the specified environment does not exist locally, fall back to the default (production) environment
    env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment

    Puppet.override(
      current_environment: env,
      loaders: Puppet::Pops::Loaders.new(env),
      stringify_rich: true
    ) do
      type, name, params = parse_args(command_line.args)

      raise _("Editing with Yaml output is not supported") if options[:edit] and options[:to_yaml]

      resources = find_or_save_resources(type, name, params)

      if options[:to_yaml]
        data = resources.map do |resource|
          resource.prune_parameters(:parameters_to_include => @extra_params).to_hiera_hash
        end.inject(:merge!)
        text = YAML.dump(type.downcase => data)
      else
        text = resources.map do |resource|
          resource.prune_parameters(:parameters_to_include => @extra_params).to_manifest.force_encoding(Encoding.default_external)
        end.join("\n")
      end

      options[:edit] ?
        handle_editing(text) :
        (puts text)
    end
  end

  def setup
    Puppet::Util::Log.newdestination(:console)
    set_log_level
  end

  private

  def local_key(type, name)
    [type, name].join('/')
  end

  def handle_editing(text)
    require 'tempfile'
    # Prefer the current directory, which is more likely to be secure
    # and, in the case of interactive use, accessible to the user.
    tmpfile = Tempfile.new('x2puppet', Dir.pwd, :encoding => Encoding::UTF_8)
    begin
      # sync write, so nothing buffers before we invoke the editor.
      tmpfile.sync = true
      tmpfile.puts text

      # edit the content
      system(ENV.fetch("EDITOR", nil) || 'vi', tmpfile.path)

      # ...and, now, pass that file to puppet to apply.  Because
      # many editors rename or replace the original file we need to
      # feed the pathname, not the file content itself, to puppet.
      system('puppet apply -v ' + tmpfile.path)
    ensure
      # The temporary file will be safely removed.
      tmpfile.close(true)
    end
  end

  def parse_args(args)
    type = args.shift or raise _("You must specify the type to display")
    Puppet::Type.type(type) or raise _("Could not find type %{type}") % { type: type }
    name = args.shift
    params = {}
    args.each do |setting|
      if setting =~ /^(\w+)=(.+)$/
        params[::Regexp.last_match(1)] = ::Regexp.last_match(2)
      else
        raise _("Invalid parameter setting %{setting}") % { setting: setting }
      end
    end

    [type, name, params]
  end

  def create_default_environment
    Puppet.debug("Specified environment '#{Puppet[:environment]}' does not exist on the filesystem, defaulting to 'production'")
    Puppet[:environment] = :production
    basemodulepath = Puppet::Node::Environment.split_path(Puppet[:basemodulepath])
    modulepath = Puppet[:modulepath]
    modulepath = (modulepath.nil? || modulepath.empty?) ? basemodulepath : Puppet::Node::Environment.split_path(modulepath)
    Puppet::Node::Environment.create(Puppet[:environment], modulepath, Puppet::Node::Environment::NO_MANIFEST)
  end

  def find_or_save_resources(type, name, params)
    key = local_key(type, name)

    Puppet.override(stringify_rich: true) do
      if name
        if params.empty?
          [Puppet::Resource.indirection.find(key)]
        else
          resource = Puppet::Resource.new(type, name, :parameters => params)

          # save returns [resource that was saved, transaction log from applying the resource]
          save_result, report = Puppet::Resource.indirection.save(resource, key)
          status = report.resource_statuses[resource.ref]
          raise "Failed to manage resource #{resource.ref}" if status&.failed? && options[:fail]

          [save_result]
        end
      else
        if type == "file"
          raise _("Listing all file instances is not supported.  Please specify a file or directory, e.g. puppet resource file /etc")
        end

        Puppet::Resource.indirection.search(key, {})
      end
    end
  end
end