BigW Consortium Gitlab

manager.rb 7.11 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_')}#{s[:gitlab_version]}#{FILE_NAME_SUFFIX}"
19

20 21
      Dir.chdir(backup_path) do
        File.open("#{backup_path}/backup_information.yml", "w+") do |file|
22
          file << s.to_yaml.gsub(/^---\n/, '')
23 24 25 26
        end

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

        upload(tar_file)
37
      end
38 39 40
    end

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

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

49
      directory = connect_to_remote_directory(connection_settings)
50

51
      if directory.files.create(key: tar_file, body: File.open(tar_file), public: false,
52
                                multipart_chunk_size: Gitlab.config.backup.upload.multipart_chunk_size,
53 54
                                encryption: Gitlab.config.backup.upload.encryption,
                                storage_class: Gitlab.config.backup.upload.storage_class)
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
      backup_contents.each do |dir|
66
        next unless File.exist?(File.join(backup_path, dir))
67

68
        if FileUtils.rm_rf(File.join(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 86
        Dir.chdir(backup_path) do
          backup_file_list.each do |file|
87 88 89 90 91
            # For backward compatibility, there are 3 names the backups can have:
            # - 1495527122_gitlab_backup.tar
            # - 1495527068_2017_05_23_gitlab_backup.tar
            # - 1495527097_2017_05_23_9.3.0-pre_gitlab_backup.tar
            next unless file =~ /(\d+)(?:_\d{4}_\d{2}_\d{2}(_\d+\.\d+\.\d+.*)?)?_gitlab_backup\.tar$/
92 93 94 95 96 97

            timestamp = $1.to_i

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

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

    def unpack
113
      Dir.chdir(backup_path)
114 115

      # check for existing backups in the backup dir
116 117
      if backup_file_list.empty?
        $progress.puts "No backups found in #{backup_path}"
118 119
        $progress.puts "Please make sure that file name ends with #{FILE_NAME_SUFFIX}"
        exit 1
120
      elsif backup_file_list.many? && 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
      tar_file = if ENV['BACKUP'].present?
                   "#{ENV['BACKUP']}#{FILE_NAME_SUFFIX}"
                 else
129
                   backup_file_list.first
130
                 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

    def tar_version
161
      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
    def backup_path
      Gitlab.config.backup.path
    end

    def backup_file_list
      @backup_file_list ||= Dir.glob("*#{FILE_NAME_SUFFIX}")
    end

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    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

196
    def backup_contents
197
      folders_to_backup + archives_to_backup + ["backup_information.yml"]
198 199
    end

200
    def archives_to_backup
Kamil Trzcinski committed
201
      ARCHIVES_TO_BACKUP.map{ |name| (name + ".tar.gz") unless skipped?(name) }.compact
202
    end
203

204
    def folders_to_backup
Kamil Trzcinski committed
205
      FOLDERS_TO_BACKUP.reject{ |name| skipped?(name) }
206 207 208 209 210 211
    end

    def disabled_features
      features = []
      features << 'registry' unless Gitlab.config.registry.enabled
      features
212 213 214 215 216
    end

    def settings
      @settings ||= YAML.load_file("backup_information.yml")
    end
217 218
  end
end