BigW Consortium Gitlab

manager.rb 6.67 KB
Newer Older
1 2
module Backup
  class Manager
Kamil Trzcinski committed
3
    ARCHIVES_TO_BACKUP = %w[uploads builds artifacts pages lfs registry]
Kamil Trzcinski committed
4
    FOLDERS_TO_BACKUP = %w[repositories db]
5
    FILE_NAME_SUFFIX = '_gitlab_backup.tar'
6

7
    def pack
8 9 10
      # Make sure there is a connection
      ActiveRecord::Base.connection.reconnect!

11 12 13 14
      # saving additional informations
      s = {}
      s[:db_version]         = "#{ActiveRecord::Migrator.current_version}"
      s[:backup_created_at]  = Time.now
15
      s[:gitlab_version]     = Gitlab::VERSION
16
      s[:tar_version]        = tar_version
17
      s[:skipped]            = ENV["SKIP"]
18
      tar_file = "#{s[:backup_created_at].strftime('%s_%Y_%m_%d')}#{FILE_NAME_SUFFIX}"
19

20 21 22 23 24 25 26 27
      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} ... "
28 29 30
        # 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)
31
          $progress.puts "done".color(:green)
32
        else
33
          puts "creating archive #{tar_file} failed".color(:red)
34 35 36 37
          abort 'Backup failed'
        end

        upload(tar_file)
38
      end
39 40 41
    end

    def upload(tar_file)
42
      $progress.print "Uploading backup archive to remote storage #{remote_directory} ... "
43 44 45

      connection_settings = Gitlab.config.backup.upload.connection
      if connection_settings.blank?
46
        $progress.puts "skipped".color(:yellow)
47 48 49
        return
      end

50
      directory = connect_to_remote_directory(connection_settings)
51

52
      if directory.files.create(key: tar_file, body: File.open(tar_file), public: false,
53 54
          multipart_chunk_size: Gitlab.config.backup.upload.multipart_chunk_size,
          encryption: Gitlab.config.backup.upload.encryption)
55
        $progress.puts "done".color(:green)
56
      else
57
        puts "uploading backup to #{remote_directory} failed".color(:red)
58
        abort 'Backup failed'
59 60 61 62
      end
    end

    def cleanup
63
      $progress.print "Deleting tmp directories ... "
64

65 66 67
      backup_contents.each do |dir|
        next unless File.exist?(File.join(Gitlab.config.backup.path, dir))

68
        if FileUtils.rm_rf(File.join(Gitlab.config.backup.path, dir))
69
          $progress.puts "done".color(:green)
70
        else
71
          puts "deleting tmp directory '#{dir}' failed".color(:red)
72 73
          abort 'Backup failed'
        end
74 75 76 77 78
      end
    end

    def remove_old
      # delete backups
79
      $progress.print "Deleting old backups ... "
80 81 82 83
      keep_time = Gitlab.config.backup.keep_time.to_i

      if keep_time > 0
        removed = 0
84

85
        Dir.chdir(Gitlab.config.backup.path) do
86
          Dir.glob("*#{FILE_NAME_SUFFIX}").each do |file|
87 88 89 90 91 92 93
            next unless file =~ /(\d+)(?:_\d{4}_\d{2}_\d{2})?_gitlab_backup\.tar/

            timestamp = $1.to_i

            if Time.at(timestamp) < (Time.now - keep_time)
              begin
                FileUtils.rm(file)
94
                removed += 1
95 96
              rescue => e
                $progress.puts "Deleting #{file} failed: #{e.message}".color(:red)
97
              end
98 99 100
            end
          end
        end
101

102
        $progress.puts "done. (#{removed} removed)".color(:green)
103
      else
104
        $progress.puts "skipping".color(:yellow)
105 106 107 108 109 110 111
      end
    end

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

      # check for existing backups in the backup dir
112 113 114 115 116 117 118
      file_list = Dir.glob("*#{FILE_NAME_SUFFIX}")

      if file_list.count == 0
        $progress.puts "No backups found in #{Gitlab.config.backup.path}"
        $progress.puts "Please make sure that file name ends with #{FILE_NAME_SUFFIX}"
        exit 1
      end
119

120
      if file_list.count > 1 && ENV["BACKUP"].nil?
121 122
        $progress.puts 'Found more than one backup, please specify which one you want to restore:'
        $progress.puts 'rake gitlab:backup:restore BACKUP=timestamp_of_backup'
123 124 125
        exit 1
      end

126 127 128 129 130
      if ENV['BACKUP'].present?
        tar_file = "#{ENV['BACKUP']}#{FILE_NAME_SUFFIX}"
      else
        tar_file = file_list.first
      end
131

132
      unless File.exist?(tar_file)
133
        $progress.puts "The backup file #{tar_file} does not exist!"
134 135 136
        exit 1
      end

137
      $progress.print 'Unpacking backup ... '
138

139
      unless Kernel.system(*%W(tar -xf #{tar_file}))
140
        $progress.puts 'unpacking backup failed'.color(:red)
141 142
        exit 1
      else
143
        $progress.puts 'done'.color(:green)
144 145 146 147
      end

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

148 149
      # restoring mismatching backups can lead to unexpected problems
      if settings[:gitlab_version] != Gitlab::VERSION
150 151 152 153 154 155
        $progress.puts 'GitLab version mismatch:'.color(:red)
        $progress.puts "  Your current GitLab version (#{Gitlab::VERSION}) differs from the GitLab version in the backup!".color(:red)
        $progress.puts '  Please switch to the following version and try again:'.color(:red)
        $progress.puts "  version: #{settings[:gitlab_version]}".color(:red)
        $progress.puts
        $progress.puts "Hint: git checkout v#{settings[:gitlab_version]}"
156
        exit 1
157 158
      end
    end
159 160 161

    def tar_version
      tar_version, _ = Gitlab::Popen.popen(%W(tar --version))
162
      tar_version.force_encoding('locale').split("\n").first
163
    end
164 165

    def skipped?(item)
Kamil Trzcinski committed
166
      settings[:skipped] && settings[:skipped].include?(item) || disabled_features.include?(item)
167 168 169 170
    end

    private

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    def connect_to_remote_directory(connection_settings)
      connection = ::Fog::Storage.new(connection_settings)

      # We only attempt to create the directory for local backups. For AWS
      # and other cloud providers, we cannot guarantee the user will have
      # permission to create the bucket.
      if connection.service == ::Fog::Storage::Local
        connection.directories.create(key: remote_directory)
      else
        connection.directories.get(remote_directory)
      end
    end

    def remote_directory
      Gitlab.config.backup.upload.remote_directory
    end

188
    def backup_contents
189
      folders_to_backup + archives_to_backup + ["backup_information.yml"]
190 191
    end

192
    def archives_to_backup
Kamil Trzcinski committed
193
      ARCHIVES_TO_BACKUP.map{ |name| (name + ".tar.gz") unless skipped?(name) }.compact
194
    end
195

196
    def folders_to_backup
Kamil Trzcinski committed
197
      FOLDERS_TO_BACKUP.reject{ |name| skipped?(name) }
198 199 200 201 202 203
    end

    def disabled_features
      features = []
      features << 'registry' unless Gitlab.config.registry.enabled
      features
204 205 206 207 208
    end

    def settings
      @settings ||= YAML.load_file("backup_information.yml")
    end
209 210
  end
end