diff options
| author | Lingxian Kong <anlin.kong@gmail.com> | 2021-02-16 12:23:19 +1300 |
|---|---|---|
| committer | Lingxian Kong <anlin.kong@gmail.com> | 2021-02-18 17:34:37 +0000 |
| commit | 6fdf11ea7f5c77e83dd746fa33b7a354417aec08 (patch) | |
| tree | d66f3528a6a36911dd55ce654b095aca8cceb3aa /api-ref | |
| parent | 9c2e0bf3a0f1bc0b35a148174d8a4d2083f2b3c5 (diff) | |
| download | trove-6fdf11ea7f5c77e83dd746fa33b7a354417aec08.tar.gz | |
Support to restore backup from remote location
In multi-region deployment with geo-replicated Swift, the user can
restore a backup in one region by manually specifying the original
backup data location created in another region.
Change-Id: Iefef3bf969163af707935445bc23299400dc88c3
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/backups.inc | 14 | ||||
| -rwxr-xr-x | api-ref/source/parameters.yaml | 13 |
2 files changed, 26 insertions, 1 deletions
diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc index a9a086c2..2e3d56f0 100644 --- a/api-ref/source/backups.inc +++ b/api-ref/source/backups.inc @@ -76,6 +76,19 @@ In the Trove deployment with service tenant enabled, The backup data is stored as objects in OpenStack Swift service in the user's container. If not specified, the container name is defined by the cloud admin. +The user can create a backup strategy within the project scope or specific to +a particular instance. + +In multi-region deployment with geo-replicated Swift, the user can also restore +a backup in a region by manually specifying the backup data location created in +another region, then create instances from the backup. Instance ID is not +required in this case. + +.. warning:: + + The restored backup is dependent on the original backup data, if the + original backup is deleted, the restored backup is invalid. + Normal response codes: 202 Request @@ -90,6 +103,7 @@ Request - incremental: backup_incremental - description: backup_description - swift_container: swift_container + - restore_from: backup_restore_from Request Example --------------- diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 6918f2e4..a2c6c910 100755 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -148,7 +148,7 @@ backup_instanceId: description: | The ID of the instance to create backup for. in: body - required: true + required: false type: string backup_list: description: | @@ -180,6 +180,17 @@ backup_parentId1: in: body required: true type: string +backup_restore_from: + description: | + The information needed to restore a backup, including: + + - ``remote_location``: The original backup data location. + - ``local_datastore_version_id``: The local datastore version corresponding + to the original backup. + - ``size``: The original backup size. + in: body + required: false + type: object backup_size: description: | Size of the backup, the unit is GB. |