Curator
Prerequisites
Please refer to the official Curator install guide on how to install it on various operating systems.
Configure Snapshot repository
In order to create backups for Snow Owl, you need a repository in your Elasticsearch cluster.
To create a repository (assuming shared file system repository, fs
), execute the following command:
Elasticsearch requires that the specified /path/to/shared/mount
is whitelisted in the path.repo
configuration setting in the elasticsearch.yml
configuration file.
Curator configuration file
Curator requires a single configuration file to be specified when running it. If you are using a default Elasticsearch cluster with default configurations then the default Curator recommended file should be sufficient. Any configuration changes you have made to your Elasticsearch cluster needs to be changed here as well in this config file so Curator can access your cluster without any issues.
Example curator-config.yml
:
Snapshot Action
Curator is using action YML files to perform a set of actions sequentially. See the available steps here: https://www.elastic.co/guide/en/elasticsearch/client/curator/5.8/actions.html
A Snapshot Action that can be used to backup the content from a Snow Owl Terminology Server.
Example snowowl-snapshots.yml
file:
To execute a Snapshot action manually, you can use the following command:
Restore Action
A Restore Action that can be used to restore the latest snapshot (aka backup) to the Snow Owl Terminology Server.
Example snowowl-restore.yml
file:
To execute a Restore action manually, you can use the following command:
Taking scheduled backups
To schedule automated backups, you can use Cron on Unix-style operating systems to automate the job. The back up interval depends on your use case and how you are accessing the data. If you have a write-heavy scenario, we recommend a hourly backup interval, otherwise some value between hourly - daily is preferrable.
Last updated