https://github.com/codelibs/opensearch-configsync
https://github.com/codelibs/opensearch-configsync
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codelibs/opensearch-configsync
- Owner: codelibs
- License: apache-2.0
- Created: 2021-10-31T12:41:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T00:11:22.000Z (11 months ago)
- Last Synced: 2024-08-09T01:43:17.120Z (11 months ago)
- Language: Java
- Size: 63.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
OpenSearch Config Sync Plugin
[](https://github.com/codelibs/opensearch-configsync/actions/workflows/maven.yml)
=======================
## Overview
Config Sync Plugin provides a feature to distribute files, such as script or dictionary file, to nodes in your cluster.
These files are managed in .configsync index, and each node sync up with them.
## Version
[Versions in Maven Repository](https://repo1.maven.org/maven2/org/codelibs/opensearch/opensearch-configsync/)
### Issues/Questions
Please file an [issue](https://github.com/codelibs/opensearch-configsync/issues "issue").
## Installation
$ $OPENSEARCH_HOME/bin/opensearch-plugin install org.codelibs.opensearch:opensearch-configsync:1.2.0
## Getting Started
### Register File
$ curl -XPOST -H 'Content-Type:application/json' localhost:9200/_configsync/file?path=user-dict.txt --data-binary @user-dict.txt
The above request is to add file info to .configsync index.
path parameter is a synced file location under $OPENSEARCH\_CONF directory(ex. /etc/opensearch/user-dict.txt).
### Get File List
Send GET request without path parameter:
$ curl -XGET -H 'Content-Type:application/json' localhost:9200/_configsync/file
{"acknowledged":true,"path":["user-dict.txt"]}
### Get File
Send GET request with path parameter:
$ curl -XGET -H 'Content-Type:application/json' localhost:9200/_configsync/file?path=user-dict.txt
### Delete File
Send DELETE request with path parameter:
$ curl -XDELETE -H 'Content-Type:application/json' localhost:9200/_configsync/file?path=user-dict.txt
### Sync
Each node copies a file from .configsync index periodically if the file is updated.
The interval time is specified by configsync.flush\_interval in /etc/elasticserch/opensearch.yml.
The default value is 1m.
configsync.flush_interval: 1m
### Reset
To restart a scheduler for checking .configsync index, send POST request as below:
$ curl -XPOST -H 'Content-Type:application/json' localhost:9200/_configsync/reset