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

ocis 3.1 upgrade #576

Merged
merged 7 commits into from
Aug 4, 2023
Merged
Changes from 1 commit
Commits
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
Next Next commit
ocis upgrade steps
  • Loading branch information
mmattel committed Aug 4, 2023
commit b492a723edf11d544d9518e02a9d2201eb53ac79
57 changes: 56 additions & 1 deletion modules/ROOT/pages/migration/upgrading-ocis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,64 @@

NOTE: For any Infinite Scale version to upgrade to, see {ocis-downloadpage-url}?sort=time&order=desc[download.owncloud.com,window=_blank] or {docker-ocis-url}[Infinite Scale image] to get the right version.

IMPORTANT: Before starting any upgrade, make a xref:maintenance/b-r/backup.adoc[backup] first.

IMPORTANT: If not explicitly mentioned, any upgrade is forward only and a backstep is neither supported nor recommended and will most likely break the instance.

IMPORTANT: Before starting any upgrade, make a xref:maintenance/b-r/backup.adoc[backup] first.
IMPORTANT: When upgrading from the current running release to the desired one, *ALL* upgrade steps from each release must be taken in order and none must be skipped.
mmattel marked this conversation as resolved.
Show resolved Hide resolved

== Version 3.0.0 to 3.1.0

=== Notable Changes Requiring Manual Intervention

* The space index of the decomposedFS will be automatically migrated from symlinks to messagepack. This migration needs preperation to run successfully.
EParzefall marked this conversation as resolved.
Show resolved Hide resolved
* The xref:deployment/container/orchestration/orchestration.adoc#using-helm-charts-with-infinite-scale[Helm Chart] has been upgraded.

=== Upgrade Steps

. Shut down the Infinite Scale instance.
. Update Infinite Scale via:
+
--
* Docker
+
[source,bash]
----
docker pull owncloud/ocis:3.1.0
----

* or get the binary from the link above.
--

. Migrate the Space Index to Messagepack: +
It is important to disable clients and users logging in while the space index migration to `messagepack` is in progress. To do so, start Infinite Scale with only two necessary services. The example uses the binary as base:
+
--
[source,bash]
----
OCIS_RUN_SERVICES="storage-users,nats" \
ocis server
----

Because the proxy service is not running, no clients or users can login. During the restart of Infinite Scale, the symlinks of spaces in the DecomposedFS will be migrated to `messagepack` _automatically_ via the `storage-users` service. The start of the migration can be identified in the log with a message like:
EParzefall marked this conversation as resolved.
Show resolved Hide resolved

[source,plaintext]
----
{"level":"info","root":"/var/lib/ocis/storage/users","time":"2023-06-16T12:21:49.441395153Z","caller":"github.com/cs3org/reva/[email protected]/pkg/storage/utils/decomposedfs/migrator/0003_switch_to_messagepack_metadata.go:45","message":"Migrating to messagepack metadata backend..."}
mmattel marked this conversation as resolved.
Show resolved Hide resolved
----

When migration has finished - which can take a while depending on the quantity of files - you can see a log message like below:
EParzefall marked this conversation as resolved.
Show resolved Hide resolved

[source,plaintext]
----
{"level":"info","time":"2023-06-16T12:30:05.267986656Z","caller":"github.com/cs3org/reva/[email protected]/pkg/storage/utils/decomposedfs/migrator/0003_switch_to_messagepack_metadata.go:106","message":"done."}`
mmattel marked this conversation as resolved.
Show resolved Hide resolved
----

Finally start the Infinite Scale instance as usual.
--

. Check your Instance +
When the instance has started successfully, check the logs for any unusual entries.

== Version 2.0.0 to 3.0.0

Expand Down