BigW Consortium Gitlab

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

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

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

19 20 21 22 23 24 25 26
      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} ... "
27 28 29
        # 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)
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 53
          multipart_chunk_size: Gitlab.config.backup.upload.multipart_chunk_size,
          encryption: Gitlab.config.backup.upload.encryption)
54
        $progress.puts "done".color(:green)
55
      else
56
        puts "uploading backup to #{remote_directory} failed".color(:red)
57
        abort 'Backup failed'
58 59 60 61
      end
    end

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

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

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

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

      if keep_time > 0
        removed = 0
83

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

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

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

      # check for existing backups in the backup dir
111
      file_list = Dir.glob("*_gitlab_backup.tar")
112
      puts "no backups found" if file_list.count == 0
113

114 115 116 117 118 119
      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

120
      tar_file = ENV["BACKUP"].nil? ? file_list.first : file_list.grep(ENV['BACKUP']).first
121

122
      unless File.exist?(tar_file)
123 124 125 126
        puts "The specified backup doesn't exist!"
        exit 1
      end

127
      $progress.print "Unpacking backup ... "
128

129
      unless Kernel.system(*%W(tar -xf #{tar_file}))
130
        puts "unpacking backup failed".color(:red)
131 132
        exit 1
      else
133
        $progress.puts "done".color(:green)
134 135 136 137
      end

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

138 139
      # restoring mismatching backups can lead to unexpected problems
      if settings[:gitlab_version] != Gitlab::VERSION
140 141 142 143
        puts "GitLab version mismatch:".color(:red)
        puts "  Your current GitLab version (#{Gitlab::VERSION}) differs from the GitLab version in the backup!".color(:red)
        puts "  Please switch to the following version and try again:".color(:red)
        puts "  version: #{settings[:gitlab_version]}".color(:red)
144 145 146
        puts
        puts "Hint: git checkout v#{settings[:gitlab_version]}"
        exit 1
147 148
      end
    end
149 150 151

    def tar_version
      tar_version, _ = Gitlab::Popen.popen(%W(tar --version))
152
      tar_version.force_encoding('locale').split("\n").first
153
    end
154 155

    def skipped?(item)
Kamil Trzcinski committed
156
      settings[:skipped] && settings[:skipped].include?(item) || disabled_features.include?(item)
157 158 159 160
    end

    private

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
    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

178
    def backup_contents
179
      folders_to_backup + archives_to_backup + ["backup_information.yml"]
180 181
    end

182
    def archives_to_backup
Kamil Trzcinski committed
183
      ARCHIVES_TO_BACKUP.map{ |name| (name + ".tar.gz") unless skipped?(name) }.compact
184
    end
185

186
    def folders_to_backup
Kamil Trzcinski committed
187
      FOLDERS_TO_BACKUP.reject{ |name| skipped?(name) }
188 189 190 191 192 193
    end

    def disabled_features
      features = []
      features << 'registry' unless Gitlab.config.registry.enabled
      features
194 195 196 197 198
    end

    def settings
      @settings ||= YAML.load_file("backup_information.yml")
    end
199 200
  end
end