Upgrade process from 4.0.x to 7.0.x#863
Conversation
| docker compose logs -f | ||
| ``` | ||
|
|
||
| ## Watch for migration messages and ensure no errors occur |
There was a problem hiding this comment.
I guess we should at least mention here, where to look for those migration messages.
The description in opencloud-eu/opencloud#2760 (comment) has some details about that. You might want to include those here.
If you have questions, I can assist you with that.
| ## Before starting the upgrade | ||
|
|
||
| - Ensure you have OpenCloud 4.0.7 installed | ||
| - Create a complete backup of your configuration and data. |
There was a problem hiding this comment.
should line 152 to 159 not be in the bash part?
There was a problem hiding this comment.
cd /etc/opencloud need to be in the next line
There was a problem hiding this comment.
note, that id and secret changes
There was a problem hiding this comment.
does the opencloud now work? I think exit the container and start the container again
|
@rhafer @aduffeck @dragonchaser Which version of OpenCloud must be installed to upgrade to 7.x.x |
| - Bind Mounts | ||
|
|
||
| :::note | ||
| The migration search index updates is related ONLY people who uses opensearch |
There was a problem hiding this comment.
| The migration search index updates is related ONLY people who uses opensearch | |
| The migration search index updates are only relevant for instances that use opensearch |
| ```yaml | ||
| service_account: | ||
| service_account_id: example_id | ||
| service_account_secret: example_secret |
There was a problem hiding this comment.
do we have best practices for secrets? if so a link here might be helpful.
|
|
||
| ## Before starting the upgrade | ||
|
|
||
| - Ensure you have OpenCloud 6.x for rolling or 4.x for stable installed. |
There was a problem hiding this comment.
| - Ensure you have OpenCloud 6.x for rolling or 4.x for stable installed. | |
| - Ensure you have OpenCloud 6.x (rolling) or 4.x (stable) installed. |
stable-4.0.7 or the latest rolling-6.x release (just repeating it here to avoid double work) |
… rename 7.0.x to 7.x.x
|
@ScharfViktor @micbar could you please have a look again? |
it looks good 👍 |
| ```bash | ||
| docker compose up -d | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The OpenSearch Part is missing now.
|
|
||
| ## Before You Start | ||
|
|
||
| - Make sure your current OpenCloud deployment runs OpenCloud 6.x rolling or OpenCloud 4.x stable. |
There was a problem hiding this comment.
| - Make sure your current OpenCloud deployment runs OpenCloud 6.x rolling or OpenCloud 4.x stable. | |
| - Make sure your current deployment is running on OpenCloud 6.x (rolling) or OpenCloud 4.x (stable). |
|
|
||
| :::important | ||
|
|
||
| Always create a backup before upgrading to prevent data loss. |
There was a problem hiding this comment.
You already wrote this in line 26
| <Tabs> | ||
| <TabItem value="bind-mounts" label="Using Bind Mounts"> | ||
|
|
||
| If your configuration and data are stored in host directories, create a copy of these directories. |
There was a problem hiding this comment.
what are host directories?
|
|
||
| ## Update the `opencloud-compose` Checkout | ||
|
|
||
| If you use the `opencloud-compose` repository, update your local checkout before pulling the new container image. |
There was a problem hiding this comment.
| If you use the `opencloud-compose` repository, update your local checkout before pulling the new container image. | |
| If you use the `opencloud-compose` repository, update your local copy of the repository. |
| git pull | ||
| ``` | ||
|
|
||
| Skip this step if you run OpenCloud with plain Docker. |
There was a problem hiding this comment.
IMHO obsolete since this is obvious.
| docker pull opencloudeu/opencloud:7.x.x | ||
| ``` | ||
|
|
||
| Replace `7.x.x` with the exact OpenCloud version you want to upgrade to. |
There was a problem hiding this comment.
Might need a description of the differences between the tags :7 and :7.x or 7.x.x
| docker run --rm -it --entrypoint /bin/sh -v "<opencloud-config-volume>:/etc/opencloud" opencloudeu/opencloud:7.x.x | ||
| ``` | ||
|
|
||
| Replace `<opencloud-config-volume>` with the Docker volume that contains your OpenCloud configuration. |
There was a problem hiding this comment.
this might not necessarily be a docker volume, this could also be a bind mount....
afaik every major should work from 4.0 but we should run test-scenarios for that.... |
|
|
||
| #### Background | ||
|
|
||
| OpenCloud 7.x.x includes an updated Share Manager migration. Due to an issue in OpenCloud 7.0.0, some disabled Spaces were not fully processed during the initial migration. To ensure all existing Space memberships are migrated correctly, the migration task is executed again during the first startup after upgrading. |
There was a problem hiding this comment.
Please use a text from the 7.0.0 release notes as a guidiance (https://github.com/opencloud-eu/opencloud/releases/tag/v7.0.0).
The current text seems to be based on the 7.1.0 release notes. People upgrading from 4.0.7 to the next stable release won't be affected by that issue. For them the stuff that is written in the 7.0.0 release notes about the spacemember migration is most relevant.
| OpenCloud 7.0.0 introduced a new backend mechanism for managing Space memberships. When upgrading from an earlier release, the `sharing` service automatically migrates existing memberships to the new format. | ||
|
|
||
| Depending on the size of your installation, this process may take several minutes to complete. | ||
| In OpenCloud 7.1.0, the migration process was updated to address an issue where some disabled Spaces were not fully processed during the initial migration. To ensure all existing Space memberships are migrated correctly, the migration task is executed again during the first startup after upgrading. |
There was a problem hiding this comment.
You can leave out this paragraph. People updating from 4.0.x to the next stable release are not affected by this. This was purely an issue for people that were on 7.0.0 at some point.
| #### Background | ||
|
|
||
| OpenCloud 7.x.x includes an updated Share Manager migration. Due to an issue in OpenCloud 7.0.0, some disabled Spaces were not fully processed during the initial migration. To ensure all existing Space memberships are migrated correctly, the migration task is executed again during the first startup after upgrading. | ||
| OpenCloud 7.0.0 introduced a new backend mechanism for managing Space memberships. When upgrading from an earlier release, the `sharing` service automatically migrates existing memberships to the new format. |
There was a problem hiding this comment.
I am not sure we should mention 7.0.0 here. People that just follow the stable releases won't even know that 7.0.0 ever existed. Maybe just leave it at 7.x
Upgrading process from 4.0.x to 7.0.x