Versions Compared

Old Version 15

changes.mady.by.user Kyle Miller

Saved on

compared with

New Version 16

changes.mady.by.user Kyle Miller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The S3 Backup Restore Tool is the standalone utility for performing DR from the S3 backup bucket, either to the original cluster or to an empty cluster that is meant to replace the original. See S3 Backup Feeds.

Once the data is backed up in S3, the restore tool allows both examining a backup and control how, what, and where it is restored:

...

Section

Settings

[s3] 

  • host — The hostname of the S3 service.

  • port — The port to use for the S3 service. Use 443 or else 80, if SSL (sslOption) is disabled.

  • accessKeyID — The S3 access key ID.

  • secretAccessKey — The S3 secret access key.

  • bucketName — The name of the destination bucket in S3.

  • sslOption — The S3 connection constraint, with one of two values:

    • "trusted" (the default) specifies use of SSL and requires a trusted server certificate from the destination server.

    • “none” disables use of SSL. Use for testing and troubleshooting, and change the port to 80.

[s3]

archival

Set these additional parameters if using an S3 bucket with an archival storage class (Glacier, Glacier Deep Archive):

  • performArchiveRetrieval — Whether restoration from archival storage is needed. Performing a restore does not incur any expenses for the bucket owner if false (default), .

  • retrievalTier — Which S3 Glacier retrieval tier to use for restoration: ‘Standard' (default), 'Expedited', or 'Bulk'. Each tier has its own cost and expected restoration time; see Amazon S3 Storage Classes.

  • accountID — Specifies the 9-digit AWS account ID of the bucket owner, granting the tool permission to incur archive restoration expenses at the tier requested. This setting appears in the x-amz-expected-bucket-owner header on the restore object request.

  • activeLifetimeDays — How many days an object restored from archive should remain active before expiring (returning to archival storage). The default is 7 (1 week).

[forwardProxy] 

This section is for use with an optional forward proxy:

  • host — The forward proxy hostname or IP address.

  • port — The forward proxy host to use.

  • username — (optional) The user name.

  • password — (optional) The password.

[log] 

The same log settings as the Swarm cluster may be used; identify the logs by looking for those with the component "RESTORE" if done so.

  • host — The log host. Leave blank to disable logging.

  • port — (optional) The log port. Defaults to 514.

  • file — (optional) The log filename. Accepts the value of “stdout” for logging to the console screen. Defaults to /dev/null.

  • level — The log level. Defaults to 30 (Warning). Levels are the same used by Swarm: 20 (Info), 15 (Audit), 10 (Debug).

[swarm] 

  • host — A list of host names or IP addresses of Swarm nodes or Gateway nodes.

  • port — (optional) The SCSP port. Defaults to 80.

  • user — The cluster administrator user name, usually "admin".

  • password — The cluster administrator password.

...

  • -R or --recursive — Recursively restore domains, buckets, or the entire cluster with an empty object spec. See above for what is iterated over when -R is not used.

  • -v or --versions — Include previous versions of versioned objects. They are not included by default.

  • -f <file> or --file <file> — Use objectspecs from a file instead of the command line.

  • -p <count>/<total> or --partition <count>/<total> — Partition work for a large restore job (but every instance restores buckets and domains before objects).

    • Example: To run 4 instances in parallel, configure each option to be one of the series: -p 1/4, -p -2/4, -p -3/4, -p -4/4

  • -n or ---noop — Perform the checking of a restore, but do not restore any objects.

    • Does not change the cluster state. The option can be used before and after a restore, as both a pre-check and a verification.

  • <objectspecs> — Any number; newlines separate objects. If none, the top level of the cluster’s backup contents is the scope.

    • Using no object specification with the command options -Rv causes Swarm to restore all backed up objects in the entire cluster, including any historical versions of versioned objects.

What gets is restored: Restore copies an object from S3 to the cluster if the cluster object is missing or else older than the S3 object. Note: context objects restore before the content they contain: restore first restores any domains or buckets needed before restoring objects within them.

...