Apache Solr open-source search software
Ref Guide: typos, headline case, abbreviations, etc., for 9.0 only
Cassandra Targett053fa663646f
diff --git a/solr/solr-ref-guide/src/docker-faq.adoc b/solr/solr-ref-guide/src/docker-faq.adocindex dbb84c237d6..ea8f207d961 100644--- a/solr/solr-ref-guide/src/docker-faq.adoc+++ b/solr/solr-ref-guide/src/docker-faq.adoc@@ -247,7 +247,7 @@ SOLR_OPTS=-XX:-UseLargePagesIn your Solr Admin UI, you will see listed under the JVM args both the original `-XX:+UseLargePages`set by the `GC_TUNE` environment variable and further down the list the overriding `-XX:-UseLargePages` argument.-== I'm confused about the different invocations of solr -- help?+== I'm confused about the different invocations of Solr -- help?The different invocations of the Solr docker image can look confusing, because the name of theimage is "solr" and the Solr command is also "solr", and the image interprets various arguments indiff --git a/solr/solr-ref-guide/src/docker-networking.adoc b/solr/solr-ref-guide/src/docker-networking.adocindex 43cb8615488..608cfc69c56 100644--- a/solr/solr-ref-guide/src/docker-networking.adoc+++ b/solr/solr-ref-guide/src/docker-networking.adoc@@ -1,4 +1,4 @@-= Solr & Zookeeper with Docker Networking+= Solr & ZooKeeper with Docker Networking// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional informationdiff --git a/solr/solr-ref-guide/src/format-of-solr-xml.adoc b/solr/solr-ref-guide/src/format-of-solr-xml.adocindex f2cb41ab45b..dc76bb83f3f 100644--- a/solr/solr-ref-guide/src/format-of-solr-xml.adoc+++ b/solr/solr-ref-guide/src/format-of-solr-xml.adoc@@ -66,9 +66,10 @@ There are no attributes that you can specify in the `<solr>` tag, which is the r`configSetService`::This attribute does not need to be set.+-If used, this attribute should be set to the FQN (Fully qualified name) of a class that inherits from ConfigSetService , and you must provide a constructor with one param which the type is `org.apache.solr.core.CoreContainer` . For example, `<str name="configSetService">com.myorg.CustomConfigSetService</str>`.+If used, this attribute should be set to the FQN (Fully qualified name) of a class that inherits from `ConfigSetService`, and you must provide a constructor with one parameter which the type is `org.apache.solr.core.CoreContainer`.+For example, `<str name="configSetService">com.myorg.CustomConfigSetService</str>`.+-If this attribute isn't set, Solr uses the default configSetService , with zookeeper aware of `org.apache.solr.cloud.ZkConfigSetService`, without zookeeper aware of `org.apache.solr.core.FileSystemConfigSetService`.+If this attribute isn't set, Solr uses the default `configSetService`, with zookeeper aware of `org.apache.solr.cloud.ZkConfigSetService`, without zookeeper aware of `org.apache.solr.core.FileSystemConfigSetService`.`adminHandler`::This attribute does not need to be set.@@ -105,7 +106,7 @@ Solr will normally only access folders relative to `$SOLR_HOME`, `$SOLR_DATA_HOM[#_allow_urls]`allowUrls`::-Comma-separated list of Solr hosts to allow. The http/https protocol may be omitted, and only the host and port are checked, i.e. `10.0.0.1:8983/solr,10.0.0.1:8984/solr`.+Comma-separated list of Solr hosts to allow. The http/https protocol may be omitted, and only the host and port are checked, i.e., `10.0.0.1:8983/solr,10.0.0.1:8984/solr`.When running Solr in non-cloud mode and if planning to do distributed search (using the "shards" parameter), the list of hosts needs to be allowed or Solr will forbid the request. In Solr cloud mode, this allow-list is added to the cluster's live nodes to determine which hosts are allowed. The allow-list can also be configured with the `solr.allowUrls` system property (see its use in `solr.in.sh`).If you need to disable this feature for backwards compatibility, you can set the system property `solr.disable.allowUrls=true`.diff --git a/solr/solr-ref-guide/src/replica-placement-plugins.adoc b/solr/solr-ref-guide/src/replica-placement-plugins.adocindex 1dad0c26775..b7b7a43b16f 100644--- a/solr/solr-ref-guide/src/replica-placement-plugins.adoc+++ b/solr/solr-ref-guide/src/replica-placement-plugins.adoc@@ -41,7 +41,7 @@ plugins can be added - they have to implement a `PlacementPluginFactory` interfaconfiguration entry may also contain a `config` element if the plugin implements the`ConfigurablePlugin` interface.-=== Legacy replica placement+=== Legacy Replica PlacementBy default Solr 9.0 uses a legacy method for replica placements, which doesn't use a placementplugin at all. This method is used whenever the placement plugin configuration is missing orinvalid.@@ -210,7 +210,7 @@ must be located only on the nodes that are labeled with one or more of the matchCorrespondingly, the plugin configuration can specify that a particular collection must be placedonly on the nodes that match at least one of the (comma-separated) labels defined here.-=== Example configurations+=== Example ConfigurationsThis is a simple configuration that uses default values:[source,bash]diff --git a/solr/solr-ref-guide/src/running-solr-in-docker.adoc b/solr/solr-ref-guide/src/running-solr-in-docker.adocindex 96d8ef0aac7..02798176842 100644--- a/solr/solr-ref-guide/src/running-solr-in-docker.adoc+++ b/solr/solr-ref-guide/src/running-solr-in-docker.adoc@@ -77,7 +77,7 @@ you can simply run:docker-compose up -d-----=== Single-command demo+=== Single-Command DemoFor quick demos of Solr docker, there is a single command that starts Solr, creates a collection called "demo", and loads sample data into it:@@ -86,7 +86,7 @@ For quick demos of Solr docker, there is a single command that starts Solr, creadocker run --name solr_demo -d -p 8983:8983 solr solr-demo-----== How the image works+== How the Image WorksThe container contains an installation of Solr, as installed by the <<taking-solr-to-production.adoc#service-installation-script,service installation script>>.This stores the Solr distribution in `/opt/solr`, and configures Solr to use `/var/solr` to store data and logs, using the `/etc/default/solr` file for configuration.@@ -96,7 +96,7 @@ If you want to use custom configuration, mount it in the appropriate place. SeeThe Solr docker distribution adds scripts in `/opt/solr/docker/scripts` to make it easier to use under Docker, for example to create cores on container startup.-=== Creating cores+=== Creating CoresWhen Solr runs in standalone mode, you create "cores" to store data. On a non-Docker Solr, you would run the server in the background, then use the <<solr-control-script-reference.adoc#,Solr control script>> to create cores and load data. With Solr docker you have various options.@@ -133,7 +133,7 @@ Finally, you can run your own command-line and specify what to do, and even invodocker run -p 8983:8983 -v $PWD/mysetup.sh:/mysetup.sh --name my_solr solr bash -c "precreate-core gettingstarted && source /mysetup.sh && solr-foreground"-----=== Creating collections+=== Creating CollectionsIn a "SolrCloud" cluster you create "collections" to store data; and again you have several options for creating a core.@@ -163,9 +163,9 @@ curl 'http://localhost:8983/solr/admin/collections?action=CREATE&name=gettingsta----If you want to use a custom config for your collection, you first need to upload it, and then refer to it by name when you create the collection.-See the Ref guide on how to use the <<solr-control-script-reference.adoc#upload-a-configuration-set,ZooKeeper upload>> or the <<configsets-api.adoc#configsets-upload,ConfigSet API>>.+See the Ref guide on how to use the <<solr-control-script-reference.adoc#upload-a-configuration-set,ZooKeeper upload>> or the <<configsets-api.adoc#configsets-upload,Configsets API>>.-=== Loading your own data+=== Loading Your Own DataThere are several ways to load data; let's look at the most common ones.@@ -193,7 +193,7 @@ docker run --rm -v "$PWD/mydata:/mydata" --network=mycluster_solr solr post -cAlternatively, you can make the data available on a volume at Solr start time, and then load it from `docker exec` or a custom start script.-=== solr.in.sh configuration+=== solr.in.sh ConfigurationIn Solr it is common to configure settings in https://github.com/apache/solr/blob/main/solr/bin/solr.in.sh[solr.in.sh],as documented in the <<taking-solr-to-production.adoc#environment-overrides-include-file,Taking Solr to Production page>>.@@ -214,7 +214,7 @@ docker run -d -p 8983:8983 -e SOLR_HEAP=800m solrYou can also mount your own config file. Do no modify the values that are set at the end of the file.-=== Extending the image+=== Extending the ImageThe Solr docker image has an extension mechanism. At run time, before starting Solr, the container will execute scriptsin the `/docker-entrypoint-initdb.d/` directory. You can add your own scripts there either by using mounted volumes@@ -294,7 +294,7 @@ Changes:The Solr docker image runs Solr under https://github.com/krallin/tini[tini], to make signal handling work better; in particular, this allows you to `kill -9` the JVM. If you run `docker run --init`, or use `init: true` in `docker-compose.yml`, or have added `--init` to `dockerd`, docker will start its `tini` and docker-solr will notice it is not PID 1, and just `exec` Solr. If you do not run with `--init`, then the docker entrypoint script detects that it is running as PID 1, and will start the `tini` present in the docker-solr image, and run Solr under that. If you really do not want to run `tini`, and just run Solr as PID 1 instead, then you can set the `TINI=no` environment variable.-== Out of memory handling+== Out of Memory HandlingYou can use the `OOM` environment variable to control the behaviour of the Solr JVM when an out-of-memory error occurs.If you specify `OOM=exit`, Solr docker will add `-XX:+ExitOnOutOfMemoryError` to the JVM arguments, so that the JVM will exit.diff --git a/solr/solr-ref-guide/src/script-update-processor.adoc b/solr/solr-ref-guide/src/script-update-processor.adocindex 149f201b9b0..db86bd29ab2 100644--- a/solr/solr-ref-guide/src/script-update-processor.adoc+++ b/solr/solr-ref-guide/src/script-update-processor.adoc@@ -79,7 +79,7 @@ specified as a named list (`<lst>`) structure with nested typed parameters. Ifspecified, the script context will get a "params" object, otherwise there will be no "params" object available.-== Script execution context+== Script Execution ContextEvery script has some variables provided to it.@@ -205,7 +205,7 @@ def finish()end-----==== Known issues+==== Known IssuesThe following in JRuby does not work as expected for some reason, though it does work properly in JavaScript:diff --git a/solr/solr-ref-guide/src/task-management.adoc b/solr/solr-ref-guide/src/task-management.adocindex 9ec5b7e8613..208c70416e7 100644--- a/solr/solr-ref-guide/src/task-management.adoc+++ b/solr/solr-ref-guide/src/task-management.adoc@@ -33,7 +33,7 @@ To list all the active cancellable tasks currently running, please use the follo`\http://localhost:8983/solr/tasks/list`-==== Sample Response+=== Sample Response`{responseHeader={status=0, QTime=11370}, taskList={0=q=*%3A*&canCancel=true&queryUUID=0&_stateVer_=collection1%3A4&wt=javabin&version=2, 5=q=*%3A*&canCancel=true&queryUUID=5&_stateVer_=collection1%3A4&wt=javabin&version=2, 7=q=*%3A*&canCancel=true&queryUUID=7&_stateVer_=collection1%3A4&wt=javabin&version=2}`@@ -56,11 +56,8 @@ To check the status of a specific task, please use the following syntax:`\http://localhost:8983/solr/tasks/list?taskUUID=foobar`-==== taskUUID Parameter+=== taskUUID Parameter`taskUUID` parameter can be used to specify a task UUID whose status can be checked.-==== Sample Response+=== Sample Response`{responseHeader={status=0, QTime=6128}, taskStatus=foobar:true}`---