-
Notifications
You must be signed in to change notification settings - Fork 61
Backup & Restores
gndcshv edited this page Jul 5, 2016
·
6 revisions
Backup and restore functionality by default supports S3 and relies on AWS Cloud Plugin
In order to use Scheduled Backup and Restore feature, AWS Cloud Plugin must be installed. You will have to take care of S3 credentials by using IAMCredentials (default) or a key-password combination.
| Property | Default Value | Description |
|---|---|---|
| Raigad.backup.location | elasticsearch-us-east-1-backup | Snapshot repositories will be created under this location. (Mandatory property) |
| Raigad.snapshot.enabled | false | Use Raigad.backup.hour property to set the timer for a particular hour in a day for the backup to run. Mandatory property. |
| Raigad.backup.hour | 1 | Takes values from 0 to 23, runs once every 24 hours. |
| Raigad.hourly.snapshot.enabled | false | Enable it, if more frequent snapshot backups are needed, useRaigad.backup.cron.timer.seconds property to set the timer. |
| Raigad.backup.cron.timer.seconds | 3600 | Depends on Raigad.hourly.snapshot.enabled property, runs every 3600 seconds. |
| Raigad.backup.comma.separated.indices | _all | Backs up all indices by default. Use comma separated indices e.g. test-idx-*, -test-idx-3. |
| Raigad.backup.partial.indices | false | |
| Raigad.backup.include.global.state | false | |
| Raigad.backup.wait.for.completion | true | Sync operation. |
| Raigad.backup.include.index.name | false | Include index name in snapshot backup. |
If "Raigad.backup.include.index.name" = false
then
set "Raigad.backup.comma.separated.indices" = "_all"
If "Raigad.backup.include.index.name" = true
then
set "Raigad.backup.comma.separated.indices" = "all" or "index1,index2,index3"
| Property | Default Value | Description |
|---|---|---|
| Raigad.restore.source.cluster.name | "" | Name of Source cluster of which Snapshot copy should be restored. (Mandatory property) |
| Raigad.restore.location | elasticsearch-us-east-1-backup | Location of repository (Mandatory property) |
| Raigad.restore.source.repo.region | us-east-1 | Region of repository (Mandatory property) |
| Raigad.restore.repository.name | testrepo | Use Raigad.backup.hour property to set the timer for particular hour in a day (Runs every day once) |
| Raigad.restore.repository.type | s3 | eg. s3, fs |
| Raigad.restore.snapshot.name | "" | Enable this property, if more frequent Snapshot backups are needed (use Raigad.backup.cron.timer.seconds property to set the timer) |
| Raigad.restore.comma.separated.indices | _all | Comma separated indices eg. test-idx-*, -test-idx-3 |
| Raigad.restore.enabled | false | Enable this property, if Restore is necessary at Startup (Make sure you run Restore only on Single node and then bootstrap other nodes after Restore is finished) |
| Raigad.restore.task.initial.start.delay.seconds | 600 | Delay to start Restore task at Startup |