Class: Puppet::Application::Device

Inherits:
Puppet::Application show all
Defined in:
lib/vendor/puppet/application/device.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Instance Attribute Summary collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], banner, clear!, clear?, #configure_indirector_routes, controlled_run, exit, find, #handlearg, #initialize, interrupted?, #name, option, option_parser_commands, #parse_options, restart!, restart_requested?, #run, #run_command, run_mode, #set_run_mode, #setup_logs, should_not_parse_config, should_parse_config, #should_parse_config?, should_parse_config?, stop!, stop_requested?

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

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

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#agent ⇒ Object

Returns the value of attribute agent.



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

def agent
  @agent
end

#args ⇒ Object

Returns the value of attribute args.



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

def args
  @args
end

#host ⇒ Object

Returns the value of attribute host.



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

def host
  @host
end

Instance Method Details

#help ⇒ Object 



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
 
# File 'lib/vendor/puppet/application/device.rb', line 59

def help
  <<-'HELP'

puppet-device(8) -- Manage remote network devices
========

SYNOPSIS
--------
Retrieves all configurations from the puppet master and apply
them to the remote devices configured in /etc/puppet/device.conf.

Currently must be run out periodically, using cron or something similar.

USAGE
-----
  puppet device [-d|--debug] [--detailed-exitcodes] [-V|--version]
            [-h|--help] [-l|--logdest syslog|<file>|console]
            [-v|--verbose] [-w|--waitforcert <seconds>]


DESCRIPTION
-----------
Once the client has a signed certificate for a given remote device, it will 
retrieve its configuration and apply it.

USAGE NOTES
-----------
One need a /etc/puppet/device.conf file with the following content:

[remote.device.fqdn]
type <type>
url <url>

where:
 * type: the current device type (the only value at this time is cisco)
 * url: an url allowing to connect to the device

Supported url must conforms to:
 scheme://user:password@hostname/?query

 with:
  * scheme: either ssh or telnet
  * user: username, can be omitted depending on the switch/router configuration
  * password: the connection password
  * query: this is device specific. Cisco devices supports an enable parameter whose
  value would be the enable password.

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

* --debug:
  Enable full debugging.

* --detailed-exitcodes:
  Provide transaction information via exit codes. If this is enabled, an exit
  code of '2' means there were changes, an exit code of '4' means there were
  failures during the transaction, and an exit code of '6' means there were both
  changes and failures.

* --help:
  Print this help message

* --logdest:
  Where to send messages.  Choose between syslog, the console, and a log file.
  Defaults to sending messages to syslog, or the console if debugging or
  verbosity is enabled.

* --verbose:
  Turn on verbose reporting.

* --waitforcert:
  This option only matters for daemons that do not yet have certificates
  and it is enabled by default, with a value of 120 (seconds).  This causes
  +puppet agent+ to connect to the server every 2 minutes and ask it to sign a
  certificate request.  This is useful for the initial setup of a puppet
  client.  You can turn off waiting for certificates by specifying a time
  of 0.

EXAMPLE
-------
  $ puppet device --server puppet.domain.com

AUTHOR
------
Brice Figureau


COPYRIGHT
---------
Copyright (c) 2011 Puppet Labs, LLC 
Licensed under the Apache 2.0 License
  HELP
end

#main ⇒ Object 



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
 
# File 'lib/vendor/puppet/application/device.rb', line 157

def main
  vardir = Puppet[:vardir]
  confdir = Puppet[:confdir]
  certname = Puppet[:certname]

  # find device list
  require 'puppet/util/network_device/config'
  devices = Puppet::Util::NetworkDevice::Config.devices
  if devices.empty?
    Puppet.err "No device found in #{Puppet[:deviceconfig]}"
    exit(1)
  end
  devices.each_value do |device|
    begin
      Puppet.info "starting applying configuration to #{device.name} at #{device.url}"

      # override local $vardir and $certname
      Puppet.settings.set_value(:confdir, ::File.join(Puppet[:devicedir], device.name), :cli)
      Puppet.settings.set_value(:vardir, ::File.join(Puppet[:devicedir], device.name), :cli)
      Puppet.settings.set_value(:certname, device.name, :cli)

      # this will reload and recompute default settings and create the devices sub vardir, or we hope so :-)
      Puppet.settings.use :main, :agent, :ssl

      # this init the device singleton, so that the facts terminus
      # and the various network_device provider can use it
      Puppet::Util::NetworkDevice.init(device)

      # ask for a ssl cert if needed, but at least
      # setup the ssl system for this device.
      setup_host

      require 'puppet/configurer'
      configurer = Puppet::Configurer.new
      report = configurer.run(:network_device => true)
    rescue => detail
      puts detail.backtrace if Puppet[:trace]
      Puppet.err detail.to_s
    ensure
      Puppet.settings.set_value(:vardir, vardir, :cli)
      Puppet.settings.set_value(:confdir, confdir, :cli)
      Puppet.settings.set_value(:certname, certname, :cli)
      Puppet::SSL::Host.reset
    end
  end
end

#preinit ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/vendor/puppet/application/device.rb', line 12

def preinit
  # Do an initial trap, so that cancels don't get a stack trace.
  Signal.trap(:INT) do
    $stderr.puts "Cancelling startup"
    exit(0)
  end

  {
    :waitforcert => nil,
    :detailed_exitcodes => false,
    :verbose => false,
    :debug => false,
    :centrallogs => false,
    :setdest => false,
  }.each do |opt,val|
    options[opt] = val
  end

  @args = {}
end

#setup ⇒ Object 



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
 
# File 'lib/vendor/puppet/application/device.rb', line 210

def setup
  setup_logs

  args[:Server] = Puppet[:server]
  if options[:centrallogs]
    logdest = args[:Server]

    logdest += ":" + args[:Port] if args.include?(:Port)
    Puppet::Util::Log.newdestination(logdest)
  end

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

  # Always ignoreimport for agent. It really shouldn't even try to import,
  # but this is just a temporary band-aid.
  Puppet[:ignoreimport] = true

  # We need to specify a ca location for all of the SSL-related i
  # indirected classes to work; in fingerprint mode we just need
  # access to the local files and we don't need a ca.
  Puppet::SSL::Host.ca_location = :remote

  Puppet::Transaction::Report.indirection.terminus_class = :rest

  # Override the default; puppetd needs this, usually.
  # You can still override this on the command-line with, e.g., :compiler.
  Puppet[:catalog_terminus] = :rest

  Puppet[:facts_terminus] = :network_device

  Puppet::Resource::Catalog.indirection.cache_class = :yaml
end

#setup_host ⇒ Object 



204
205
206
207
208
 
# File 'lib/vendor/puppet/application/device.rb', line 204

def setup_host
  @host = Puppet::SSL::Host.new
  waitforcert = options[:waitforcert] || (Puppet[:onetime] ? 0 : 120)
  cert = @host.wait_for_cert(waitforcert)
end