From 040775efae3ed9481e968ae3f48fa03d04a1cc02 Mon Sep 17 00:00:00 2001 From: Kunal Shroff Date: Wed, 25 Sep 2024 11:27:45 -0400 Subject: [PATCH] sar-documentation --- services/save-and-restore/README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/services/save-and-restore/README.md b/services/save-and-restore/README.md index b4cf28557a..cb8c6a53a3 100644 --- a/services/save-and-restore/README.md +++ b/services/save-and-restore/README.md @@ -21,13 +21,38 @@ deployment to an application server, see https://spring.io/guides/gs/convert-jar Run the service like so: -java [options] -jar service-save-and-restore-.jar +`java [options] -jar service-save-and-restore-.jar` Where [options] may override default values for Elasticsearch host (localhost) and port (9200): -Delasticsearch.network.host=[host] -Delasticsearch.http.port=[port] +or you can use a `.properties file` + +`java -Dspring.config.location=/path/to/save_restore.properties -jar service-save-and-restore-.jar` + +# Verification + +To check that the server is running correctly. + +``` +$ curl --fail-with-body http://localhost:8080/save-restore +{ + "name" : "service-save-and-restore", + "version" : "4.7.4-SNAPSHOT", + "elastic" : { + "status" : "Connected", + "clusterName" : "elastic-nasa", + "clusterUuid" : "QNeYpFlWRueYPH3uXGUiGw", + "version" : "co.elastic.clients.elasticsearch._types.ElasticsearchVersionInfo@3d95cef6" + }, + "rootNodeID" : "44bef5de-e8e6-4014-af37-b8f6c8a939a2" +} +``` + +The response will have information about the service version, the root node id, the status of the connection with the elastic backend. + # Features * The service defines a set of data objects - nodes - arranged in a tree structure. Nodes in the tree are