lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a.@apache.org
Subject [06/21] lucene-solr:jira/solr-11285-sim: SOLR-11359: added documentation
Date Mon, 11 Dec 2017 18:52:25 GMT
SOLR-11359: added documentation


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/24a0708d
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/24a0708d
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/24a0708d

Branch: refs/heads/jira/solr-11285-sim
Commit: 24a0708d3c65138ecdee77edd7ce7e08e7e19c75
Parents: 1471330
Author: Noble Paul <noble@apache.org>
Authored: Fri Dec 8 17:36:41 2017 +1100
Committer: Noble Paul <noble@apache.org>
Committed: Fri Dec 8 17:36:41 2017 +1100

----------------------------------------------------------------------
 .../src/solrcloud-autoscaling-api.adoc          | 51 ++++++++++++++++++++
 1 file changed, 51 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/24a0708d/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc b/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
index 5a41196..9d53552 100644
--- a/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
+++ b/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
@@ -142,6 +142,57 @@ However, since the first node in the first example had more than 1 replica
for a
 
 In the above example the node with port 8983 has two replicas for `shard1` in violation of
our policy.
 
+== Suggestions API ==
+Suggestions are operations recommended by the system according to the policies and preferences
the user has set. Note that the suggestions are made only if there are `violations` to the
policies and the collection admin operation would use the preferences to identify the target
node.
+
+The API is available at `/admin/autocaling/suggestion`
+[source,json]
+----
+{
+  "responseHeader":{
+    "status":0,
+    "QTime":101},
+  "suggestions":[{
+      "type":"violation",
+      "violation":{
+        "collection":"mycoll",
+        "shard":"shard2",
+        "tagKey":"7574",
+        "violation":{ "delta":-1},
+        "clause":{
+          "replica":"0",
+          "shard":"#EACH",
+          "port":7574,
+          "collection":"mycoll"}},
+      "operation":{
+        "method":"POST",
+        "path":"/c/mycoll",
+        "command":{"move-replica":{
+            "targetNode":"192.168.43.37:8983_solr",
+            "replica":"core_node7"}}}},
+    {
+      "type":"violation",
+      "violation":{
+        "collection":"mycoll",
+        "shard":"shard2",
+        "tagKey":"7574",
+        "violation":{ "delta":-1},
+        "clause":{
+          "replica":"0",
+          "shard":"#EACH",
+          "port":7574,
+          "collection":"mycoll"}},
+      "operation":{
+        "method":"POST",
+        "path":"/c/mycoll",
+        "command":{"move-replica":{
+            "targetNode":"192.168.43.37:7575_solr",
+            "replica":"core_node15"}}}}],
+  "WARNING":"This response format is experimental.  It is likely to change in the future."}
+----
+
+The operation is an actual API call that can be invoked to remedy the current violation
+
 == History API
 
 The history of autoscaling events is available at `/admin/autoscaling/history`. It returns
information


Mime
View raw message