Create a single document for understanding backups on GitLab.com
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
Currently, we don't have a single place where a user can understand how backups on GitLab.com works, or understand what a proper backup strategy looks like for a group or set of projects. If you try to google "How to backup on gitlab.com" or similar, you don't get very good results and it makes it a bit difficult to get all of the pieces of information you need.
We use this macro which gives the user a good idea of how everything works - However, it gives them many links and many pieces of information that they have to piece together. Some information is in our docs, others are in our handbook.
One way we could potentially solve this is by having a backup strategy page that is specific to GitLab.com. This would include what is done by our team (infrastructure) and what should be done by the user to keep their repositories safe.
Here are some links that we currently use:
Our docs:
- https://docs.gitlab.com/ee/user/project/settings/import_export.html
- https://docs.gitlab.com/ee/api/project_import_export.html#schedule-an-export
- https://docs.gitlab.com/ee/gitlab-basics/command-line-commands.html#clone-your-project
Handbook:
- https://about.gitlab.com/handbook/engineering/infrastructure/database/
- https://about.gitlab.com/handbook/engineering/infrastructure/production/#backups
Further details
This would be intended for a single user of GitLab, or an Owner of a GitLab Group on GitLab.com.
Things to do
-
Split up this issue into multiple issues / promote to epic -
Gather accurate data from the infrastructure team to best describe: -
Our filesystem backups -
Our database backups
-
-
Put together best practices for backing up your own data on GitLab.com -
Determine if legal approval is needed for documenting infrastructure backups in our docs