From 4bb08345473bb2b382ea6e2e03cf5b087ea4413e Mon Sep 17 00:00:00 2001 From: Ross McDonald Date: Wed, 18 Apr 2018 16:45:11 -0500 Subject: [PATCH] Update backups article. --- articles/enterprise/maintenance/backups.md | 27 +++++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/articles/enterprise/maintenance/backups.md b/articles/enterprise/maintenance/backups.md index 5c65c4a..593f9ae 100644 --- a/articles/enterprise/maintenance/backups.md +++ b/articles/enterprise/maintenance/backups.md @@ -1,8 +1,22 @@ -# GitLab Backup Procedures +# Backups -GitLab is a critical piece of the Stoplight Enterprise platform. Stoplight -recommends, at a minimum, daily backups of the GitLab database and filesystem to -ensure minimal data loss in the event of a failure. +Backups are a critical component to ensuring the health of the Stoplight +platform. When creating a backup and restore strategy for your on-premise +installation, be sure to include the following locations: + +* The **GitLab data directory**, which includes the raw filesystem data backing each projects git repository. +* The **GitLab configuration directory**, which includes randomly-generated secrets and keys necessary for securing the GitLab runtime. +* The **GitLab PostgreSQL database**, which includes user, group, permissions, and other relational data not included in the git repositories. +* The **Pubs data directory**, which includes published hubs and their corresponding configurations. + +Backing up all locations above will ensure you can properly restore a Stoplight +installation without data loss. + +## GitLab Backup Procedures + +GitLab is a critical piece of the Stoplight platform. Stoplight recommends, at a +minimum, daily backups of the GitLab database and filesystem to ensure minimal +data loss in the event of a failure. To run a backup for GitLab, which includes a snapshot of the filesystem and database, run the command: @@ -22,7 +36,7 @@ to cloud storage providers when configured. For more information, please see the official GitLab backup documentation [here](https://docs.gitlab.com/ce/raketasks/backup_restore.html). -# Pubs Backup Procedures +## Pubs Backup Procedures Pubs stores all published hubs created via the Stoplight application. While not critical to the health of the Stoplight Enterprise platform, it is recommended @@ -40,4 +54,5 @@ sudo tar -cvzf pubs-backup.$(date +%s).tar.gz /var/lib/pubs /etc/pubs ``` Once the backup is completed, the tarball output can be stored on redundant or -cloud storage. +cloud storage. To ensure you have a recent backup available at all times, +Stoplight recommends taking a backup daily.