You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2018/03/13 18:36:26 UTC
lucene-solr:branch_7x: SOLR-11648: Add docs for autoscaling
suggestions UI that didn't get done with the feature
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x 93f3fcf7b -> 52b015bea
SOLR-11648: Add docs for autoscaling suggestions UI that didn't get done with the feature
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/52b015be
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/52b015be
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/52b015be
Branch: refs/heads/branch_7x
Commit: 52b015beaf17989b0cf716021a1267b55b62683f
Parents: 93f3fcf
Author: Cassandra Targett <ct...@apache.org>
Authored: Tue Mar 13 13:33:21 2018 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Tue Mar 13 13:36:17 2018 -0500
----------------------------------------------------------------------
.../images/suggestions-screen/no-violations.png | Bin 0 -> 73333 bytes
.../violations-with-action.png | Bin 0 -> 152486 bytes
.../images/suggestions-screen/violations.png | Bin 0 -> 123009 bytes
solr/solr-ref-guide/src/suggestions-screen.adoc | 40 +++++++++++++++++++
...-the-solr-administration-user-interface.adoc | 3 +-
5 files changed, 42 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/52b015be/solr/solr-ref-guide/src/images/suggestions-screen/no-violations.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/suggestions-screen/no-violations.png b/solr/solr-ref-guide/src/images/suggestions-screen/no-violations.png
new file mode 100644
index 0000000..b43e491
Binary files /dev/null and b/solr/solr-ref-guide/src/images/suggestions-screen/no-violations.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/52b015be/solr/solr-ref-guide/src/images/suggestions-screen/violations-with-action.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/suggestions-screen/violations-with-action.png b/solr/solr-ref-guide/src/images/suggestions-screen/violations-with-action.png
new file mode 100644
index 0000000..deda37d
Binary files /dev/null and b/solr/solr-ref-guide/src/images/suggestions-screen/violations-with-action.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/52b015be/solr/solr-ref-guide/src/images/suggestions-screen/violations.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/suggestions-screen/violations.png b/solr/solr-ref-guide/src/images/suggestions-screen/violations.png
new file mode 100644
index 0000000..f506397
Binary files /dev/null and b/solr/solr-ref-guide/src/images/suggestions-screen/violations.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/52b015be/solr/solr-ref-guide/src/suggestions-screen.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/suggestions-screen.adoc b/solr/solr-ref-guide/src/suggestions-screen.adoc
new file mode 100644
index 0000000..1936c13
--- /dev/null
+++ b/solr/solr-ref-guide/src/suggestions-screen.adoc
@@ -0,0 +1,40 @@
+= Suggestions Screen
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+[.lead]
+The Suggestions screen shows violations to an <<solrcloud-autoscaling-policy-preferences.adoc#policy-specification,autoscaling policy>> that exist in the system, and allows you to take action to correct the violations.
+
+This screen is a visual representation of the output of the <<solrcloud-autoscaling-api.adoc#suggestions-api,Suggestions API>>.
+
+When there are no violations or other suggestions, the screen will appear somewhat blank:
+
+image::images/suggestions-screen/no-violations.png[]
+
+When the system is in violation of an aspect of a policy, each violation will be shown, as in this screenshot:
+
+image::images/suggestions-screen/violations.png[]
+
+A line is shown for each violation. In this case, we have defined a policy where no replica can exist on a node that has less than 500Gb of available disk space. In this example, 4 replicas in our sample cluster violates this rule.
+
+In the "Action" column, the green button allows you to execute the recommended change to allow the system to return to compliance with the policy. If you hover your mouse over this button, you will see the recommended Collections API command:
+
+image::images/suggestions-screen/violations-with-action.png[]
+
+In this case, the recommendation is to issue a MOVEREPLICA command to move this replica to a node with more available disk space.
+
+NOTE: Since autoscaling features are only available in SolrCloud mode, this screen will only appear when running Solr in SolrCloud mode.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/52b015be/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
index 2860487..43c8c87 100644
--- a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
+++ b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
@@ -1,5 +1,5 @@
= Using the Solr Administration User Interface
-:page-children: overview-of-the-solr-admin-ui, getting-assistance, logging, cloud-screens, collections-core-admin, java-properties, thread-dump, collection-specific-tools, core-specific-tools
+:page-children: overview-of-the-solr-admin-ui, getting-assistance, logging, cloud-screens, collections-core-admin, java-properties, thread-dump, suggestions-screen, collection-specific-tools, core-specific-tools
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -27,6 +27,7 @@ The <<overview-of-the-solr-admin-ui.adoc#overview-of-the-solr-admin-ui,Overview
* *<<collections-core-admin.adoc#collections-core-admin,Collections / Core Admin>>* explains how to get management information about each core.
* *<<java-properties.adoc#java-properties,Java Properties>>* shows the Java information about each core.
* *<<thread-dump.adoc#thread-dump,Thread Dump>>* lets you see detailed information about each thread, along with state information.
+* *<<suggestions-screen.adoc#suggestions-screen,Suggestions Screen>>* displays the state of the system with regard to the autoscaling policies that are in place.
* *<<collection-specific-tools.adoc#collection-specific-tools,Collection-Specific Tools>>* is a section explaining additional screens available for each collection.
// TODO: SOLR-10655 BEGIN: refactor this into a 'collection-screens-list.include.adoc' file for reuse