manager.rb 6.85 KB
Newer Older
1 2
module Backup
  class Manager
3 4 5
    ARCHIVES_TO_BACKUP = %w[uploads builds artifacts pages lfs registry].freeze
    FOLDERS_TO_BACKUP = %w[repositories db].freeze
    FILE_NAME_SUFFIX = '_gitlab_backup.tar'.freeze
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

Vinnie Okada's avatar
Vinnie Okada committed
20 21 22
      Dir.chdir(Gitlab.config.backup.path) do
        File.open("#{Gitlab.config.backup.path}/backup_information.yml",
                  "w+") do |file|
23
          file << s.to_yaml.gsub(/^---\n/, '')
Vinnie Okada's avatar
Vinnie Okada committed
24 25 26 27
        end

        # create archive
        $progress.print "Creating backup archive: #{tar_file} ... "
28
        # Set file permissions on open to prevent chmod races.
29
        tar_system_options = { out: [tar_file, 'w', Gitlab.config.backup.archive_permissions] }
30
        if Kernel.system('tar', '-cf', '-', *backup_contents, tar_system_options)
31
          $progress.puts "done".color(:green)
Vinnie Okada's avatar
Vinnie Okada committed
32
        else
33
          puts "creating archive #{tar_file} failed".color(:red)
Vinnie Okada's avatar
Vinnie Okada committed
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
                                multipart_chunk_size: Gitlab.config.backup.upload.multipart_chunk_size,
54 55
                                encryption: Gitlab.config.backup.upload.encryption,
                                storage_class: Gitlab.config.backup.upload.storage_class)
56
        $progress.puts "done".color(:green)
57
      else
58
        puts "uploading backup to #{remote_directory} failed".color(:red)
59
        abort 'Backup failed'
60 61 62 63
      end
    end

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

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

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

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

      if keep_time > 0
        removed = 0
85

86
        Dir.chdir(Gitlab.config.backup.path) do
87
          Dir.glob("*#{FILE_NAME_SUFFIX}").each do |file|
88 89 90 91 92 93 94
            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)
95
                removed += 1
96 97
              rescue => e
                $progress.puts "Deleting #{file} failed: #{e.message}".color(:red)
98
              end
99 100 101
            end
          end
        end
102

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

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

      # check for existing backups in the backup dir
113 114 115 116 117 118 119
      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
120

121
      if file_list.count > 1 && ENV["BACKUP"].nil?
122 123
        $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'
124 125 126
        exit 1
      end

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

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

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

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

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

149 150
      # restoring mismatching backups can lead to unexpected problems
      if settings[:gitlab_version] != Gitlab::VERSION
151 152 153 154 155 156
        $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]}"
157
        exit 1
158 159
      end
    end
160 161

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

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

    private

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    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

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

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

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

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

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