reshifter

README

ReShifter

A cluster admin backup and restore tool for Kubernetes distros such as OpenShift, using etcd to query and manipulate the state of all objects.

• Status and roadmap
• Deploy app locally
• Deploy app in OpenShift
• Deploy app in Kubernetes
• CLI tool
• Test and development

Status and roadmap

See the Trello board for the current status of the work and roadmap items. You can also check out the design philosophy and architecture of ReShifter, if you want to learn more about why it works the way it does.

Deploy app locally

If you want to use the ReShifter app, that is the Web UI, you need to use the Docker image since it bundles the static assets such as HTML, CSS, and JS and the Go binary. For example, to launch the ReShifter app locally, do:

$ docker run --rm -p 8080:8080 quay.io/mhausenblas/reshifter:0.3.5

If you want to use the ReShifter API, for example as a head-less service, you can simply use the binary, no other dependencies required:

$ curl -s -L https://github.com/mhausenblas/reshifter/releases/download/v0.3.5-alpha/reshifter -o reshifter
$ chmod +x reshifter
$ ./reshifter

The ReShifter HTTP API is defined in and available via Swagger: swaggerhub.com/apis/mhausenblas/reshifter/1.0.0

Deploy app in OpenShift

To install the ReShifter app on OpenShift, we use a Makefile that creates a new project called reshifter, launches the app from the Docker image, and finally exposes the service via a route so that you can access the app from outside of the cluster. The following requires access to an OpenShift Origin 1.5 (or OpenShift Container Platform 3.5) cluster and also the oc CLI tool locally installed:

$ make init
$ make publish

Deploy app in Kubernetes

To install the ReShifter app in a portable way, use kubectl and the YAML files provided. The following requires access to a vanilla Kubernetes 1.5 or above cluster and also the kubectl CLI tool locally installed:

$ kubectl create -f https://raw.githubusercontent.com/mhausenblas/reshifter/master/deployments/reshifter-app.yaml

Note: the above YAML file defines both a Deployment as well as a Service object for ReShifter. It does, however, not expose the ReShifter service to the outside world. If you want to access the app from outside the cluster, you'll have to use Ingress or adapt the YAML file yourself.

CLI tool

ReShifter also provides for a CLI tool called rcli. Get binary releases for Linux and macOS via the GitHub release page.

$ rcli -h
A CLI for ReShifter, supports backing up and restoring Kubernetes clusters.

Usage:
  rcli [command]

Available Commands:
  backup      Creates a backup of a Kubernetes cluster
  explore     Probes an etcd endpoint
  help        Help about any command
  restore     Performs a restore of a Kubernetes cluster
  stats       Collects stats about Kubernetes-related keys from an etcd endpoint
  version     Displays the ReShifter version

...

Here's a simple usage example which assumes that you've got a Kubernetes cluster with an etcd on http://localhost:4001 running:

# explore the endpoint, overwrite default for etcd endpoint:
$ rcli explore -e http://localhost:4001

# collect stats using default for etcd endpoint:
$ rcli stats

# back up Kubernetes cluster to Minio playground:
$ ACCESS_KEY_ID=Q3AM3UQ867SPQQA43P2F \
  SECRET_ACCESS_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG \
  rcli backup -e http://localhost:4001 \
              -r play.minio.io:9000 \
              -b mh9-test

# restart/empty etcd now or launch a new one as a restore target

# restore cluster from Minio playground, using backup ID 1498815551:
$ ACCESS_KEY_ID=Q3AM3UQ867SPQQA43P2F \
  SECRET_ACCESS_KEY=zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG \
  rcli restore -e http://localhost:4001 \
               -r play.minio.io:9000 \
               -b mh9-test \
               -i 1498815551

Test and development

See the pages for testbed and development.

Documentation

Overview

ReShifter enables backing up and restoring OpenShift clusters. The ReShifter app launches an API and a UI at port 8080. The API is instrumented, exposing Prometheus metrics. When launching the app with the defaults, the backups are created in the current directory and the temporary work files are placed in the /tmp directory.