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 2017/12/13 20:35:25 UTC
lucene-solr:branch_7_2: SOLR-11753: copy edits;
add docs for SOLR-11448
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7_2 127ee7457 -> bca54cad5
SOLR-11753: copy edits; add docs for SOLR-11448
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/bca54cad
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/bca54cad
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/bca54cad
Branch: refs/heads/branch_7_2
Commit: bca54cad5a9f6a80800944fd5bd585b68acde8c8
Parents: 127ee74
Author: Cassandra Targett <ct...@apache.org>
Authored: Wed Dec 13 14:32:49 2017 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Wed Dec 13 14:35:15 2017 -0600
----------------------------------------------------------------------
solr/solr-ref-guide/src/collections-api.adoc | 12 ++++++++
solr/solr-ref-guide/src/installing-solr.adoc | 14 +++++-----
.../src/solrcloud-autoscaling-api.adoc | 29 ++++++++++++--------
3 files changed, 37 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bca54cad/solr/solr-ref-guide/src/collections-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/collections-api.adoc b/solr/solr-ref-guide/src/collections-api.adoc
index 23a26a1..a0c8038 100644
--- a/solr/solr-ref-guide/src/collections-api.adoc
+++ b/solr/solr-ref-guide/src/collections-api.adoc
@@ -109,6 +109,9 @@ Details of the snitch provider. See the section <<rule-based-replica-placement.a
`policy`:: Name of the collection-level policy. See <<solrcloud-autoscaling-policy-preferences.adoc#collection-specific-policy, Defining Collection-Specific Policies >> for details.
+`waitForFinalState`::
+If `true`, the request will complete only when all affected replicas become active. The default is `false`, which means that the API will return the status of the single action, which may be before the new replica is online and active.
+
=== CREATE Response
The response will include the status of the request and the new core names. If the status is anything other than "success", an error message will explain why the request failed.
@@ -267,6 +270,9 @@ For example, suppose `split.key=A!` hashes to the range `12-15` and belongs to s
`property._name_=_value_`::
Set core property _name_ to _value_. See the section <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>> for details on supported properties and values.
+`waitForFinalState`::
+If `true`, the request will complete only when all affected replicas become active. The default is `false`, which means that the API will return the status of the single action, which may be before the new replica is online and active.
+
`async`::
Request ID to track this action which will be <<Asynchronous Calls,processed asynchronously>>
@@ -372,6 +378,9 @@ The format is a comma-separated list of node_names, such as `localhost:8983_solr
`property._name_=_value_`::
Set core property _name_ to _value_. See the section <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>> for details on supported properties and values.
+`waitForFinalState`::
+If `true`, the request will complete only when all affected replicas become active. The default is `false`, which means that the API will return the status of the single action, which may be before the new replica is online and active.
+
`async`::
Request ID to track this action which will be <<Asynchronous Calls,processed asynchronously>>.
@@ -749,6 +758,9 @@ See the section <<shards-and-indexing-data-in-solrcloud.adoc#types-of-replicas,T
`property._name_=_value_`::
Set core property _name_ to _value_. See <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>> for details about supported properties and values.
+`waitForFinalState`::
+If `true`, the request will complete only when all affected replicas become active. The default is `false`, which means that the API will return the status of the single action, which may be before the new replica is online and active.
+
`async`::
Request ID to track this action which will be <<Asynchronous Calls,processed asynchronously>>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bca54cad/solr/solr-ref-guide/src/installing-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/installing-solr.adoc b/solr/solr-ref-guide/src/installing-solr.adoc
index d537420..9e7b23a 100644
--- a/solr/solr-ref-guide/src/installing-solr.adoc
+++ b/solr/solr-ref-guide/src/installing-solr.adoc
@@ -65,7 +65,7 @@ Once extracted, you are now ready to run Solr using the instructions provided in
After installing Solr, you'll see the following directories and files within them:
-bin::
+bin/::
This directory includes several important scripts that will make using Solr easier.
solr and solr.cmd::: This is <<solr-control-script-reference.adoc#solr-control-script-reference,Solr's Control Script>>, also known as `bin/solr` (*nix) / `bin/solr.cmd` (Windows). This script is the preferred tool to start and stop Solr. You can also create collections or cores, configure authentication, and work with configuration files when running in SolrCloud mode.
@@ -78,22 +78,22 @@ These are property files for *nix and Windows systems, respectively. System-leve
install_solr_services.sh:::
This script is used on *nix systems to install Solr as a service. It is described in more detail in the section <<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>>.
-contrib::
+contrib/::
Solr's `contrib` directory includes add-on plugins for specialized features of Solr.
-dist::
+dist/::
The `dist` directory contains the main Solr .jar files.
-docs::
+docs/::
The `docs` directory includes a link to online Javadocs for Solr.
-example::
+example/::
The `example` directory includes several types of examples that demonstrate various Solr capabilities. See the section <<Solr Examples>> below for more details on what is in this directory.
-licenses::
+licenses/::
The `licenses` directory includes all of the licenses for 3rd party libraries used by Solr.
-server::
+server/::
This directory is where the heart of the Solr application resides. A README in this directory provides a detailed overview, but here are some highlights:
* Solr's Admin UI (`server/solr-webapp`)
* Jetty libraries (`server/lib`)
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/bca54cad/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 5dd04ed..51ee31f 100644
--- a/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
+++ b/solr/solr-ref-guide/src/solrcloud-autoscaling-api.adoc
@@ -579,20 +579,27 @@ The `remove-listener` command can be used to remove an existing listener. It acc
}
----
-=== Change AutoScaling Properties
+=== Change Autoscaling Properties
The `set-properties` command can be used to change the default properties used by the Autoscaling framework.
-The following well known properties can be specified in the payload:
+The following properties can be specified in the payload:
-* `triggerScheduleDelaySeconds` (defaults to 1 second): This is the delay in seconds between two executions of a trigger. Every trigger is scheduled using Java's ScheduledThreadPoolExecutor with this delay.
-* `triggerCooldownPeriodSeconds` (defaults to 5 seconds): Solr pauses all other triggers for this cool down period after a trigger fires so that the system can stabilize before running triggers again.
-* `triggerCorePoolSize` (defaults to 4 threads): The core pool size of the `ScheduledThreadPoolExecutor` used to schedule triggers.
-* `actionThrottlePeriodSeconds` (defaults to 5 seconds): This is the minimum throttling delay between executing actions for triggers. It is guaranteed that actions for two trigger events are executed after this delay period.
+`triggerScheduleDelaySeconds`::
+This is the delay in seconds between two executions of a trigger. Every trigger is scheduled using Java's ScheduledThreadPoolExecutor with this delay. The default is `1` second.
-The command allows setting arbitrary properties in addition to the above well-known properties. Such arbitrary properties can be useful in custom `TriggerAction` instances.
+`triggerCooldownPeriodSeconds`::
+Solr pauses all other triggers for this cool down period after a trigger fires so that the system can stabilize before running triggers again. The default is `5` seconds.
-.Change default triggerScheduleDelaySeconds
+`triggerCorePoolSize`::
+The core pool size of the `ScheduledThreadPoolExecutor` used to schedule triggers. The default is `4` threads.
+
+`actionThrottlePeriodSeconds`::
+This is the minimum throttling delay between executing actions for triggers. It is guaranteed that actions for two trigger events are executed after this delay period. The default is `5` seconds.
+
+The command allows setting arbitrary properties in addition to the above properties. Such arbitrary properties can be useful in custom `TriggerAction` instances.
+
+.Change default `triggerScheduleDelaySeconds`
[source.json]
----
{
@@ -602,11 +609,11 @@ The command allows setting arbitrary properties in addition to the above well-kn
}
----
-The set-properties command replaces older values if present. So using set-properties to set the same value twice will overwrite the old value.
+The `set-properties` command replaces older values if present. So using `set-properties` to set the same value twice will overwrite the old value.
If a property is not specified then it retains the last set value or the default, if no change was made.
A changed value can be unset by using a null value.
-.Revert changed value of triggerScheduleDelaySeconds to default value
+.Revert changed value of `triggerScheduleDelaySeconds` to default
[source.json]
----
{
@@ -616,4 +623,4 @@ A changed value can be unset by using a null value.
}
----
-The changed values of these properties, if any, can be read using the Autoscaling Read API in the `properties` section.
+The changed values of these properties, if any, can be read using the Autoscaling <<Read API>> in the `properties` section.