Trove/backup-restore-single-instance-couchbase

Introduction

This article describes the design and process for backup and restore for Couchbase.

Blueprint

https://blueprints.launchpad.net/trove/+spec/backups-single-instance-couchbase

Future Follow up Blueprints

1. Support incremental backup restore for Couchbase
   • Targeted for Couchbase 3.0
   • http://www.couchbase.com/issues/browse/MB-10176
   • https://blueprints.launchpad.net/trove/+spec/incremental-backup-restore-couchbase

Goals

1. Implement backup and restore strategy for Couchbase

Dependencies

1. Add support for 'trove root-enable' in Couchbase
   • https://review.openstack.org/#/c/81640
2. Adds backup/restore support for mongodb
   • https://review.openstack.org/#/c/78339/ <-- requires some of the code changes introduced to support backup/restore for different datastores

Description

1. Backup strategy
   • Backup directory is /tmp/backups
   • Save bucket metadata config (json file) as part of backup via:
     • curl -u admin:password http://localhost:8091/pools/default/buckets
     • This is needed on restore to create the destination buckets
   • Handles root enabled cause by also backing up /tmp/secret_key
   • Use cbbackup to do the backup
     • Only backs up the raw data from Couchbase (membase) buckets. Skips memcached buckets because data is not persistent.
     • http://docs.couchbase.com/couchbase-manual-2.5/cb-cli/#cbbackup-tool
   • Backup directory (/tmp/backups) will be zipped up, encrypted, and sent to Swift
   • If no buckets, backup will error out

1. Restore strategy
   • Get backup tarball from Swift, decrypt, and untar
   • If /tmp/backups/secret_key exists, set root password
   • Iterate through bucket metadata config (json file) and use Couchbase REST API to create each bucket
     • http://docs.couchbase.com/couchbase-manual-2.5/cb-rest-api/#creating-and-editing-buckets
   • Wait until bucket finishes creating
     • Follows same logic as couchbase-cli bucket-create --wait (because REST API doesn't have anything for "wait")
       • https://github.com/couchbase/couchbase-cli/blob/master/buckets.py#L208-L252
   • Use cbrestore to do the restore

Usage: cbrestore [options] backup_dir destination
Restores a single couchbase bucket.
Please first create the destination / bucket before restoring. <pre>