Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Phil Davis <[email protected]>
  • Loading branch information
mmattel and phil-davis authored Nov 21, 2024
1 parent 0f392d2 commit b8d85eb
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ ocis storage-users uploads sessions --resume
--

* *Particular failed uploads* +
Use the `postprocessing` command to resume defined failed uploads. For postprocessing steps, the default is to resume . Note that at the moment, `resume` is an alias for `restart` to keep old functionality. `restart` is subject of change and will most likely be removed in a later version.
Use the `postprocessing` command to resume defined failed uploads. For postprocessing steps, the default is to resume . Note that at the moment, `resume` is an alias for `restart` to keep old functionality. `restart` is subject to change and will most likely be removed in a later version.

** *Defined by ID*
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ NOTE: There can never be a clear identification of a failed upload session due t

[NOTE]
====
If not noted otherwise, the `restart` option can also be replaced the `resume` option. This changes behaviour slightly.
If not noted otherwise, the `restart` option can also be replaced with the `resume` option. This changes behaviour slightly.
* `restart` +
When restarting an upload, all steps for open items will be restarted, except if otherwise defined.
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/maintenance/commands/changed-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ See the link for a detailed description of the respective CLI command if availab

* xref:maintenance/commands/commands.adoc#manage-expired-uploads[Manage Expired Uploads] +
The `ocis storage-users uploads sessions --restart` command got an alternative `--resume` option. +
Resume can be used in the same way as restart with a slighly different behavior change.
Resume can be used in the same way as restart with a slightly different behavior.

* xref:maintenance/commands/commands.adoc#purge-expired-space-trash-bin-items[Purge Expired Space Trash-Bin Items] +
The `ocis storage-users uploads` got restructured. +
The deprecated `list` option is now removed, the `clean` option is now part of the `sessions command`.

* xref:maintenance/commands/commands.adoc#resume-post-processing[Resume Post-Processing] +
The `ocis postprocessing restart` command got an alternative `resume` option. +
Resume can be used in the same way as restart with a slighly different behavior change.
Resume can be used in the same way as restart with a slightly different behavior.

* xref:maintenance/commands/commands.adoc#reset-password-for-idm-users[Reset Password for IDM Users] +
The `ocis idm resetpassword` can now specify the user name via the `--user-name` (`-u`) flag.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/maintenance/commands/commands.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ WARNING: Use this command with absolute care. It is not intended to play around

=== Resume Post-Processing

If post-processing fails in one step due to an unforeseen error, current uploads will not be retried automatically. A system administrator can instead run a xref:{s-path}/postprocessing.adoc#cli-commands[CLI Commands] to retry the failed upload.
If post-processing fails in one step due to an unforeseen error, current uploads will not be retried automatically. A system administrator can instead run a xref:{s-path}/postprocessing.adoc#cli-commands[CLI Command] to retry the failed upload.


=== Roll Back / Roll Forward Decomposedfs Migrations
Expand Down
12 changes: 6 additions & 6 deletions modules/ROOT/pages/migration/upgrading_5.0.x_7.0.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Reconfigure the deployment to use the new image:

* The xref:{s-path}/collaboration.adoc[collaboration] service has been added. Though this service needs to be started manually, it requires a secret (preferred a random UUID string) when started. For safety reasons on a fresh install, this secret is added when running the `ocis init` command and should be added on upgrades. The used upgrade procedure provides a secret if not present in the config. Note that the secret can be overwritten in the config or with an environment variable if necessary.

** 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 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, they 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.

Expand All @@ -103,9 +103,9 @@ Reconfigure the deployment to use the new image:

* Environment variables that have been deprecated without successor can safely be removed from the configuration. These envvars do not harm as they are not used anymore.
* Environment variables that have been deprecated with a successor need to be updated accordingly.
* Environment variables that habe been removed from Infinite Scale can safely be removed from the config if set manually.
* Environment variables that have been removed from Infinite Scale can safely be removed from the config if set manually.

==== Add new Infnite Scale config settings
==== Add new Infinite Scale config settings

To do so, the following steps need to be taken, here is the *overview*:

Expand All @@ -124,7 +124,7 @@ Because this will now run the new ocis code, it will create two files in the con
. `ocis.config.patch` which contains all the changes that can be applied and
. `ocis.yaml.<time-stamp>.backup` containing a backup of the original config.

Note that after applying the patch file, the created files by the `--diff` option must be deleted manually.
Note that after applying the patch file, the files created by the `--diff` option must be deleted manually.

The diff option will NOT overwrite anything (except an earlier `ocis.config.patch`). It may ask questions though. Consider using the correct answer for `certificate checking` as this will influence the respective diff output.

Expand Down Expand Up @@ -214,7 +214,7 @@ patch < ocis.config.patch
* *Any Other Image Based Deployment*:
+
--
Use one of the Docker based examples from above and derive from.
Use one of the Docker based examples from above and adjust for your deployment.
--

=== Reconfigure web Office Document Deployments
Expand All @@ -226,7 +226,7 @@ The following steps are based on the xref:depl-examples/ubuntu-compose/ubuntu-co
* 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.
* Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#download-and-transfer-the-example[Download and Transfer 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.

Expand Down

0 comments on commit b8d85eb

Please sign in to comment.