Using the Stark & Wayne SHIELD™ Web UI

Dashboard

After you’ve installed and deployed the tile, you can visit the SHIELD Web UI which will look similar to:

webui-dashboard

The URL for your SHIELD Web UI is https://shield.[system domain].

You will be prompted for basic authentication Username and Password.

Find the SHIELD credentials in Ops Manager:

credentials

Storage

Configure the storage destination of backup data to the object store, i.e. an S3 bucket, local file system directory, etc of your choice. Each record identifies a destination, the method by which to store and retrieve backup data to/from it (‘plugin’) and specific connection information required ('endpoint’)

backup-pcf-archives

For example we can configure a default storage backend with the fs plugin that will store the backup under “/tmp/to”

  • At the Store Name field enter the name of the database (ie: default).

  • At the Plugin Name field select the desired target (ie: fs).

  • At the Configuration (JSON) field enter:

  {
    {"base_dir":"/tmp/to"}
  }
  • Click on Create.

Targets

Configure the remote data systems that should be backed up by filling out the form below. Each record identifies the method by which the target is backed up (plugin) and specific connection information required (endpoint)

backup-pcf-new-target

For example we can configure a Mysql backup Job

Schedules

Contains the timing information that informs the core daemon when it should run which backup jobs (or JOBS, see later).

backup-pcf-new-target

For example we can configure a default that starts your backup each night at 3am

  • At the Schedule Name field enter a name (ie: default).

  • At the Summary field enter a short description (ie: backup each night at 3am).

  • At the Schedule you can use cron style or write it in full (ie: daily 3am).

  • Click on Create.

Retention

Policies govern how long data is kept. For now, this is just a simple expiration time, with 'name’ and 'summary’ fields for annotation.

backup-pcf-new-target

For example we can configure a short-term rention of 90 days

  • At the Policy Name field enter a name (ie: short-term).

  • At the Summary field enter a short description (ie: short-term retention of 90 days).

  • At the Expiration (in days) (ie: 90).

  • Click on Create.

Jobs

The actual job that backup your database/filesystem with the information from “Storage” “Targets” “Schedules” and “Retention”

backup-pcf-new-job

For example we can configure Job for our CCDB database

  • At the Job Name field enter the name of the database (ie: ccdb).

  • At the Target System field select the desired target (ie: ccdb).

  • At the Storage Backend field select the desired storage (ie: default).

  • At the Schedule field select the desired schedule (ie: daily).

  • At the Retention Policy field select the desired retention policy (ie: short-term).

  • Click on Create.

Backups

Ablitiy to view the backups that are stored by SHIELD Click on the Backups tab, for each of the Target Systems you should be able to see the existing archives:

backup-pcf-archives

Create a pull request or raise an issue on the source for this page in GitHub