summaryrefslogtreecommitdiff
path: root/lib/tasks/gitlab/backup.rake
blob: 422d44e6f2dc66e7adb5a779d2f22e1f6c276add (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
require 'active_record/fixtures'

namespace :gitlab do
  namespace :backup do
    # Create backup of GitLab system
    desc "GitLab | Create a backup of the GitLab system"
    task create: :gitlab_environment do
      warn_user_is_not_gitlab

      Rake::Task["gitlab:backup:db:create"].invoke
      Rake::Task["gitlab:backup:repo:create"].invoke
      Rake::Task["gitlab:backup:uploads:create"].invoke
      Rake::Task["gitlab:backup:builds:create"].invoke
      Rake::Task["gitlab:backup:artifacts:create"].invoke
      Rake::Task["gitlab:backup:pages:create"].invoke
      Rake::Task["gitlab:backup:lfs:create"].invoke
      Rake::Task["gitlab:backup:registry:create"].invoke

      backup = Backup::Manager.new(progress)
      backup.pack
      backup.cleanup
      backup.remove_old
    end

    # Restore backup of GitLab system
    desc 'GitLab | Restore a previously created backup'
    task restore: :gitlab_environment do
      warn_user_is_not_gitlab

      backup = Backup::Manager.new(progress)
      backup.unpack

      unless backup.skipped?('db')
        begin
          unless ENV['force'] == 'yes'
            warning = <<-MSG.strip_heredoc
              Before restoring the database, we will remove all existing
              tables to avoid future upgrade problems. Be aware that if you have
              custom tables in the GitLab database these tables and all data will be
              removed.
            MSG
            puts warning.color(:red)
            ask_to_continue
            puts 'Removing all tables. Press `Ctrl-C` within 5 seconds to abort'.color(:yellow)
            sleep(5)
          end

          # Drop all tables Load the schema to ensure we don't have any newer tables
          # hanging out from a failed upgrade
          progress.puts 'Cleaning the database ... '.color(:blue)
          Rake::Task['gitlab:db:drop_tables'].invoke
          progress.puts 'done'.color(:green)
          Rake::Task['gitlab:backup:db:restore'].invoke
        rescue Gitlab::TaskAbortedByUserError
          puts "Quitting...".color(:red)
          exit 1
        end
      end

      Rake::Task['gitlab:backup:repo:restore'].invoke unless backup.skipped?('repositories')
      Rake::Task['gitlab:backup:uploads:restore'].invoke unless backup.skipped?('uploads')
      Rake::Task['gitlab:backup:builds:restore'].invoke unless backup.skipped?('builds')
      Rake::Task['gitlab:backup:artifacts:restore'].invoke unless backup.skipped?('artifacts')
      Rake::Task["gitlab:backup:pages:restore"].invoke unless backup.skipped?('pages')
      Rake::Task['gitlab:backup:lfs:restore'].invoke unless backup.skipped?('lfs')
      Rake::Task['gitlab:backup:registry:restore'].invoke unless backup.skipped?('registry')
      Rake::Task['gitlab:shell:setup'].invoke
      Rake::Task['cache:clear'].invoke

      backup.cleanup
    end

    namespace :repo do
      task create: :gitlab_environment do
        progress.puts _("Dumping repositories ...").color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("repositories")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Repository.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts _("Restoring repositories ...").color(:blue)
        Backup::Repository.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :db do
      task create: :gitlab_environment do
        progress.puts "Dumping database ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("db")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Database.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring database ... ".color(:blue)
        Backup::Database.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :builds do
      task create: :gitlab_environment do
        progress.puts "Dumping builds ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("builds")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Builds.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring builds ... ".color(:blue)
        Backup::Builds.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :uploads do
      task create: :gitlab_environment do
        progress.puts "Dumping uploads ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("uploads")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Uploads.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring uploads ... ".color(:blue)
        Backup::Uploads.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :artifacts do
      task create: :gitlab_environment do
        progress.puts "Dumping artifacts ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("artifacts")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Artifacts.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring artifacts ... ".color(:blue)
        Backup::Artifacts.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :pages do
      task create: :gitlab_environment do
        progress.puts "Dumping pages ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("pages")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Pages.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring pages ... ".color(:blue)
        Backup::Pages.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :lfs do
      task create: :gitlab_environment do
        progress.puts "Dumping lfs objects ... ".color(:blue)

        if ENV["SKIP"] && ENV["SKIP"].include?("lfs")
          progress.puts "[SKIPPED]".color(:cyan)
        else
          Backup::Lfs.new(progress).dump
          progress.puts "done".color(:green)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring lfs objects ... ".color(:blue)
        Backup::Lfs.new(progress).restore
        progress.puts "done".color(:green)
      end
    end

    namespace :registry do
      task create: :gitlab_environment do
        progress.puts "Dumping container registry images ... ".color(:blue)

        if Gitlab.config.registry.enabled
          if ENV["SKIP"] && ENV["SKIP"].include?("registry")
            progress.puts "[SKIPPED]".color(:cyan)
          else
            Backup::Registry.new(progress).dump
            progress.puts "done".color(:green)
          end
        else
          progress.puts "[DISABLED]".color(:cyan)
        end
      end

      task restore: :gitlab_environment do
        progress.puts "Restoring container registry images ... ".color(:blue)

        if Gitlab.config.registry.enabled
          Backup::Registry.new(progress).restore
          progress.puts "done".color(:green)
        else
          progress.puts "[DISABLED]".color(:cyan)
        end
      end
    end

    def progress
      if ENV['CRON']
        # We need an object we can say 'puts' and 'print' to; let's use a
        # StringIO.
        require 'stringio'
        StringIO.new
      else
        $stdout
      end
    end
  end # namespace end: backup
end # namespace end: gitlab