Olares/docs/developer/install/cli/backups-restore.md

outline

outline
2 3

restore

:::warning The olares-cli backups download command must be run first to install Restic. Otherwise, this command will return an error. :::

Synopsis

The restore subcommand allows you to restore data from a specified backup repository and snapshot to a target directory.

olares-cli backups restore <backend> --path <path> --repo-name <name> --snapshot-id <id> [options]

Common options

These options apply to all backends:

Option	Shorthand	Usage	Required	Default
--help	-h	Displays help information.	No	N/A
--path		Specifies the directory to which data will be restored.	No	N/A
--repo-name		Specifies the name of the backup repository to restore from.	No	N/A
--snapshot-id		Specifies the snapshot ID to restore.	No	N/A

Backend-specific options

Options for cos

Option	Shorthand	Usage	Required	Default
--access-key		Specifies the Access Key for Tencent COS.	No	N/A
--endpoint		Specifies the Tencent COS endpoint, e.g., https://cos.{region}.myqcloud.com/{bucket}/{prefix}.	No	N/A
--limit-download-rate		Limits the download speed to a maximum rate in KiB/s.	No	unlimited
--secret-access-key		Specifies the Secret Access Key for Tencent COS.	No	N/A

Options for fs

Option	Shorthand	Usage	Required	Default
--endpoint		Specifies the local directory where the backup is stored.	No	N/A
--olares-id		Specifies the Olares ID.	No	N/A

Options for s3

Option	Shorthand	Usage	Required	Default
--access-key		Specifies the Access Key for Amazon S3.	No	N/A
--endpoint		Specifies the Amazon S3 endpoint, e.g., https://{bucket}.{region}.amazonaws.com/{prefix}.	No	N/A
--limit-download-rate		Limits the download speed to a maximum rate in KiB/s.	No	unlimited
--secret-access-key		Specifies the Secret Access Key for Amazon S3.	No	N/A

Options for space

Option	Shorthand	Usage	Required	Default
--access-token 1		Specifies the access token for Olares Space.	No	N/A
--cloud-api-mirror		Specifies the cloud API mirror.	No	N/A
--cloud-name		Specifies the cloud name of the Olares Space instance. The cloud name can be retrieved using the region subcommand.	No	N/A
--cluster-id 2		Specifies the cluster ID where the backup will be stored.	No	N/A
--limit-download-rate		Limits the download speed to a maximum rate in KiB/s.	No	unlimited
--olares-did 1		Specifies the Olares DID.	No	N/A
--region-id		Specifies the region ID of the Olares Space instance. The region ID can be retrieved using the region subcommand.	No	N/A

1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The token field corresponds to the access token, and the userid field corresponds to the Olares DID.

2. To retrieve the cluster ID, use the following command:

kubectl get terminus -o jsonpath='{.items[*].metadata.labels.bytetrade\.io/cluster-id}'

Example

# Restore the data from Tencent COS
olares-cli backups restore cos --path /data_restore --repo-name my_repo \
  --snapshot-id snapshot_12345 \
  --access-key YOUR_KEY \
  --secret-access-key YOUR_SECRET \
  --endpoint https://cos.region.myqcloud.com/bucket/prefix
  
# Restore the data from local filesystem
olares-cli backups restore fs --path /data_restore --repo-name my_repo \
  --snapshot-id snapshot_12345 --endpoint /backup_repo