Uploads migrate Rake tasks

There is a Rake task for migrating uploads between different storage types.

Migrate to object storage

After configuring the object storage for GitLab’s uploads, use this task to migrate existing uploads from the local storage to the remote storage.

All of the processing is done in a background worker and requires no downtime.

Read more about using object storage with GitLab.

All-in-one Rake task

GitLab provides a wrapper Rake task that migrates all uploaded files (for example avatars, logos, attachments, and favicon) to object storage in one step. The wrapper task invokes individual Rake tasks to migrate files falling under each of these categories one by one.

These individual Rake tasks are described in the next section.

To migrate all uploads from local storage to object storage, run:

Omnibus Installation

gitlab-rake "gitlab:uploads:migrate:all"

Source Installation

sudo RAILS_ENV=production -u git -H bundle exec rake gitlab:uploads:migrate:all

Individual Rake tasks

If you already ran the all-in-one Rake task, there is no need to run these individual tasks.

The Rake task uses three parameters to find uploads to migrate:

Parameter Type Description
uploader_class string Type of the uploader to migrate from.
model_class string Type of the model to migrate from.
mount_point string/symbol Name of the model’s column the uploader is mounted on.
Note: These parameters are mainly internal to GitLab’s structure, you may want to refer to the task list instead below.

This task also accepts an environment variable which you can use to override the default batch size:

Variable Type Description
BATCH integer Specifies the size of the batch. Defaults to 200.

The following shows how to run gitlab:uploads:migrate for individual types of uploads.

Omnibus Installation

# gitlab-rake gitlab:uploads:migrate[uploader_class, model_class, mount_point]

# Avatars
gitlab-rake "gitlab:uploads:migrate[AvatarUploader, Project, :avatar]"
gitlab-rake "gitlab:uploads:migrate[AvatarUploader, Group, :avatar]"
gitlab-rake "gitlab:uploads:migrate[AvatarUploader, User, :avatar]"

# Attachments
gitlab-rake "gitlab:uploads:migrate[AttachmentUploader, Note, :attachment]"
gitlab-rake "gitlab:uploads:migrate[AttachmentUploader, Appearance, :logo]"
gitlab-rake "gitlab:uploads:migrate[AttachmentUploader, Appearance, :header_logo]"

# Favicon
gitlab-rake "gitlab:uploads:migrate[FaviconUploader, Appearance, :favicon]"

# Markdown
gitlab-rake "gitlab:uploads:migrate[FileUploader, Project]"
gitlab-rake "gitlab:uploads:migrate[PersonalFileUploader, Snippet]"
gitlab-rake "gitlab:uploads:migrate[NamespaceFileUploader, Snippet]"
gitlab-rake "gitlab:uploads:migrate[FileUploader, MergeRequest]"

# Design Management design thumbnails
gitlab-rake "gitlab:uploads:migrate[DesignManagement::DesignV432x230Uploader, DesignManagement::Action, :image_v432x230]"

Source Installation

Use RAILS_ENV=production for every task.

# sudo -u git -H bundle exec rake gitlab:uploads:migrate

# Avatars
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AvatarUploader, Project, :avatar]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AvatarUploader, Group, :avatar]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AvatarUploader, User, :avatar]"

# Attachments
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AttachmentUploader, Note, :attachment]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AttachmentUploader, Appearance, :logo]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[AttachmentUploader, Appearance, :header_logo]"

# Favicon
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[FaviconUploader, Appearance, :favicon]"

# Markdown
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[FileUploader, Project]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[PersonalFileUploader, Snippet]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[NamespaceFileUploader, Snippet]"
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[FileUploader, MergeRequest]"

# Design Management design thumbnails
sudo -u git -H bundle exec rake "gitlab:uploads:migrate[DesignManagement::DesignV432x230Uploader, DesignManagement::Action]"

Migrate to local storage

If you need to disable object storage for any reason, you must first migrate your data out of object storage and back into your local storage.

Warning: Extended downtime is required so no new files are created in object storage during the migration. A configuration setting is planned to allow migrating from object storage to local files with only a brief moment of downtime for configuration changes. To follow progress, see the relevant issue.

All-in-one Rake task

GitLab provides a wrapper Rake task that migrates all uploaded files (for example, avatars, logos, attachments, and favicon) to local storage in one step. The wrapper task invokes individual Rake tasks to migrate files falling under each of these categories one by one.

For details on these Rake tasks, refer to Individual Rake tasks, keeping in mind the task name in this case is gitlab:uploads:migrate_to_local.

To migrate uploads from object storage to local storage:

  1. Disable both direct_upload and background_upload under uploads settings in gitlab.rb:

    gitlab_rails['uploads_object_store_direct_upload'] = false
    gitlab_rails['uploads_object_store_background_upload'] = false
    

    Save the file and reconfigure GitLab.

  2. Run the Rake task:

    Omnibus Installation

    gitlab-rake "gitlab:uploads:migrate_to_local:all"
    

    Source Installation

    sudo RAILS_ENV=production -u git -H bundle exec rake gitlab:uploads:migrate_to_local:all
    

After running the Rake task, you can disable object storage by undoing the changes described in the instructions to configure object storage.