Class: Puppet::Application::Filebucket

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

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN, SHOULD_PARSE_CONFIG_DEPRECATION_MSG

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

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, exit, find, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #main, #name, option, option_parser_commands, #parse_options, #preinit, restart!, restart_requested?, #run, run_mode, #set_log_level, #setup_logs, should_not_parse_config, should_parse_config, should_parse_config?, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, deterministic_rand, execfail, execpipe, execute, exit_on_fail, logmethods, memory, path_to_uri, pretty_backtrace, proxy, replace_file, safe_posix_fork, symbolizehash, thinmark, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

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

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#args ⇒ Object (readonly) 



11
12
13
 
# File 'lib/puppet/application/filebucket.rb', line 11

def args
  @args
end

Instance Method Details

#backup ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/puppet/application/filebucket.rb', line 128

def backup
  raise "You must specify a file to back up" unless args.length > 0

  args.each do |file|
    unless Puppet::FileSystem.exist?(file)
      $stderr.puts "#{file}: no such file"
      next
    end
    unless FileTest.readable?(file)
      $stderr.puts "#{file}: cannot read file"
      next
    end
    md5 = @client.backup(file)
    puts "#{file}: #{md5}"
  end
end

#get ⇒ Object 



122
123
124
125
126
 
# File 'lib/puppet/application/filebucket.rb', line 122

def get
  md5 = args.shift
  out = @client.getfile(md5)
  print out
end

#help ⇒ Object 



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

def help
  <<-'HELP'

puppet-filebucket(8) -- Store and retrieve files in a filebucket
========

SYNOPSIS
--------
A stand-alone Puppet filebucket client.


USAGE
-----
puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]
[-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]
[-b|--bucket <directory>] <file> <file> ...

Puppet filebucket can operate in three modes, with only one mode per call:

backup:
Send one or more files to the specified file bucket. Each sent file is
printed with its resulting md5 sum.

get:
Return the text associated with an md5 sum. The text is printed to
stdout, and only one file can be retrieved at a time.

restore:
Given a file path and an md5 sum, store the content associated with
the sum into the specified file path. You can specify an entirely new
path to this argument; you are not restricted to restoring the content
to its original location.


DESCRIPTION
-----------
This is a stand-alone filebucket client for sending files to a local or
central filebucket.

Note that 'filebucket' defaults to using a network-based filebucket
available on the server named 'puppet'. To use this, you'll have to be
running as a user with valid Puppet certificates. Alternatively, you can
use your local file bucket by specifying '--local'.


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
http://docs.puppetlabs.com/references/stable/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.

* --help:
Print this help message

* --local:
Use the local filebucket. This will use the default configuration
information.

* --remote:
Use a remote filebucket. This will use the default configuration
information.

* --server:
The server to send the file to, instead of locally.

* --verbose:
Print extra information.

* --version:
Print version information.


EXAMPLE
-------
  $ puppet filebucket backup /etc/passwd
  /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
  $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949


AUTHOR
------
Luke Kanies


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

  HELP
end

#restore ⇒ Object 



145
146
147
148
149
 
# File 'lib/puppet/application/filebucket.rb', line 145

def restore
  file = args.shift
  md5 = args.shift
  @client.restore(file, md5)
end

#run_command ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/puppet/application/filebucket.rb', line 115

def run_command
  @args = command_line.args
  command = args.shift
  return send(command) if %w{get backup restore}.include? command
  help
end

#setup ⇒ Object 



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

def setup
  Puppet::Log.newdestination(:console)

  @client = nil
  @server = nil

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

  if options[:debug]
    Puppet::Log.level = :debug
  elsif options[:verbose]
    Puppet::Log.level = :info
  end

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

  require 'puppet/file_bucket/dipper'
  begin
    if options[:local] or options[:bucket]
      path = options[:bucket] || Puppet[:bucketdir]
      @client = Puppet::FileBucket::Dipper.new(:Path => path)
    else
      @client = Puppet::FileBucket::Dipper.new(:Server => Puppet[:server])
    end
  rescue => detail
    Puppet.log_exception(detail)
    exit(1)
  end
end