Data recovery and backups
This page provides an overview of the backup and restore options available for use with Bitbucket Data Center:
Questions? Check out FAQ - Data recovery and backup.
Bitbucket backup essentials
An effective backup strategy is essential:
- for avoiding data loss in the event of any system breakdown,
- for restoring Bitbucket after any system breakdown,
- as part of the Bitbucket upgrade process.
We highly recommend that you establish a data recovery plan that is aligned with your company's policies. At the very least, you should consider these aspects:
- How frequently should Bitbucket be backed up? We recommend that backups are made at least daily.
- How much downtime is acceptable? When using a backup strategy with any downtime we recommend scheduling backups at a time of day that minimizes impact on users, e.g., out of office hours.
- How long should backups be retained for? We recommend that backups be retained for at least one month.
- Where should the backups be stored? We recommend that backups are stored at an offsite location.
- How quickly and easily can you restore your data in an emergency? We recommend restoring your backups in a staging environment on a regular basis to ensure that your backup strategy works in the event of a real emergency scenario.
The importance of being consistent
All backup strategies for Bitbucket need to capture the state of three fundamental data sources:
- The home directory on the file system, which contains your repository data, log files, plugins, and so on (see Set the home directory for more detail).
- If you’re using Mesh to manage your repositories, each Mesh node’s home directory, which contains your repository data and Mesh log files.
- The database, which contains data about pull requests, comments, users, groups, permissions, and so on.
Ensure that you back up the relevant encryption keys and configuration files located under the shared home directory of your Bitbucket instance or cluster. These files are crucial for encrypting and decrypting secrets. Losing these files could result in Bitbucket not functioning properly, as it would be unable to access encrypted secrets necessary for operation. Proper backups will ensure you can successfully restore all essential encrypted data and configurations during a system recovery. Specifically, make sure to back up the following:
${BITBUCKET_HOME}/shared/keys– Contains the encryption keys.${BITBUCKET_HOME}/shared/secured– Includes additional secured configuration data.${BITBUCKET_HOME}/shared/secrets-config.yaml– Contains configuration details for encrypted secrets.
These data sources hold the entire state of a Bitbucket instance. To backup the complete state of your instance, you need to take consistent snapshots of each using one of the strategies below. If you attempt to restore snapshots containing inconsistencies then there is a risk of corruption or data loss in your repositories and pull requests.
In addition, if you have a remote OpenSearch instance, search indexes are maintained in the OpenSearch data directory. But you don't have to include this in your backup as it can be completely rebuilt if necessary from the data in your home directory and database.
Bitbucket backup strategies
Bitbucket provides multiple strategies for taking backups free of inconsistencies, and each are summarized in the table below. Each option has tradeoffs between technical requirements and the amount of downtime involved. Which strategy you choose depends on the scale of your instance, your file system and database technologies, your recovery point objective, and your users' tolerance of downtime when backups are taken.
| Zero Downtime Backup | DIY Backup | |
|---|---|---|
| Summary | A technique that eliminates downtime completely using internally consistent database snapshots and block-level filesystem snapshots | A technique that minimizes downtime using incremental copy or vendor-specific snapshot technology |
| Downtime |  Zero at backup time. |
|
| Minimum product version | Bitbucket 4.8+ | Stash 2.12+ Bitbucket 4.0+ |
| Bitbucket Data Center |
|
|
| Minimum requirements |
| Requires you to use the snapshot tools of your file system and database vendor. Example scripts are provided. |
| Backup format | Vendor-specific database snapshot and block level file system snapshot of the entire disk volume. | Vendor-specific database dump and file system snapshot. |
| Documentation | Bitbucket zero downtime backup | Bitbucket DIY Backup |
Low. Only needs to lock Bitbucket briefly to create a consistent snapshot. Downtime can be as low as a few seconds.Further information