You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ge...@apache.org on 2023/05/05 12:50:43 UTC
[solr] branch branch_9x updated: SOLR-16697: Align install-shard docs
This is an automated email from the ASF dual-hosted git repository.
gerlowskija pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new 06266c8ab87 SOLR-16697: Align install-shard docs
06266c8ab87 is described below
commit 06266c8ab877ba0e001f78ca9134e457ab042941
Author: Jason Gerlowski <ge...@apache.org>
AuthorDate: Fri May 5 08:12:28 2023 -0400
SOLR-16697: Align install-shard docs
The "Install Shard" API docs used the wrong v1 "command" or "action"
name. This commit corrects them, so that 'INSTALLSHARDDATA' is now used
instead of "INSTALLSHARD".
---
solr/CHANGES.txt | 2 +-
.../modules/deployment-guide/pages/shard-management.adoc | 10 +++++-----
.../modules/upgrade-notes/pages/major-changes-in-solr-9.adoc | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 0d4841cd346..8819087ba02 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -11,7 +11,7 @@ New Features
---------------------
* SOLR-16697: Solr now provides an "Install Shard" API that allows users who have built (per-shard) indices offline to import
them into SolrCloud shards. The API is available at `POST /api/collections/collName/shards/shardName/install`
- (v2), or at `GET /solr/admin/collections?action=INSTALLSHARD` (v1). (Jason Gerlowski)
+ (v2), or at `GET /solr/admin/collections?action=INSTALLSHARDDATA` (v1). (Jason Gerlowski)
* SOLR-16742: Produce a slim Solr binary and docker image, without the Prometheus Exporter and Solr Modules. (Houston Putman)
diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc
index 2efad25dea1..2d5c46fcb77 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc
@@ -631,13 +631,13 @@ This parameter is required.
WARNING: This is an expert level command, and should be invoked only when regular leader election is not working.
This may potentially lead to loss of data in the event that the new leader doesn't have certain updates, possibly recent ones, which were acknowledged by the old leader before going down.
-[[installshard]]
-== INSTALLSHARD: Install/Import Data to Shard
+[[installsharddata]]
+== INSTALLSHARDDATA: Install/Import Data to Shard
Under normal circumstances, data is added to Solr collections (and the shards that make them up) by xref:indexing-guide:indexing-with-update-handlers.adoc[indexing] documents.
However some use-cases require constructing per-shard indices offline.
Often this is done as a means of insulating query traffic from indexing load, or because the ETL pipeline in use is particularly complex.
-The INSTALLSHARD API allows installation of these pre-constructed indices into individual shards within a collection.
+The INSTALLSHARDDATA API allows installation of these pre-constructed indices into individual shards within a collection.
Installation copies the index files into all replicas within the shard, overwriting any preexisting data held by that shard.
To install data into a shard, the collection owning that shard must first be put into "readOnly" mode, using the xref:deployment-guide:collection-management.adoc#modifycollection[MODIFYCOLLECTION API].
@@ -659,7 +659,7 @@ Users are responsible for ensuring that the index installed to a shard is compat
[source,text]
----
-http://localhost:8983/solr/admin/collections?action=INSTALLSHARD&collection=techproducts&shard=shard1&repository=localfs&location=/mounts/myNFSDrive/tech/shard1/data/index
+http://localhost:8983/solr/admin/collections?action=INSTALLSHARDDATA&collection=techproducts&shard=shard1&repository=localfs&location=/mounts/myNFSDrive/tech/shard1/data/index
----
*Output*
@@ -703,7 +703,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/in
====
--
-=== INSTALLSHARD Parameters
+=== INSTALLSHARDDATA Parameters
`collection`::
+
diff --git a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
index f92d0919956..250ae993d7e 100644
--- a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
+++ b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
@@ -71,7 +71,7 @@ The xref:deployment-guide:installing-solr.adoc#available-solr-packages[Installin
Please refer to the https://solr.apache.org/downloads.html[Solr Downloads] site for information on how to download these offerings.
=== Shard Management
-* Solr now provides an xref:deployment-guide:shard-management.adoc#installshard[INSTALLSHARD] API to allow users who have built (per-shard) indices offline to import them into SolrCloud shards.
+* Solr now provides an xref:deployment-guide:shard-management.adoc#installsharddata["Install Shard"] API to allow users who have built (per-shard) indices offline to import them into SolrCloud shards.
== Solr 9.3
=== Improvements to Solr CLI