Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

shield

module

v8.0.10+incompatible Latest Latest Go to latest Published: Jun 13, 2018 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/shieldproject/shield

Links

Open Source Insights

README ¶

S.H.I.E.L.D. Data Protection

Questions? Pop in our slack channel!

What is SHIELD?

SHIELD is a data protection solution designed to make it easier for operations to protect their critical infrastructural data. It provides primitives for scheduling automatic backups of key systems, including PostgreSQL, MySQL, Consul, Redis and MongoDB, as well as a means for restoring backups in the event of an outage. Backups can be stored in a variety of cloud providers, including S3, Scality, Microsoft Azure Blobstore, and more.

Getting Started

The easiest way to get up and running with SHIELD is to deploy it via [BOSH][bosh], using the [SHIELD Bosh Release][shield-bosh].

Backup (Target) Plugins

`fs` - Local Filesystem Plugin

The fs plugin lets you back up arbitrary filesystem directories, optionally filtering the set of protected files via an includes / excludes system.

More information can be found here.

`postgres` - PostgreSQL Backup Plugin

Back up your PostgreSQL relational databases! This plugin lets you back up all databases (assuming you authenticate with an appropriately credentialed pg account), or pick and choose what to backup. Under the hood, this leverages pgdump, a proven solution in the PostgreSQL world.

More information can be found here.

`mysql` - MySQL Backup Plugin

Back up your MySQL relational databases! This plugin lets you back up all databases (assuming you authenticate with an appropriately credentialed mysql account), or pick and choose what to backup. This plugin leverages mysqldump, which generates plain-text SQL backups, which can often be replayed across MySQL versions.

More information can be found here.

`xtrabackup` - MySQL XtraBackup Plugin

This plugin offers another way of protecting MySQL, using the xtrabackup utility.

More information can be found here.

`cassandra` - Cassandra Backup Plugin

Back up Cassandra!

More information can be found here.

`consul` - Consul Backup Plugin

Back up the data stored in your Consul key-value store.

More information can be found here.

`mongo` - MongoDB Backup Plugin

Back up your MongoDB NoSQL database(s)!

More information can be found here.

Storage Plugins

`s3` - Amazon S3 Storage Plugin

Store your encrypted backup archives in Amazon's Simple Scalable Storage (S3) cloud. All you need is a bucket, a key, and a secret, and you get highly-available offsite archive storage.

More information can be found here.

`webdav` - WebDAV Plugin

If you can't make use of external, 3rd-party cloud storage for your backups, but do have access to an HTTP/WebDAV server, you can use this storage plugin to keep your archives there.

Note: often, use of the webdav plugin will compromise your disaster survivability. Make sure that your WebDAV store is sufficiently resilient (HA, geographically dispersed, replicated, etc.), and that you aren't using the same SHIELD core to back up your WebDAV store.

More information can be found here.

`azure` - Microsoft Azure Storage Plugin

Store your encrypted backup archives in Microsoft's Azure Blobstore!

More information can be found here.

`google` - Google Cloud Storage Plugin

Store your encrypted backup archives in Google's Cloud!

More information can be found here.

`swift` - OpenStack Swift Storage Plugin

Store your encrypted backup archives in your local OpenStack Swift blob store!

More information can be found here.

Directories ¶

Path	Synopsis
agent
client
v2/shield
cmd
shield
shield-agent
shield-crypt
shield-migrate
shield-schema
shieldd
core
crypter
db
lib
github
uaa
plugin
azure The `azure` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Azure's Blobstore Service.	The `azure` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Azure's Blobstore Service.
bbr-deployment The `bbr` plugin for SHIELD backup/restore plugin for all your bbr enabled deployments and directors.	The `bbr` plugin for SHIELD backup/restore plugin for all your bbr enabled deployments and directors.
bbr-director The `bbr` plugin for SHIELD backup/restore plugin for all your bbr enabled deployments and directors.	The `bbr` plugin for SHIELD backup/restore plugin for all your bbr enabled deployments and directors.
cassandra
consul The `consul` plugin for SHIELD is intended to be a generic backup/restore plugin for a consul server.	The `consul` plugin for SHIELD is intended to be a generic backup/restore plugin for a consul server.
consul-snapshot The `consul` plugin for SHIELD is intended to be a generic backup/restore plugin for a consul server.	The `consul` plugin for SHIELD is intended to be a generic backup/restore plugin for a consul server.
docker-postgres The `docker-postgres` plugin for SHIELD implements backup + restore functionality specific to the `docker-boshrelease`'s cf-containers-broker, in conjunction with Postgres docker containers.	The `docker-postgres` plugin for SHIELD implements backup + restore functionality specific to the `docker-boshrelease`'s cf-containers-broker, in conjunction with Postgres docker containers.
dummy
fs
google The `google` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Google's Cloud Storage service.	The `google` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Google's Cloud Storage service.
mock
mongo The `mongo` plugin for SHIELD implements generic backup + restore functionality for mongodb.	The `mongo` plugin for SHIELD implements generic backup + restore functionality for mongodb.
mysql The `mysql` plugin for SHIELD implements generic backup + restore functionality for a MySQL-compatible server.	The `mysql` plugin for SHIELD implements generic backup + restore functionality for a MySQL-compatible server.
postgres The `postgres` plugin for SHIELD is intended to be a generic backup/restore plugin for a postgres server.	The `postgres` plugin for SHIELD is intended to be a generic backup/restore plugin for a postgres server.
rabbitmq-broker The `rabbitmq-broker` plugin for SHIELD implements backup + restore functionality for Pivotal's cf-rabbitmq-release RabbitMQ Service Broker BOSH release.	The `rabbitmq-broker` plugin for SHIELD implements backup + restore functionality for Pivotal's cf-rabbitmq-release RabbitMQ Service Broker BOSH release.
redis-broker The `redis-broker` plugin for SHIELD implements backup + restore functionality for Piovtal's cf-redis-release (Redis Service + Broker for CloudFoundry).	The `redis-broker` plugin for SHIELD implements backup + restore functionality for Piovtal's cf-redis-release (Redis Service + Broker for CloudFoundry).
s3
swift The `swift` plugin for SHIELD is intended to be a back-end storage plugin, wrapping OpenStack Swift.	The `swift` plugin for SHIELD is intended to be a back-end storage plugin, wrapping OpenStack Swift.
webdav
xtrabackup The `xtrabackup` plugin for SHIELD implements backup + restore functionality for the cf-mysql-release.	The `xtrabackup` plugin for SHIELD implements backup + restore functionality for the cf-mysql-release.
route
timespec
tui
util