-
Notifications
You must be signed in to change notification settings - Fork 34
migration to 8.x.x version #1153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
v-scharf
wants to merge
1
commit into
main
Choose a base branch
from
migrate-to-8.0.0
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| sidebar_position: 15 | ||
| id: upgrade-8.x.x | ||
| title: Upgrade 8.x.x | ||
| description: Upgrading to OpenCloud 8.x.x | ||
| draft: false | ||
| --- | ||
|
|
||
| # Upgrading to OpenCloud 8.x.x | ||
|
|
||
| This guide describes how to upgrade an existing OpenCloud deployment to OpenCloud 8.x.x. | ||
|
|
||
| It covers the search index migration introduced with OpenCloud 8.x.x. For the general upgrade steps (backup, stopping OpenCloud, pulling the new image, applying configuration changes and starting again), follow the [Standard Upgrade Guide](./upgrade.md). | ||
|
|
||
| ## Migrating the Search Index | ||
|
|
||
| A version that changes how resources are indexed builds a **new index** and leaves the old one untouched. The service starts normally. | ||
|
|
||
| **What to expect after updating to 8.0.0:** | ||
|
|
||
| - You get a **new, empty** index (e.g. `search/bleve-v4`); the old one stays around until you remove it. | ||
| - The new index **starts filling on its own** from live activity: any file you upload, move or change from now on is indexed right away, so search finds those. | ||
| - Files that existed before and are not touched are **not found** yet. | ||
| - To make everything searchable again, run a full re-index (see below). | ||
|
|
||
| :::note | ||
|
|
||
| The `search index` command reaches the search service over its internal gRPC endpoint. That transport is not TLS-encrypted by default (`OC_GRPC_CLIENT_TLS_MODE` defaults to `off`), so `--insecure` is needed; drop it only if you run gRPC with TLS. This is safe here — the command just triggers a rescan, the re-indexing runs inside the OpenCloud process. | ||
|
|
||
| ::: | ||
|
|
||
| ## v7.x.x → 8.x.x | ||
|
|
||
| ### bleve (default) | ||
|
|
||
| The new index is a directory next to the old one, both under `$OC_BASE_DATA_PATH/search` by default (`SEARCH_ENGINE_BLEVE_DATA_PATH`). A bleve index cannot be copied — re-index all spaces: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| 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" | ||
| ``` | ||
|
|
||
| ### OpenSearch | ||
|
|
||
| Re-index all spaces (the service keeps running while it happens). Run this in the **OpenCloud** container: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| Once it is filled and verified, every index except the one with the highest `-v<N>` suffix can go (indexes up to 7.4 have no suffix). Run the following `curl` commands in the **OpenSearch** container (or from any host that can reach the OpenSearch API). | ||
|
|
||
| List the indexes: | ||
|
|
||
| ```bash | ||
| curl "http://localhost:9200/_cat/indices/opencloud-resources*?v" | ||
| ``` | ||
|
|
||
| ```text | ||
| health status index uuid pri rep docs.count docs.deleted store.size pri.store.size | ||
| yellow open opencloud-resources-v4 h3DtDe7VQUGzoNPKh0yt6Q 1 1 1142 104 160.1mb 160.1mb | ||
| yellow open opencloud-resources DRDfEtFqS9ufYHaz-YU-3A 1 1 1142 51 145.2mb 145.2mb | ||
| ``` | ||
|
|
||
| Here `opencloud-resources-v4` is the newest, so delete the old `opencloud-resources`: | ||
|
|
||
| ```bash | ||
| curl -X DELETE "http://localhost:9200/opencloud-resources" | ||
| ``` | ||
|
|
||
| Adjust the host and index names to match your deployment. | ||
|
|
||
| ## Running It in Docker Compose | ||
|
|
||
| ```bash | ||
| docker compose exec opencloud opencloud search index --all-spaces --insecure | ||
| ``` | ||
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
94 changes: 94 additions & 0 deletions
94
versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-8.x.x.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| sidebar_position: 15 | ||
| id: upgrade-8.x.x | ||
| title: Upgrade 8.x.x | ||
| description: Upgrading to OpenCloud 8.x.x | ||
| draft: false | ||
| --- | ||
|
|
||
| # Upgrading to OpenCloud 8.x.x | ||
|
|
||
| This guide describes how to upgrade an existing OpenCloud deployment to OpenCloud 8.x.x. | ||
|
|
||
| It covers the search index migration introduced with OpenCloud 8.x.x. For the general upgrade steps (backup, stopping OpenCloud, pulling the new image, applying configuration changes and starting again), follow the [Standard Upgrade Guide](./upgrade.md). | ||
|
|
||
| ## Migrating the Search Index | ||
|
|
||
| A version that changes how resources are indexed builds a **new index** and leaves the old one untouched. The service starts normally. | ||
|
|
||
| **What to expect after updating to 8.0.0:** | ||
|
|
||
| - You get a **new, empty** index (e.g. `search/bleve-v4`); the old one stays around until you remove it. | ||
| - The new index **starts filling on its own** from live activity: any file you upload, move or change from now on is indexed right away, so search finds those. | ||
| - Files that existed before and are not touched are **not found** yet. | ||
| - To make everything searchable again, run a full re-index (see below). | ||
|
|
||
| :::note | ||
|
|
||
| The `search index` command reaches the search service over its internal gRPC endpoint. That transport is not TLS-encrypted by default (`OC_GRPC_CLIENT_TLS_MODE` defaults to `off`), so `--insecure` is needed; drop it only if you run gRPC with TLS. This is safe here — the command just triggers a rescan, the re-indexing runs inside the OpenCloud process. | ||
|
|
||
| ::: | ||
|
|
||
| ## v7.x.x → 8.x.x | ||
|
|
||
| ### bleve (default) | ||
|
|
||
| The new index is a directory next to the old one, both under `$OC_BASE_DATA_PATH/search` by default (`SEARCH_ENGINE_BLEVE_DATA_PATH`). A bleve index cannot be copied — re-index all spaces: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| 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" | ||
| ``` | ||
|
|
||
| ### OpenSearch | ||
|
|
||
| Re-index all spaces (the service keeps running while it happens). Run this in the **OpenCloud** container: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| Once it is filled and verified, every index except the one with the highest `-v<N>` suffix can go (indexes up to 7.4 have no suffix). Run the following `curl` commands in the **OpenSearch** container (or from any host that can reach the OpenSearch API). | ||
|
|
||
| List the indexes: | ||
|
|
||
| ```bash | ||
| curl "http://localhost:9200/_cat/indices/opencloud-resources*?v" | ||
| ``` | ||
|
|
||
| ```text | ||
| health status index uuid pri rep docs.count docs.deleted store.size pri.store.size | ||
| yellow open opencloud-resources-v4 h3DtDe7VQUGzoNPKh0yt6Q 1 1 1142 104 160.1mb 160.1mb | ||
| yellow open opencloud-resources DRDfEtFqS9ufYHaz-YU-3A 1 1 1142 51 145.2mb 145.2mb | ||
| ``` | ||
|
|
||
| Here `opencloud-resources-v4` is the newest, so delete the old `opencloud-resources`: | ||
|
|
||
| ```bash | ||
| curl -X DELETE "http://localhost:9200/opencloud-resources" | ||
| ``` | ||
|
|
||
| Adjust the host and index names to match your deployment. | ||
|
|
||
| ## Running It in Docker Compose | ||
|
|
||
| ```bash | ||
| docker compose exec opencloud opencloud search index --all-spaces --insecure | ||
| ``` |
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
94 changes: 94 additions & 0 deletions
94
versioned_docs/version-7.2/admin/maintenance/upgrade/upgrade-8.x.x.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| sidebar_position: 15 | ||
| id: upgrade-8.x.x | ||
| title: Upgrade 8.x.x | ||
| description: Upgrading to OpenCloud 8.x.x | ||
| draft: false | ||
| --- | ||
|
|
||
| # Upgrading to OpenCloud 8.x.x | ||
|
|
||
| This guide describes how to upgrade an existing OpenCloud deployment to OpenCloud 8.x.x. | ||
|
|
||
| It covers the search index migration introduced with OpenCloud 8.x.x. For the general upgrade steps (backup, stopping OpenCloud, pulling the new image, applying configuration changes and starting again), follow the [Standard Upgrade Guide](./upgrade.md). | ||
|
|
||
| ## Migrating the Search Index | ||
|
|
||
| A version that changes how resources are indexed builds a **new index** and leaves the old one untouched. The service starts normally. | ||
|
|
||
| **What to expect after updating to 8.0.0:** | ||
|
|
||
| - You get a **new, empty** index (e.g. `search/bleve-v4`); the old one stays around until you remove it. | ||
| - The new index **starts filling on its own** from live activity: any file you upload, move or change from now on is indexed right away, so search finds those. | ||
| - Files that existed before and are not touched are **not found** yet. | ||
| - To make everything searchable again, run a full re-index (see below). | ||
|
|
||
| :::note | ||
|
|
||
| The `search index` command reaches the search service over its internal gRPC endpoint. That transport is not TLS-encrypted by default (`OC_GRPC_CLIENT_TLS_MODE` defaults to `off`), so `--insecure` is needed; drop it only if you run gRPC with TLS. This is safe here — the command just triggers a rescan, the re-indexing runs inside the OpenCloud process. | ||
|
|
||
| ::: | ||
|
|
||
| ## v7.x.x → 8.x.x | ||
|
|
||
| ### bleve (default) | ||
|
|
||
| The new index is a directory next to the old one, both under `$OC_BASE_DATA_PATH/search` by default (`SEARCH_ENGINE_BLEVE_DATA_PATH`). A bleve index cannot be copied — re-index all spaces: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| 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" | ||
| ``` | ||
|
|
||
| ### OpenSearch | ||
|
|
||
| Re-index all spaces (the service keeps running while it happens). Run this in the **OpenCloud** container: | ||
|
|
||
| ```bash | ||
| opencloud search index --all-spaces --force-rescan --insecure | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| Before deleting, check that search works (search for older, untouched files). | ||
|
|
||
| ::: | ||
|
|
||
| Once it is filled and verified, every index except the one with the highest `-v<N>` suffix can go (indexes up to 7.4 have no suffix). Run the following `curl` commands in the **OpenSearch** container (or from any host that can reach the OpenSearch API). | ||
|
|
||
| List the indexes: | ||
|
|
||
| ```bash | ||
| curl "http://localhost:9200/_cat/indices/opencloud-resources*?v" | ||
| ``` | ||
|
|
||
| ```text | ||
| health status index uuid pri rep docs.count docs.deleted store.size pri.store.size | ||
| yellow open opencloud-resources-v4 h3DtDe7VQUGzoNPKh0yt6Q 1 1 1142 104 160.1mb 160.1mb | ||
| yellow open opencloud-resources DRDfEtFqS9ufYHaz-YU-3A 1 1 1142 51 145.2mb 145.2mb | ||
| ``` | ||
|
|
||
| Here `opencloud-resources-v4` is the newest, so delete the old `opencloud-resources`: | ||
|
|
||
| ```bash | ||
| curl -X DELETE "http://localhost:9200/opencloud-resources" | ||
| ``` | ||
|
|
||
| Adjust the host and index names to match your deployment. | ||
|
|
||
| ## Running It in Docker Compose | ||
|
|
||
| ```bash | ||
| docker compose exec opencloud opencloud search index --all-spaces --insecure | ||
| ``` |
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.
Uh oh!
There was an error while loading. Please reload this page.