Skip to content
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

Migration and Update Guide for 5 to 7 #1029

Open
wants to merge 29 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
bda0bde
Migration and Update Guide Changes
mmattel Oct 25, 2024
4d33718
overview update
mmattel Oct 27, 2024
7234243
ocis init --diff (not finished)
mmattel Oct 27, 2024
e335f89
update details (breaking changes)
mmattel Oct 27, 2024
83f4018
updates
mmattel Oct 28, 2024
3db96d8
Apply suggestions from code review
mmattel Oct 28, 2024
7d43f4b
add changed cli commands
mmattel Oct 28, 2024
d0075a0
more cli command updates
mmattel Oct 28, 2024
b2c9884
add searvice health
mmattel Oct 29, 2024
d2f7561
link service health
mmattel Oct 29, 2024
40e6066
text fixes
mmattel Oct 29, 2024
3cb4a4b
docker run changes
mmattel Oct 30, 2024
6c363aa
move cli changes
mmattel Oct 30, 2024
fd5ef9b
Apply suggestions from code review
mmattel Oct 30, 2024
b667915
cli restart and resume
mmattel Nov 4, 2024
d9523b4
small fixes
mmattel Nov 4, 2024
e26696a
update envvars changes
mmattel Nov 7, 2024
8fea923
numbered sections (unfinished)
mmattel Nov 8, 2024
619ed12
numbered sections (finished)
mmattel Nov 8, 2024
ef8ce22
update binary upgrade steps
mmattel Nov 11, 2024
0e8e22b
add note if patch command is missing
mmattel Nov 11, 2024
c3fa54a
Merge branch 'master' into migrate_5_to_7
mmattel Nov 13, 2024
80a3bc2
add collaboration related stuff
mmattel Nov 13, 2024
734fee2
fix collaboration reason
mmattel Nov 13, 2024
d5f058c
fixes service health text
mmattel Nov 14, 2024
fab442c
Merge branch 'master' into migrate_5_to_7
mmattel Nov 14, 2024
ed37ccb
docs: avoid sloppy language. Throu -> trough; dangling adverb 'first'…
jnweiger Nov 14, 2024
e1be535
Merge pull request #1049 from owncloud/language-review-5-7
mmattel Nov 15, 2024
2360692
Apply suggestions from code review
mmattel Nov 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion modules/ROOT/pages/migration/upgrading_5.0.x_7.0.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ Reconfigure the deployment to use the new image:

* All environment variables that were marked for deprecation in Infinite Scale release 5.0.x have finally been removed.
* A new mandatory Infinite Scale config setting for the `activitylog` service named `service_account` has been added.
* A new mandatory Infinite Scale config setting for the `collaboration` service named `secret` has been added.
* Deployment examples based on one of the `Ubuntu with Docker Compose` deployments have been updated/upgraded.

=== How to Identify if You Are Affected

Expand All @@ -89,6 +91,12 @@ Reconfigure the deployment to use the new image:

* Because the xref:{s-path}/activitylog.adoc[activitylog] service has been added and is started automatically, _everyone_ who upgrades is affected.

* Because the xref:{s-path}/collaboration.adoc[collaboration] service has been added and is started automatically, _everyone_ who upgrades is affected.
mmattel marked this conversation as resolved.
Show resolved Hide resolved

** If you have used web office document servers such as Collabora, ONLYOFFICE or Microsoft using the WOPI protocol with the external https://github.com/cs3org/wopiserver[cs3org/wopi] server, we highly recommend switching to the xref:{s-path}/collaboration.adoc[collaboration] service which requires deployment reconfiguration which is a breaking change. Though the environment variables from the xref:{s-path}/app-provider.adoc[app-provider] service formerly used for web office document deployments are currently not deprecated, the are a candidate for future deprecations.

* If you have used a rolling release and deployed web office document servers like the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] or the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner] deployment example, you should follow the reconfiguration section below because the deployment files have been updated/upgraded.

=== How to Manage the Change

==== Manage deprecated variables
Expand Down Expand Up @@ -209,9 +217,24 @@ patch < ocis.config.patch
Use one of the Docker based examples from above and derive from.
--

=== Reconfigure web Office Document Deployments

With the introduction of the xref:{s-path}/collaboration.adoc[collaboration] service, the external https://github.com/cs3org/wopiserver[cs3org/wopi] server is no longer required. Deployments using the external cs3org/wopi server should upgrade. This upgrade is a breaking change, but if you have used one of the `Ubuntu with Docker Compose` deployment examples, a re-deployment is quite easy. If you have setup your own deployment not based on the examples, you can derive from the changes based on the deployment files.

The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] deployment example. The steps are identical for the xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner].

* Backup the the base folder containing the existing deployment example by renaming it. +
You will need your configuration details with the new example.

* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer the Example] to get the new deployment and extract it as described in the following section of the guide.

* Reconfigure the new `.env` file based on settings made in the `.env` file of the backup.

== Start Infinite Scale

When you have finished upgrading, you can now start infinite Scale as ususal.
When you have finished upgrading, you now can start Infinite Scale as ususal.

For any deployment used, you now can delete/remove old binaries or images/containers.

:sectnums!:

Expand Down