Class: Puppet::Application::Filebucket

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

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_ENV, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::PUPPET_STACK_INSERTION_FRAME, Util::RFC_3986_URI_REGEX

Constants included from Util::SymbolicFileMode

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

Constants included from Util::POSIX

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

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, #main, #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, 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, safe_posix_fork, set_env, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::POSIX

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

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#argsObject (readonly)

Returns the value of attribute args


13
14
15
# File 'lib/puppet/application/filebucket.rb', line 13

def args
  @args
end

Instance Method Details

#backupObject


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/puppet/application/filebucket.rb', line 220

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") % { file: file }
      next
    end
    unless FileTest.readable?(file)
      $stderr.puts _("%{file}: cannot read file") % { file: file }
      next
    end
    md5 = @client.backup(file)
    puts "#{file}: #{md5}"
  end
end

#diffObject

Raises:


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

def diff
  raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>") unless args.count == 2
  left = args.shift
  right = args.shift
  if Puppet::FileSystem.exist?(left)
    # It's a file
    file_a = left
    checksum_a = nil
  else
    file_a = nil
    checksum_a = left
  end
  if Puppet::FileSystem.exist?(right)
    # It's a file
    file_b = right
    checksum_b = nil
  else
    file_b = nil
    checksum_b = right
  end
  if (checksum_a || file_a) && (checksum_b || file_b)
    Puppet.info(_("Comparing %{checksum_a} %{checksum_b} %{file_a} %{file_b}") % { checksum_a: checksum_a, checksum_b: checksum_b, file_a: file_a, file_b: file_b })
    print @client.diff(checksum_a, checksum_b, file_a, file_b)
  else
    raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>")
  end
end

#getObject


214
215
216
217
218
# File 'lib/puppet/application/filebucket.rb', line 214

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

#helpObject


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

def help
  <<-HELP

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

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>]
[-f|--fromdate <date>] [-t|--todate <date>] [-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.

diff:
Print a diff in unified format between two checksums in the filebucket
or between a checksum and its matching file.

list:
List all files in the current local filebucket. Listing remote
filebuckets is not allowed.

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', or by specifying
'--bucket' with a local path.

> **Note**: Enabling and using the backup option, and by extension the 
filebucket resource, requires appropriate planning and management to ensure 
that sufficient disk space is available for the file backups. Generally, you 
can implement this using one of the following two options:
- Use a `find` command and `crontab` entry to retain only the last X days 
of file backups. For example: 

```shell
find /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm
```

- Restrict the directory to a maximum size after which the oldest items are removed.


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'.

* --bucket:
Specify a local filebucket path. This overrides the default path
set in '$clientbucketdir'.

* --debug:
Enable full debugging.

* --fromdate:
(list only) Select bucket files from 'fromdate'.

* --help:
Print this help message.

* --local:
Use the local filebucket. This uses the default configuration
information and the bucket located at the '$clientbucketdir'
setting by default. If '--bucket' is set, puppet uses that
path instead.

* --remote:
Use a remote filebucket. This uses the default configuration
information and the bucket located at the '$bucketdir' setting
by default.

* --server_list:
A list of comma separated servers; only the first entry is used for file storage.
This setting takes precidence over `server`.

* --server:
The server to use for file storage. This setting is only used if `server_list`
is not set.

* --todate:
(list only) Select bucket files until 'todate'.

* --verbose:
Print extra information.

* --version:
Print version information.

EXAMPLES
--------
  ## Backup a file to the filebucket, then restore it to a temporary directory
  $ puppet filebucket backup /etc/passwd
  /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
  $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949

  ## Diff between two files in the filebucket
  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
  1a2
  > again

  ## Diff between the file in the filebucket and a local file
  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
  1a2
  > again

  ## Backup a file to the filebucket and observe that it keeps each backup separate
  $ puppet filebucket -l list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile

  $ echo again >> /tmp/TestFile

  $ puppet filebucket -l backup /tmp/TestFile
  /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef

  $ puppet filebucket -l list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile

  ## List files in a filebucket within date ranges
  $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list
  <Empty Output>

  $ puppet filebucket -l -f 2015-05-10 list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile

  $ puppet filebucket -l -f "2015-05-11 09:30:00" list
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile

  $ puppet filebucket -l -t "2015-05-11 09:30:00" list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  ## Manage files in a specific local filebucket
  $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
  /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
  $ puppet filebucket -b /tmp/TestBucket list
  d41d8cd98f00b204e9800998ecf8427e 2015-05-11 09:33:22 /tmp/TestFile2

  ## From a Puppet master, list files in the master bucketdir
  $ puppet filebucket -b $(puppet config print bucketdir --section master) list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile

AUTHOR
------
Luke Kanies


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

  HELP
end

#listObject


237
238
239
240
241
242
# File 'lib/puppet/application/filebucket.rb', line 237

def list
  fromdate = options[:fromdate]
  todate = options[:todate]
  out = @client.list(fromdate, todate)
  print out
end

#restoreObject


244
245
246
247
248
# File 'lib/puppet/application/filebucket.rb', line 244

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

#run_commandObject


207
208
209
210
211
212
# File 'lib/puppet/application/filebucket.rb', line 207

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

#setupObject


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/puppet/application/filebucket.rb', line 278

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[:clientbucketdir]
      @client = Puppet::FileBucket::Dipper.new(:Path => path)
    else
      session = Puppet.lookup(:http_session)
      api = session.route_to(:puppet)

      @client = Puppet::FileBucket::Dipper.new(Server: api.url.host, Port: api.url.port)
    end
  rescue => detail
    Puppet.log_exception(detail)
    exit(1)
  end
end

#summaryObject


15
16
17
# File 'lib/puppet/application/filebucket.rb', line 15

def summary
  _("Store and retrieve files in a filebucket")
end