Migration to Versioned Snippets

Introduced in GitLab 13.0.

In GitLab 13.0, GitLab Snippets are backed by Git repositories. This means that the snippet content will be stored in the repository and users can update it directly through Git.

Nevertheless, existing GitLab Snippets have to be migrated to this new functionality. For each snippet, a new repository is created and the snippet content is committed to the repository inside a file whose name is the file name used in the snippet as well.

GitLab performs this migration through a Background Migration automatically when the GitLab instance is upgrade to 13.0 or a higher version. However, if the migration fails for any of the snippets, they still need to be migrated individually.

The following Rake tasks will help with that process.

Migrate specific snippets to Git

In case you want to migrate a range of snippets, run the tasks as described below.

For Omnibus installations, run:

sudo gitlab-rake gitlab:snippets:migrate SNIPPET_IDS=1,2,3,4

For installations from source code, run:

bundle exec rake gitlab:snippets:migrate SNIPPET_IDS=1,2,3,4

There is a default limit (100) to the number of ids supported in the migration process. You can modify this limit by using the env variable LIMIT.

sudo gitlab-rake gitlab:snippets:migrate SNIPPET_IDS=1,2,3,4 LIMIT=50

For installations from source code, run:

bundle exec rake gitlab:snippets:migrate SNIPPET_IDS=1,2,3,4 LIMIT=50

Show whether the snippet background migration is running

In case you want to check the status of the snippet background migration, whether it is running or not, you can use the following task.

For Omnibus installations, run:

sudo gitlab-rake gitlab:snippets:migration_status

For installations from source code, run:

bundle exec rake gitlab:snippets:migration_status RAILS_ENV=production

List non-migrated snippets

With the following task, you can get the ids of all of the snippets that haven’t been migrated yet or failed to migrate.

For Omnibus installations, run:

sudo gitlab-rake gitlab:snippets:list_non_migrated

For installations from source code, run:

bundle exec rake gitlab:snippets:list_non_migrated RAILS_ENV=production

As the number of non-migrated snippets can be large, we limit by default the size of the number of ids returned to 100. You can modify this limit by using the env variable LIMIT.

sudo gitlab-rake gitlab:snippets:list_non_migrated LIMIT=200

For installations from source code, run:

bundle exec rake gitlab:snippets:list_non_migrated RAILS_ENV=production LIMIT=200