Class: Puppet::Application::Filebucket

Inherits:

Puppet::Application

• Object
• Puppet::Application
• Puppet::Application::Filebucket

Defined in:

lib/puppet/application/filebucket.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

• #args ⇒ Object readonly

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary

• #backup ⇒ Object
• #diff ⇒ Object
• #digest_algorithm ⇒ Object
• #get ⇒ Object
• #help ⇒ Object
• #list ⇒ Object
• #restore ⇒ Object
• #run_command ⇒ Object
• #setup ⇒ Object
• #summary ⇒ Object

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, 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

#args ⇒ Object (readonly)

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

def args
  @args
end

Instance Method Details

#backup ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 226

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
    digest = @client.backup(file)
    puts "#{file}: #{digest}"
  end
end

#diff ⇒ Object

Raises:

• (Puppet::Error)

# File 'lib/puppet/application/filebucket.rb', line 256

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

#digest_algorithm ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 21

def digest_algorithm
  Puppet.default_digest_algorithm
end

#get ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 220

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

#help ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 25

def help
  "\npuppet-filebucket(8) -- \#{summary}\n========\n\nSYNOPSIS\n--------\nA stand-alone Puppet filebucket client.\n\n\nUSAGE\n-----\npuppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]\n[-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]\n[-f|--fromdate <date>] [-t|--todate <date>] [-b|--bucket <directory>]\n<file> <file> ...\n\nPuppet filebucket can operate in three modes, with only one mode per call:\n\nbackup:\nSend one or more files to the specified file bucket. Each sent file is\nprinted with its resulting \#{digest_algorithm} sum.\n\nget:\nReturn the text associated with an \#{digest_algorithm} sum. The text is printed to\nstdout, and only one file can be retrieved at a time.\n\nrestore:\nGiven a file path and an \#{digest_algorithm} sum, store the content associated with\nthe sum into the specified file path. You can specify an entirely new\npath to this argument; you are not restricted to restoring the content\nto its original location.\n\ndiff:\nPrint a diff in unified format between two checksums in the filebucket\nor between a checksum and its matching file.\n\nlist:\nList all files in the current local filebucket. Listing remote\nfilebuckets is not allowed.\n\nDESCRIPTION\n-----------\nThis is a stand-alone filebucket client for sending files to a local or\ncentral filebucket.\n\nNote that 'filebucket' defaults to using a network-based filebucket\navailable on the server named 'puppet'. To use this, you'll have to be\nrunning as a user with valid Puppet certificates. Alternatively, you can\nuse your local file bucket by specifying '--local', or by specifying\n'--bucket' with a local path.\n\n> **Note**: Enabling and using the backup option, and by extension the \nfilebucket resource, requires appropriate planning and management to ensure \nthat sufficient disk space is available for the file backups. Generally, you \ncan implement this using one of the following two options:\n- Use a `find` command and `crontab` entry to retain only the last X days \nof file backups. For example: \n\n```shell\nfind /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm\n```\n\n- Restrict the directory to a maximum size after which the oldest items are removed.\n\n\nOPTIONS\n-------\nNote that any setting that's valid in the configuration\nfile is also a valid long argument. For example, 'ssldir' is a valid\nsetting, so you can specify '--ssldir <directory>' as an\nargument.\n\nSee the configuration file documentation at\nhttps://puppet.com/docs/puppet/latest/configuration.html for the\nfull list of acceptable parameters. A commented list of all\nconfiguration options can also be generated by running puppet with\n'--genconfig'.\n\n* --bucket:\nSpecify a local filebucket path. This overrides the default path\nset in '$clientbucketdir'.\n\n* --debug:\nEnable full debugging.\n\n* --fromdate:\n(list only) Select bucket files from 'fromdate'.\n\n* --help:\nPrint this help message.\n\n* --local:\nUse the local filebucket. This uses the default configuration\ninformation and the bucket located at the '$clientbucketdir'\nsetting by default. If '--bucket' is set, puppet uses that\npath instead.\n\n* --remote:\nUse a remote filebucket. This uses the default configuration\ninformation and the bucket located at the '$bucketdir' setting\nby default.\n\n* --server_list:\nA list of comma separated servers; only the first entry is used for file storage.\nThis setting takes precidence over `server`.\n\n* --server:\nThe server to use for file storage. This setting is only used if `server_list`\nis not set.\n\n* --todate:\n(list only) Select bucket files until 'todate'.\n\n* --verbose:\nPrint extra information.\n\n* --version:\nPrint version information.\n\nEXAMPLES\n--------\n  ## Backup a file to the filebucket, then restore it to a temporary directory\n  $ puppet filebucket backup /etc/passwd\n  /etc/passwd: 429b225650b912a2ee067b0a4cf1e949\n  $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949\n\n  ## Diff between two files in the filebucket\n  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef\n  1a2\n  > again\n\n  ## Diff between the file in the filebucket and a local file\n  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile\n  1a2\n  > again\n\n  ## Backup a file to the filebucket and observe that it keeps each backup separate\n  $ puppet filebucket -l list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n\n  $ echo again >> /tmp/TestFile\n\n  $ puppet filebucket -l backup /tmp/TestFile\n  /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef\n\n  $ puppet filebucket -l list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n\n  ## List files in a filebucket within date ranges\n  $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list\n  <Empty Output>\n\n  $ puppet filebucket -l -f 2015-05-10 list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n\n  $ puppet filebucket -l -f \"2015-05-11 09:30:00\" list\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n\n  $ puppet filebucket -l -t \"2015-05-11 09:30:00\" list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  ## Manage files in a specific local filebucket\n  $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2\n  /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e\n  $ puppet filebucket -b /tmp/TestBucket list\n  d41d8cd98f00b204e9800998ecf8427e 2015-05-11 09:33:22 /tmp/TestFile2\n\n  ## From a Puppet Server, list files in the server bucketdir\n  $ puppet filebucket -b $(puppet config print bucketdir --section server) list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n\nAUTHOR\n------\nLuke Kanies\n\n\nCOPYRIGHT\n---------\nCopyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License\n\n  HELP\nend\n"

#list ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 243

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

#restore ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 250

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

#run_command ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 213

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

#setup ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 284

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

#summary ⇒ Object

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

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