Recently I had an issue where I needed to export my Consul K/V store, delete the cluster then restore the data that was in the store. A quick Google didn’t return any copy-paste results. I was in a bit of a rush at the time and thankfully the store only had about 15 entries so I did it manually. I’ve had to do it a few more times since then but now I’ve fixed my auto-scaling cluster nodes so they leave gracefully when they are terminated.

Anyway, here is the python required to do a backup and/or restore of Consul:

import json
import argparse
import requests
import sys
from base64 import b64decode

parser = argparse.ArgumentParser()
parser.add_argument('--backup', help = 'Backup the consul K/V store to file', action = 'store_true')
parser.add_argument('--restore', help = 'Restore the consul file to the server', action = 'store_true')
parser.add_argument('--host', help = 'Specify the consul host to use', required = True)
parser.add_argument('--file', help = 'Specify the file to backup/restore to', required = True)
parser.add_argument('--verbose', help = 'Print debug information', action = 'store_true')
args = parser.parse_args()

def main():
  if args.backup:

  if args.restore:

def restore():
  if args.verbose:
    print 'Restoring'

  base_url = '%s/v1/kv' %

  if args.verbose:
    print 'Opening %s for reading...' % args.file

  with open(args.file) as f:
    data = json.load(f)

  for obj in data:
    val = b64decode(obj['Value'])
    url = "%s/%s" % (base_url, obj['Key'])

    if args.verbose:
      print 'Putting %s to %s...' % (val, url)

    r = requests.put(url, val)
    if args.verbose:
      print 'Consul response: %s' % r.text

  if args.verbose:
    print 'Restore complete'

def backup():
  if args.verbose:
    print 'Backing up...'

  url = "%s/v1/kv/?recurse&pretty" %
  if args.verbose:
    print 'Getting %s' % url

  data = requests.get(url)
  if data.status_code != 200:
    print 'Invalid resposne code received from Consul.  Expected 200, got %d' % data.status_code

  if args.verbose:
    print 'Saving JSON output to %s' % args.file

  with open(args.file, 'w') as f:

  if args.verbose:
    print 'Backup finished.'



python  --host http://consul.domain.internal:8500 --file out.json --backup --verbose
python  --host http://consul.domain.internal:8500 --file out.json --restore --verbose