Skip to content

migration to 8.x.x version - #1153

Open
v-scharf wants to merge 1 commit into
mainfrom
migrate-to-8.0.0
Open

migration to 8.x.x version#1153
v-scharf wants to merge 1 commit into
mainfrom
migrate-to-8.0.0

Conversation

@v-scharf

@v-scharf v-scharf commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

migration for upcoming rolling release

Copilot AI lite review requested due to automatic review settings September 10, 2026 10:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

馃煛 Changes recommended

The new upgrade guides contain a few concrete doc defects/inconsistencies (unused MDX imports, a Docker Compose command that omits --force-rescan, and Bleve cleanup wording/path mismatch) that should be corrected before publishing.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds an OpenCloud 8.x.x upgrade guide focused on the search index migration, and links it from the upgrade section indexes across the current docs and two versioned doc sets.

Changes:

  • Add new upgrade-8.x.x documentation page under docs/ and versioned_docs/ (v7.2 and v4.0).
  • Document Bleve and OpenSearch re-indexing steps and post-migration cleanup guidance.
  • Link the new guide from each upgrade section index.md.
File summaries
File Description
docs/admin/maintenance/upgrade/upgrade-8.x.x.md New 8.x.x upgrade doc describing search index migration and re-index steps.
docs/admin/maintenance/upgrade/index.md Adds nav link to the new 8.x.x upgrade guide.
versioned_docs/version-7.2/admin/maintenance/upgrade/upgrade-8.x.x.md Backports the new 8.x.x upgrade doc into v7.2 versioned docs.
versioned_docs/version-7.2/admin/maintenance/upgrade/index.md Adds nav link to the new 8.x.x upgrade guide for v7.2 docs.
versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-8.x.x.md Backports the new 8.x.x upgrade doc into v4.0 versioned docs.
versioned_docs/version-4.0/admin/maintenance/upgrade/index.md Adds nav link to the new 8.x.x upgrade guide for v4.0 docs.
Review details

Suppressed comments (6)

docs/admin/maintenance/upgrade/upgrade-8.x.x.md:77

  • This section recommends a full re-index, but the Docker Compose command omits --force-rescan, which can lead to older/untouched files still not being searchable. Include --force-rescan to match the earlier instructions for a full re-index.
docker compose exec opencloud opencloud search index --all-spaces --insecure

versioned_docs/version-7.2/admin/maintenance/upgrade/upgrade-8.x.x.md:77

  • This section recommends a full re-index, but the Docker Compose command omits --force-rescan, which can lead to older/untouched files still not being searchable. Include --force-rescan to match the earlier instructions for a full re-index.
docker compose exec opencloud opencloud search index --all-spaces --insecure

versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-8.x.x.md:77

  • This section recommends a full re-index, but the Docker Compose command omits --force-rescan, which can lead to older/untouched files still not being searchable. Include --force-rescan to match the earlier instructions for a full re-index.
docker compose exec opencloud opencloud search index --all-spaces --insecure

docs/admin/maintenance/upgrade/upgrade-8.x.x.md:51

  • The text says you can remove all but the newest bleve-v<N> directory, but the example only deletes the legacy unsuffixed bleve directory and also hardcodes $OC_BASE_DATA_PATH/search. Consider aligning the wording with what the command does and using SEARCH_ENGINE_BLEVE_DATA_PATH (with a safe fallback) so it also works when the path is customized.
Once it is filled and verified, every directory except the one with the highest `bleve-v<N>` suffix can go (indexes up to 7.4 have no suffix):

```bash
rm -r "$OC_BASE_DATA_PATH/search/bleve"
**versioned_docs/version-7.2/admin/maintenance/upgrade/upgrade-8.x.x.md:51**
* The text says you can remove all but the newest `bleve-v<N>` directory, but the example only deletes the legacy unsuffixed `bleve` directory and also hardcodes `$OC_BASE_DATA_PATH/search`. Consider aligning the wording with what the command does and using `SEARCH_ENGINE_BLEVE_DATA_PATH` (with a safe fallback) so it also works when the path is customized.

Once it is filled and verified, every directory except the one with the highest bleve-v<N> suffix can go (indexes up to 7.4 have no suffix):

rm -r "$OC_BASE_DATA_PATH/search/bleve"
**versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-8.x.x.md:51**
* The text says you can remove all but the newest `bleve-v<N>` directory, but the example only deletes the legacy unsuffixed `bleve` directory and also hardcodes `$OC_BASE_DATA_PATH/search`. Consider aligning the wording with what the command does and using `SEARCH_ENGINE_BLEVE_DATA_PATH` (with a safe fallback) so it also works when the path is customized.

Once it is filled and verified, every directory except the one with the highest bleve-v<N> suffix can go (indexes up to 7.4 have no suffix):

rm -r "$OC_BASE_DATA_PATH/search/bleve"

- **Files reviewed:** 6/6 changed files
- **Comments generated:** 3
- **Review effort level:** Lite
</details>

---

馃挕 <a href="/opencloud-eu/docs/new/main?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=webui#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>

Comment thread docs/admin/maintenance/upgrade/upgrade-8.x.x.md Outdated
Comment thread versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-8.x.x.md Outdated
Comment thread versioned_docs/version-7.2/admin/maintenance/upgrade/upgrade-8.x.x.md Outdated
Comment thread docs/admin/maintenance/upgrade/upgrade-8.x.x.md

@fschade fschade left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

search LGTM, if i remember right, CSP changed too, should we also add a document for that?

@v-scharf

Copy link
Copy Markdown
Contributor Author

search LGTM, if i remember right, CSP changed too, should we also add a document for that?

I don鈥檛 know about that. Do we need it in migration guide? if not, let's do it in separate PR

@v-scharf
v-scharf requested a review from fschade September 10, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants