docs: add upgrade & migration guide for Docker bootstrap removal and embedding rebuild flow (#2273)#2679
Open
yeyitech wants to merge 1 commit into
Open
Conversation
… and embedding rebuild flow (volcengine#2273) Multiple users hit the same blockers upgrading Docker images: 1. openviking.console.bootstrap removed in v0.3.19+ (Studio is bundled into the server now). 2. EmbeddingRebuildRequiredError when an upgrade ships with embedding- config drift. Maintainer @ZaynJarvis explicitly asked for this migration doc in volcengine#2273. PR volcengine#2618 covers the actionable error message; this PR adds the how-do-I-recover guide they referenced. Adds docs/en/guides/14-upgrades-and-migrations.md and the Chinese mirror, plus pointers from README/FAQ. Refs volcengine#2273 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
ZaynJarvis
requested changes
Jun 24, 2026
ZaynJarvis
left a comment
ZaynJarvis
left a comment
Collaborator
There was a problem hiding this comment.
checked, faq is good to kept, but 14-migration guide is not needed.
#2679 happens because docker compose need to upgrade.
also in faq, user could reference to https://docs.openviking.ai/zh/guides/09-ovpack if server can not be recovered, so to recover data with ov pack.
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
2 participants
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
Refs #2273. Adds a migration / upgrade guide covering the two blockers users have repeatedly hit:
openviking.console.bootstrapremoved in v0.3.19+ — Web Studio is bundled intoopenviking-servernow, but Dockercommand:lines that still invoke the standalone module fail withModuleNotFoundError. Documented with a before/afterdocker-compose.ymlsnippet.EmbeddingRebuildRequiredError— explains the two recovery paths: (A) roll back embedding config to keep data, (B) rebuild embeddings safely. The PR covers the safe sequence: back upvectordb/context, delete only that subdirectory (never business data), restart, reindex, verify.This is the doc maintainer
@ZaynJarvisasked for in the issue thread. PR #2618 addresses the actionable startup error; this PR is the user-facing recovery walkthrough.Files
docs/en/guides/14-upgrades-and-migrations.md(new)docs/zh/guides/14-upgrades-and-migrations.md(new, faithful translation)README.md/README_CN.md— link to the guide under Documentation.docs/en/faq/faq.md/docs/zh/faq/faq.md— Q&A entry pointing to the guide.Test plan
mkdocs serve(or whatever the docs build is) renders both new guides cleanly.Refs #2273