Repository navigation
Document ServiceControl upgrades that rebuild RavenDB indexes - #8577
Open
mauroservienti wants to merge 3 commits into
Open
mauroservienti wants to merge 3 commits into
mauroservienti wants to merge 3 commits into
Conversation
Explain how side-by-side index replacement works, its storage requirements, and how to upgrade audit instances one at a time with ingestion disabled.
…e guide Add a warning at the top of the guide and link the audit index section to the procedure for upgrades that rebuild indexes.
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.
Some ServiceControl versions change RavenDB index definitions, which triggers a side-by-side index rebuild at the first start-up after the upgrade. Until now there was no general guidance on how to handle this, only version-specific notes.
Changes
servicecontrol/upgrades/index.md: new "Upgrades that rebuild indexes" section that:ServiceControl.Audit/IngestAuditMessages, upgrade, wait for the rebuild and swap, enable ingestion, move on to the next instanceservicecontrol/upgrades/6.19to6.20.md: adds a warning at the top about theMessagesViewIndexrebuild, and links the audit index section to the new procedure.Verification
Validated against the ServiceControl codebase that index deployment does not depend on the ingestion setting:
RavenPersistenceLifecycleHostedServiceis always registered by the RavenDB persistence and runsDatabaseSetup.Execute, which callsCreateIndexesat every start-up.IngestAuditMessagesonly controls whether theAuditIngestionhosted service is registered, and whether the audit queues are created during setup.IngestErrorMessagessimilarly only gates error queue creation and ingestion.Mixed versions between the primary error instance and audit instances during a one-at-a-time upgrade are covered by ServiceControl backward compatibility.