BigW Consortium Gitlab

manager.rb 5.26 KB
Newer Older
1 2 3 4 5 6 7
module Backup
  class Manager
    def pack
      # saving additional informations
      s = {}
      s[:db_version]         = "#{ActiveRecord::Migrator.current_version}"
      s[:backup_created_at]  = Time.now
8
      s[:gitlab_version]     = Gitlab::VERSION
9
      s[:tar_version]        = tar_version
10
      s[:skipped]            = ENV["SKIP"]
11
      tar_file = "#{s[:backup_created_at].to_i}_gitlab_backup.tar"
12

13 14 15 16 17 18 19 20
      Dir.chdir(Gitlab.config.backup.path) do
        File.open("#{Gitlab.config.backup.path}/backup_information.yml",
                  "w+") do |file|
          file << s.to_yaml.gsub(/^---\n/,'')
        end

        # create archive
        $progress.print "Creating backup archive: #{tar_file} ... "
21 22 23
        # Set file permissions on open to prevent chmod races.
        tar_system_options = {out: [tar_file, 'w', Gitlab.config.backup.archive_permissions]}
        if Kernel.system('tar', '-cf', '-', *backup_contents, tar_system_options)
24 25 26 27 28 29 30
          $progress.puts "done".green
        else
          puts "creating archive #{tar_file} failed".red
          abort 'Backup failed'
        end

        upload(tar_file)
31
      end
32 33 34 35
    end

    def upload(tar_file)
      remote_directory = Gitlab.config.backup.upload.remote_directory
36
      $progress.print "Uploading backup archive to remote storage #{remote_directory} ... "
37 38 39

      connection_settings = Gitlab.config.backup.upload.connection
      if connection_settings.blank?
40
        $progress.puts "skipped".yellow
41 42 43 44 45
        return
      end

      connection = ::Fog::Storage.new(connection_settings)
      directory = connection.directories.get(remote_directory)
46

47
      if directory.files.create(key: tar_file, body: File.open(tar_file), public: false,
48
          multipart_chunk_size: Gitlab.config.backup.upload.multipart_chunk_size)
49
        $progress.puts "done".green
50
      else
51
        puts "uploading backup to #{remote_directory} failed".red
52
        abort 'Backup failed'
53 54 55 56
      end
    end

    def cleanup
57
      $progress.print "Deleting tmp directories ... "
58 59 60 61
      
      backup_contents.each do |dir|
        next unless File.exist?(File.join(Gitlab.config.backup.path, dir))

62 63 64 65 66 67
        if FileUtils.rm_rf(File.join(Gitlab.config.backup.path, dir))
          $progress.puts "done".green
        else
          puts "deleting tmp directory '#{dir}' failed".red
          abort 'Backup failed'
        end
68 69 70 71 72
      end
    end

    def remove_old
      # delete backups
73
      $progress.print "Deleting old backups ... "
74 75 76 77
      keep_time = Gitlab.config.backup.keep_time.to_i

      if keep_time > 0
        removed = 0
78
        
79 80 81 82 83 84 85 86
        Dir.chdir(Gitlab.config.backup.path) do
          file_list = Dir.glob('*_gitlab_backup.tar')
          file_list.map! { |f| $1.to_i if f =~ /(\d+)_gitlab_backup.tar/ }
          file_list.sort.each do |timestamp|
            if Time.at(timestamp) < (Time.now - keep_time)
              if Kernel.system(*%W(rm #{timestamp}_gitlab_backup.tar))
                removed += 1
              end
87 88 89
            end
          end
        end
90

91
        $progress.puts "done. (#{removed} removed)".green
92
      else
93
        $progress.puts "skipping".yellow
94 95 96 97 98 99 100 101 102
      end
    end

    def unpack
      Dir.chdir(Gitlab.config.backup.path)

      # check for existing backups in the backup dir
      file_list = Dir.glob("*_gitlab_backup.tar").each.map { |f| f.split(/_/).first.to_i }
      puts "no backups found" if file_list.count == 0
103

104 105 106 107 108 109 110 111 112 113 114 115 116
      if file_list.count > 1 && ENV["BACKUP"].nil?
        puts "Found more than one backup, please specify which one you want to restore:"
        puts "rake gitlab:backup:restore BACKUP=timestamp_of_backup"
        exit 1
      end

      tar_file = ENV["BACKUP"].nil? ? File.join("#{file_list.first}_gitlab_backup.tar") : File.join(ENV["BACKUP"] + "_gitlab_backup.tar")

      unless File.exists?(tar_file)
        puts "The specified backup doesn't exist!"
        exit 1
      end

117
      $progress.print "Unpacking backup ... "
118

119
      unless Kernel.system(*%W(tar -xf #{tar_file}))
120
        puts "unpacking backup failed".red
121 122
        exit 1
      else
123
        $progress.puts "done".green
124 125 126 127
      end

      ENV["VERSION"] = "#{settings[:db_version]}" if settings[:db_version].to_i > 0

128 129 130 131 132 133 134 135 136
      # restoring mismatching backups can lead to unexpected problems
      if settings[:gitlab_version] != Gitlab::VERSION
        puts "GitLab version mismatch:".red
        puts "  Your current GitLab version (#{Gitlab::VERSION}) differs from the GitLab version in the backup!".red
        puts "  Please switch to the following version and try again:".red
        puts "  version: #{settings[:gitlab_version]}".red
        puts
        puts "Hint: git checkout v#{settings[:gitlab_version]}"
        exit 1
137 138
      end
    end
139 140 141

    def tar_version
      tar_version, _ = Gitlab::Popen.popen(%W(tar --version))
142
      tar_version.force_encoding('locale').split("\n").first
143
    end
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

    def skipped?(item)
      settings[:skipped] && settings[:skipped].include?(item)
    end

    private

    def backup_contents
      folders_to_backup + ["backup_information.yml"]
    end

    def folders_to_backup
      folders = %w{repositories db uploads}

      if ENV["SKIP"]
        return folders.reject{ |folder| ENV["SKIP"].include?(folder) }
      end

      folders
    end

    def settings
      @settings ||= YAML.load_file("backup_information.yml")
    end
168 169
  end
end