docs(15.9): move the install and upgrade guides to OpenSearch 3.9.0 and document the reindex an upgraded index needs - #564
Merged
Conversation
…nd document the reindex an upgraded index needs Fess 15.9 now runs on OpenSearch 3.9.0 (fess #3537), and fess-setup install opensearch installs 3.9.0, but the 15.9 pages still told readers to set up OpenSearch 3.8.0 and its 3.8.0 plugins. - Replace the OpenSearch version Fess 15.9 uses with 3.9.0 in install, install-linux, install-windows, prerequisites, run, troubleshooting, uninstall and upgrade, in all seven languages: download URLs, paths, the fess-opensearch image tag and the supported-version statements. The "3.8.0 and later refuse dictionaries outside the configuration directory" sentences and the configsync 3.8.0 note in admin-index-backup describe older versions and are kept. - Install the four Fess plugins by URL. From 3.8.1 on they are published to maven.codelibs.org only, and opensearch-plugin resolves the groupId:artifactId:version form against Maven Central only, so the old command form fails for 3.9.0. The commands now use the maven.codelibs.org URL, as the docker-fess image does, and a sentence under each command block says why. - Step 4 of the upgrade guide notes that a snapshot taken on 3.9.0 cannot be restored to 3.8.0 or earlier. - Add the section "Applying New Fields and Kana Normalization to an Existing Document Index". At startup 15.9 adds fields to the configuration, log and user indices only, so a document index created by 15.8 keeps its old mapping: owner and last_modifier (#3528) get mapped dynamically as text, and the kana and long-vowel-dash normalization (#3532) is missing from its analysis settings and mapping.txt. The section explains that Re-indexing with Replace Aliases and Reset Dictionaries applies both without a crawl, warns that Reset Dictionaries overwrites edited dictionaries, and that files already indexed need one crawl with Check Last Modified off to get their owner. Step 7 and the "Do I need to recreate the index?" answer link to it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fess 15.9 now runs on OpenSearch 3.9.0 (codelibs/fess#3537), and
bin/fess-setup install opensearchinstalls 3.9.0, but the 15.9 pages still told readers to set up OpenSearch 3.8.0 and its 3.8.0 plugins. This PR moves the 15.9 tree to 3.9.0 and adds the reindex step an index created by 15.8 needs. All seven languages (ja, en, de, es, fr, ko, zh-cn) are changed the same way.OpenSearch 3.9.0
install,install-linux,install-windows,prerequisites,run,troubleshooting,uninstallandupgrade. This covers download URLs, paths, thefess-opensearchimage tag and the supported-version statements.admin-index-backup: it describes older plugin versions.opensearch-analysis-fess,opensearch-analysis-extension,opensearch-minhashandopensearch-configsyncare published only on maven.codelibs.org.opensearch-plugin installresolves thegroupId:artifactId:versionform against Maven Central only, so that form fails for 3.9.0.opensearch/3.9image does, and each command block says why.Reindexing a document index created by 15.8
At startup, 15.9 adds missing fields to the configuration, log and user indices only (codelibs/fess#3517). It leaves the document index alone, so an index created by 15.8 does not get two 15.9 changes:
ownerandlast_modifierare mapped dynamically astext. As a result,owner:aliceandfacet.field=ownerdo not work.mapping.txt, so the existing index never receives it.The new upgrade section "Applying New Fields and Kana Normalization to an Existing Document Index" says:
SearchEngineClient#createIndexuploads them. Anyone who edited synonyms or other dictionaries should download them first and apply them again afterwards.Step 7 and the "Do I need to recreate the index?" FAQ now link to this section. The option names follow the admin labels (
labels.upgrade_reindex,labels.replace_aliases,labels.reset_dictionaries,labels.incremental_crawling) in each locale.Verification
main. Section structure, the number of system messages, and the counts of leftover raw``and|Fess|are unchanged.upgrade.rstresolves the newupgrade-reindex-new-fieldslabel with no new warnings.