This is an automated email from the ASF dual-hosted git repository.
gerlowskija pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 0a6f79dcda3 Remove 'IndexUpgraderTool' page from ref-guide (#2500)
0a6f79dcda3 is described below
commit 0a6f79dcda3c60e8aeadad418b8b6340f21ff6b5
Author: Jason Gerlowski <[email protected]>
AuthorDate: Thu Jun 20 13:00:47 2024 -0400
Remove 'IndexUpgraderTool' page from ref-guide (#2500)
The IndexUpgraderTool doesn't have a clear use case for Solr users, and
after some discussion on the mailing list we decided documenting it
isn't worth the confusion it causes for users.
This commit removes the related page from our ref-guide.
---
.../modules/deployment-guide/deployment-nav.adoc | 1 -
.../deployment-guide/pages/indexupgrader-tool.adoc | 53 ----------------------
.../pages/upgrading-a-solr-cluster.adoc | 6 ++-
.../pages/major-changes-in-solr-7.adoc | 1 -
4 files changed, 5 insertions(+), 56 deletions(-)
diff --git a/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc
b/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc
index 5ba4dd59fb0..cdf02d39dde 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc
@@ -25,7 +25,6 @@
** xref:taking-solr-to-production.adoc[]
** xref:jvm-settings.adoc[]
** xref:upgrading-a-solr-cluster.adoc[]
-*** xref:indexupgrader-tool.adoc[]
** xref:backup-restore.adoc[]
** xref:solr-in-docker.adoc[]
*** xref:docker-faq.adoc[]
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/indexupgrader-tool.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/indexupgrader-tool.adoc
deleted file mode 100644
index e6aa84ff1da..00000000000
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/indexupgrader-tool.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-= IndexUpgraderTool
-// 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.
-
-The Lucene distribution includes
{lucene-javadocs}/core/org/apache/lucene/index/IndexUpgrader.html[a tool that
upgrades] an index from the previous Lucene version to the current file format.
-
-The tool can be used from command line, or it can be instantiated and executed
in Java.
-
-[IMPORTANT]
-====
-Indexes can *only* be upgraded from the previous major release version to the
current major release version.
-
-This means that the IndexUpgraderTool in any Solr 8.x release, for example,
can only work with indexes from 7.x releases, but cannot work with indexes from
Solr 6.x or earlier.
-
-If you are currently using a release two or more major versions older, such as
moving from Solr 6x to Solr 8x, you will need to reindex your content.
-
-The IndexUpgraderTool performs a forceMerge (optimize) down to one segment,
which may be undesirable.
-====
-
-In a Solr distribution, the Lucene files are located in
`./server/solr-webapp/webapp/WEB-INF/lib`.
-You will need to include the `lucene-core-<version>.jar` and
`lucene-backwards-codecs-<version>.jar` on the classpath when running the tool.
-
-[source,bash,subs="attributes"]
-----
-java -cp
lucene-core-{dep-version-lucene}.jar:lucene-backward-codecs-{dep-version-lucene}.jar
org.apache.lucene.index.IndexUpgrader [-delete-prior-commits] [-verbose]
/path/to/index
-----
-
-This tool keeps only the last commit in an index.
-For this reason, if the incoming index has more than one commit, the tool
refuses to run by default.
-Specify `-delete-prior-commits` to override this, allowing the tool to delete
all but the last commit.
-
-Upgrading large indexes may take a long time.
-As a rule of thumb, the upgrade processes about 1 GB per minute.
-
-[WARNING]
-====
-This tool may reorder documents if the index was partially upgraded before
execution (e.g., documents were added).
-If your application relies on monotonicity of document IDs (i.e., the order in
which the documents were added to the index is preserved), do a full optimize
instead.
-====
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/upgrading-a-solr-cluster.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/upgrading-a-solr-cluster.adoc
index c3d58219342..a2efff5a5aa 100644
---
a/solr/solr-ref-guide/modules/deployment-guide/pages/upgrading-a-solr-cluster.adoc
+++
b/solr/solr-ref-guide/modules/deployment-guide/pages/upgrading-a-solr-cluster.adoc
@@ -1,5 +1,4 @@
= Upgrading a Solr Cluster
-:page-children: indexupgrader-tool
// 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
@@ -22,6 +21,11 @@ This page covers how to upgrade an existing Solr cluster
that was installed usin
IMPORTANT: The steps outlined on this page assume you use the default service
name of `solr`.
If you use an alternate service name or Solr installation directory, some of
the paths and commands mentioned below will have to be modified accordingly.
+NOTE: Previous versions of this reference guide mentioned an
{lucene-javadocs}/core/org/apache/lucene/index/IndexUpgrader.html[IndexUpgraderTool]
that is made available by the Lucene project, and that can be used to upgrade
Solr index files offline if desired.
+Users with a business requirement that necessitates its use may use this tool
as before, however it's not needed in the vast majority of upgrade workflows.
+The documentation below assumes the tool is not in use.
+
+
== Planning Your Upgrade
Here is a checklist of things you need to prepare before starting the upgrade
process:
diff --git
a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc
b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc
index b1f726a9288..1aab84288c9 100644
---
a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc
+++
b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc
@@ -33,7 +33,6 @@ However, if reindexing is not feasible, keep in mind you can
only upgrade one ma
Thus, Solr 6.x indexes will be compatible with Solr 7 but Solr 5.x indexes
will not be.
If you do not reindex now, keep in mind that you will need to either reindex
your data or upgrade your indexes before you will be able to move to Solr 8
when it is released in the future.
-See the section xref:deployment-guide:indexupgrader-tool.adoc[] for more
details on how to upgrade your indexes.
See also the section xref:deployment-guide:upgrading-a-solr-cluster.adoc[] for
details on how to upgrade a SolrCloud cluster.
