diff --git a/README.md b/README.md index fa51582..3bc6719 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# What is Elasticsearch Curator? +# What is Qubership OpenSearch Curator? -Elasticsearch Curator helps you curate, or manage, your Elasticsearch indices and snapshots by: +OpenSearch Curator helps you curate, or manage, your OpenSearch indices and snapshots by: - Obtaining the full list of indices (or snapshots) from the cluster, as the actionable list - Iterate through a list of user-defined filters to progressively remove indices (or snapshots) from this actionable list as needed. - Perform various actions on the items which remain in the actionable list. -Elasticsearch Curator does not store Elasticsearch backups. It just calls Elasticsearch REST API to make it to start backup process. -And all backups are stored on Elasticsearch side, Elasticsearch Curator only stores meta information about backups (timestamp, size, list of indices, etc.). +OpenSearch Curator does not store OpenSearch backups. It just calls OpenSearch REST API to make it to start backup process. +And all backups are stored on OpenSearch side, OpenSearch Curator only stores meta information about backups (timestamp, size, list of indices, etc.). # API Usage @@ -17,7 +17,7 @@ For POST operations you must specify user/pass from `BACKUP_DAEMON_API_CREDENTIA ### Full Manual Backup -If you want to make a backup of all Elasticsearch indices data, you need to run the following command: +If you want to make a backup of all OpenSearch indices data, you need to run the following command: ``` curl -XPOST -u username:password http://localhost:8080/backup @@ -201,7 +201,7 @@ As a result you receive JSON with information: # Scheduled snapshots cleanup Curator is able to perform scheduled snapshots cleanup. However, it is not possible to provide common template that can be easily configured for different use cases. -So actions configuration for cleanup should be provided. It is highly recommended to include cleanup actions as part of snapshot creation action file (snapshot.yml) that is mounted to /opt/elasticsearch-curator/actions/ in container. +So actions configuration for cleanup should be provided. It is highly recommended to include cleanup actions as part of snapshot creation action file (snapshot.yml) that is mounted to /opt/OpenSearch-curator/actions/ in container. For more information on different filter types (such as [age](https://www.elastic.co/guide/en/elasticsearch/client/curator/current/filtertype_age.html) and [period](https://www.elastic.co/guide/en/elasticsearch/client/curator/current/filtertype_period.html)) please check [curator documentation](https://www.elastic.co/guide/en/elasticsearch/client/curator/5.4/index.html). @@ -256,7 +256,7 @@ actions: ## Eviction Policy -Elasticsearch Curator provides eviction policy to remove obsolete snapshots. You can change eviction policy via environment variable `EVICTION_POLICY`. +OpenSearch Curator provides eviction policy to remove obsolete snapshots. You can change eviction policy via environment variable `EVICTION_POLICY`. Eviction policy is a comma-separated string of policies written as `$start_time/$interval`. This policy splits all backups older than $start_time to numerous time intervals $interval time long. Then it deletes all backups in every interval except the newest one.