Skip to content

Latest commit

 

History

History
155 lines (112 loc) · 4.39 KB

JOBS.md

File metadata and controls

155 lines (112 loc) · 4.39 KB

Recover Jobs

Instead of just recovering a backup to a target (default), you can write your own scripts and assign them to individual targets which then will be called when the worker processes a job.

class MyCustomRecoverJob < Barmaid::Job::RecoverJob

  # the constructor is necessary
  def initialize(uuid = nil, options = {})
    super(uuid, options)
    @log.info('Hello from MyCustomRecoverJob')
  end

  def before_recover
    @log.info("before recover")
  end

  def recover
    super # for debugging your script comment this and no recover will be executed
  end

  def after_recover
    @log.info("after recover")
  end

end

Put this in a file "my_custom_recover_job.rb", drop that file in the jobs directory and assign it to a target, e.g.

:jobs: '/var/lib/barman/barmaid/jobs'
:servers:
  :backup1:
    :targets:
      :localhost:
        :path: '/var/lib/barman/recover/backup1',
        :recover_job_name: 'MyCustomRecoverJob'

Note: :recover_job_name: has to be the name of the class.

Start barmaid!

barman@localhost $ ./bin/rackup

Start a worker!

barman@localhost $ ./bin/rake resque:work

Create a new recover job by the api!

barman@localhost $ curl -v -X POST -d '{"server":"backup1","target":"localhost","backup_id":"20130327T154109"}' http://localhost:9292/api/recover_jobs

{"job_id":"3575aa60ddd35cc1dffcd6454aa20657"}

After a few seconds the worker should log to stdout:

INFO RecoverJob: Trying to instantiate MyCustomRecoverJob
INFO RecoverJob: Hello from MyCustomRecoverJob
INFO RecoverJob: Recovering backup 20130327T154109 for backup1 (options: {"time":1364402347,"status":"queued","server":"backup1","target":"localhost","backup_id":"20130327T154109","recover_opts":{}}}
INFO RecoverJob: before recover
INFO RecoverJob: 5% of Backup 20130327T154109 (backup1) recovered
INFO RecoverJob: 48% of Backup 20130327T154109 (backup1) recovered
INFO RecoverJob: 92% of Backup 20130327T154109 (backup1) recovered
INFO RecoverJob: 100% of Backup 20130327T154109 (backup1) recovered
INFO RecoverJob: after recover
INFO RecoverJob: Recover of backup 20130327T154109 for backup1 (uuid 3575aa60ddd35cc1dffcd6454aa20657) finished

\o/

Several attributes are accessable in the scripts like

  • @backup : the backup which should be recovered
  • @recover_opts : the options like remote ssh command or timestamp
  • @log : a logger (.info,.error,.warn,.debug)
  • @path : the path (from configuration)
  • @uuid : the job's uuid
  • @options : everything you've passed to the post params as hash

Please look at the documentation of 'RecoverJob' if you want to get more details!

A possible use case could be to recover a backup to a staging database server:

  • stop postgresql
  • delete old database
  • start recovery
  • modify the archive command
  • start postgresql
  • rename the database
class RecoverJobXYZStaging < Barmaid::Job::RecoverJob

  def initialize(uuid = nil, options = {})
    super(uuid, options)
  end

  def before_recover
    @log.info("Stopping PostgreSQL on #{@options[:target]}")
    exec_command("/etc/init.d/postgresql stop", {:abort_on_error => true})

    if target_path_exists?
      @log.info("deleting #{@path} on #{@options[:target]}")
      delete_target_path 
    end

    create_target_path
  end

  def recover
    super
  end

  def after_recover
    @log.info("Modifying #{@options[:target]}'s archive_command")
    cmd = "echo \"#!/bin/sh\n/bin/true\" > #{@path}/archive_command.sh"
    exec_command(cmd, {:abort_on_error => true})

    # deleting unused files, debian reads them from /etc/postgresql/*
    exec_command("cd #{@path} && rm postgresql.conf\* pg_hba.conf pg_ident.conf", {:abort_on_error => true})

    @log.info("Starting PostgreSQL on #{@options[:target]}")
    exec_command("/etc/init.d/postgresql start", {:abort_on_error => true})

    @log.info("Waiting max 60 minutes until postgresql is started up")
    pg_started = false
    for i in 1..60
      result = exec_command("echo \"select 1\" | psql")
      pg_started = result.succeeded?
      break if pg_started
      @log.info("PostgreSQL reports \"#{result.stderr}\", waiting..")
      sleep(60)
    end

    if !pg_started
      raise "PostgreSQL did not start up within 60 minutes!"
    else
      @log.info("Renaming database on #{@options[:target]}")
      exec_command("echo \'alter database beer_production rename to beer_staging\' | psql"), {:abort_on_error => true})
    end
  end
end