Documentation ¶
Overview ¶
The `google` plugin for SHIELD is intended to be a back-end storage plugin, wrapping Google's Cloud Storage service.
PLUGIN FEATURES ¶
This plugin implements functionality suitable for use with the following SHIELD Job components:
Target: no Store: yes
PLUGIN CONFIGURATION ¶
The endpoint configuration passed to this plugin is used to determine how to connect to Google Cloud Storage, and where to place/retrieve the data once connected. Your endpoint JSON should look something like this:
{ "json_key": "your-google-cloud-json-key", "bucket": "name-of-your-bucket", "prefix": "/path/inside/bucket/to/place/backup/data" }
Default Configuration ¶
`json_key` is only required if you are not running the plugin inside a Google Compute Engine VM with `devstorage.full_control` service scope, otherwise Google Application Default Credentials will be used (see https://developers.google.com/identity/protocols/application-default-credentials).
`prefix` will default to the empty string, and backups will be placed in the root of the bucket.
STORE DETAILS ¶
When storing data, this plugin connects to the Google Cloud Storage service, and uploads the data into the specified bucket, using a filename with the following format:
<prefix>/<YYYY>/<MM>/<DD>/<YYYY>-<MM>-<DD><HH-mm-SS>-<UUID>
Upon successful storage, the plugin then returns this filename to SHIELD to use as the `store_key` when the data needs to be retrieved, or purged.
RETRIEVE DETAILS ¶
When retrieving data, this plugin connects to the Google Cloud Storage service, and retrieves the data located in the specified bucket, identified by the `store_key` provided by SHIELD.
PURGE DETAILS ¶
When purging data, this plugin connects to the Google Cloud Storage service, and deletes the data located in the specified bucket, identified by the `store_key` provided by SHIELD.
DEPENDENCIES ¶
None.