Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(release/v20.07) docs: Update restore documentation. #6653

Merged
merged 1 commit into from
Oct 5, 2020
Merged

(release/v20.07) docs: Update restore documentation. #6653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions wiki/content/enterprise-features/binary-backups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,21 +290,33 @@ Backup is an online tool, meaning it is available when alpha is running. For enc
`encryption_key_file` or `vault_*` options was used for encryption-at-rest and will now also be used for encrypted backups.
{{% /notice %}}

## Restore from Backup
To restore from a backup, execute the following mutation on `/admin` endpoint.
## Online restore

To restore from a backup to a live cluster, execute a mutation on the `/admin`
endpoint with the following format.

```graphql
mutation{
restore(input:{
location: "/path/to/backup/directory",
backupId: "id_of_backup_to_restore"'
}){
message
code
restoreId
}
}
```
Restore can be performed from Amazon S3 / Minio or from Local Directory. Below is the `RestoreInput` to be passed into the mutation.

Online restores only require you to send this request. The UID and timestamp
leases are updated accordingly. The latest backup to be restored should contain
the same number of groups in its manifest.json file as the cluster to which it
is being restored.

Restore can be performed from Amazon S3 / Minio or from a local directory. Below
is the documentation for the fields inside `RestoreInput` that can be passed into
the mutation.

```graphql
input RestoreInput {

Expand Down Expand Up @@ -379,10 +391,10 @@ input RestoreInput {
}
```

## Restore using `dgraph restore`
## Offline restore using `dgraph restore`

{{% notice "note" %}}
`dgraph restore` is being deprecated, please use GraphQL api for Restoring from Backup.
`dgraph restore` is being deprecated, please use GraphQL API for Restoring from Backup.
{{% /notice %}}

The restore utility is a standalone tool today. A new flag `--encryption_key_file` is added to the restore utility so it can decrypt the backup. This file must contain the same key that was used for encryption during backup.
Expand Down