Class: Puppet::Application::Resource

Inherits:
Puppet::Application show all
Defined in:
lib/puppet/application/resource.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 collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], #app_defaults, 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, restart!, restart_requested?, #run, #run_command, 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 Attribute Details

#extra_params ⇒ Object 



8
9
10
 
# File 'lib/puppet/application/resource.rb', line 8

def extra_params
  @extra_params
end

#host ⇒ Object 



8
9
10
 
# File 'lib/puppet/application/resource.rb', line 8

def host
  @host
end

Instance Method Details

#help ⇒ Object 



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
 
# File 'lib/puppet/application/resource.rb', line 41

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

#main ⇒ Object 



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
 
# File 'lib/puppet/application/resource.rb', line 145

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

#preinit ⇒ Object 



10
11
12
 
# File 'lib/puppet/application/resource.rb', line 10

def preinit
  @extra_params = [:provider]
end

#setup ⇒ Object 



177
178
179
180
 
# File 'lib/puppet/application/resource.rb', line 177

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

#summary ⇒ Object 



37
38
39
 
# File 'lib/puppet/application/resource.rb', line 37

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