[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example #9412

mmattel · 2024-06-19T10:18:20Z

References: #9388 (New community ready deployment example using WOPI necessary)
Supersedes: #9394 ([docs-only] Create new 'ocis_wopi_community' deployment example)

Because there are many structural changes, I created a new PR instead of overwriting #9394.

Adapted FORWARD port to master necessary.

Changes:

Making the complete setup modular, only traefik is in the main compose file.
This eases testing a lot !
Making all other compose setups selectable via the .env file.
- ocis, wopiserver, tika and collabora are enabled by in the .env file but can be commented
- All other compose setups can individually be included by uncommenting the respective include
- All compose setups but traefik have their OWN compose folder which makes developing and updating much easier. Also if a new setup will be added like collaboration and wopiserver gets retired, we can easily do that now without messing up one singe compose file.
Image updates:
- traefik: 2.9.1 --> 3.0.3
- collabora: 23.05.5.2.1 --> 23.05.10.1.1
  Note that the latest version 24.x is not working as it cant update a file but you need to create a copy.
- wopiserver: 10.4.0 --> 10.5.0

One open issue:
I was not able to start the traefik dashboard despite setting the corresponding var in the .env file. Note that I was also not able to run a dasboard deployment example. Also see traefik/operations/dashboard/.

Suggested checks:

OnlyOffice could be updated to 8.0.1, see inline comment but this needs testing
Companion could be updated to 4.14, see inline comment but this needs testing
Banned pwd list has been prepared in ocis, but it is not working and the envvar therefore commented. This should be fixed and if necessary the admin docs updated.
General lookover what could be improved

@ScharfViktor pls retest and use 5.0.5 as ocis tag in the .env file (not latest!!).

@tbsbdr @dragotin FYI

mmattel · 2024-06-20T10:27:41Z

@micbar nice improvements 😃
One suggestion, keep the ocis deployment selectable, but default active. This eases traefik only tests if issues have to be solved.

micbar · 2024-06-20T11:55:59Z

One suggestion, keep the ocis deployment selectable, but default active. This eases traefik only tests if issues have to be solved.

Ok.

sonarqubecloud · 2024-06-20T12:03:38Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

micbar · 2024-06-20T12:06:49Z

@dragotin and myself did some local testing. The modularity is working and the different combiations are working.

@tbsbdr FYI

rhafer

Looks fine to me skimming over it. (I trust that this works as others already tried it out)

phil-davis

Minor things in comments. I will make another PR for this little stuff, because this one was merged just as I was reviewing.

phil-davis · 2024-06-20T14:58:30Z

deployments/examples/ocis_wopi/README.md


-# Infinite Scale WOPI Deployment Example
+Note: This deployment setup is highly configurable. At minimum, it starts traefik`, ocis`, tika`, the wopiserver` and collabora`. Additional services can be started by removing the respective comment in the `.env` file. Depending on the service added, related variables need to be configured.


Suggested change

Note: This deployment setup is highly configurable. At minimum, it starts traefik`, ocis`, tika`, the wopiserver` and collabora`. Additional services can be started by removing the respective comment in the `.env` file. Depending on the service added, related variables need to be configured.

Note: This deployment setup is highly configurable. At minimum, it starts `traefik`, `ocis`, `tika`, the `wopiserver` and `collabora`. Additional services can be started by removing the respective comment in the `.env` file. Depending on the service added, related variables need to be configured.

Did you want to surround the service names with back-tick on both sides?

phil-davis · 2024-06-20T14:59:17Z

deployments/examples/ocis_wopi/collabora.yml

+      OCIS_LOG_LEVEL: ${OCIS_LOG_LEVEL:-info}
+      # use the internal service name of the gateway
+      APP_PROVIDER_GRPC_ADDR: 0.0.0.0:9164
+      # configure the service name to avoid collision with like with onlyoffice


Suggested change

# configure the service name to avoid collision with like with onlyoffice

# configure the service name to avoid collision with onlyoffice

phil-davis · 2024-06-20T15:02:17Z

deployments/examples/ocis_wopi/ocis.yml

+      MICRO_REGISTRY_ADDRESS: 127.0.0.1:9233
+      NATS_NATS_HOST: 0.0.0.0
+      NATS_NATS_PORT: 9233
+      # enable to allow using the banned passwords


Suggested change

# enable to allow using the banned passwords

# enable to allow using the banned passwords list

This doesn't enable "using the banned passwords", it enables "using the banned passwords list to disallow bad passwords.

phil-davis · 2024-06-20T15:02:56Z

deployments/examples/ocis_wopi/onlyoffice.yml

+      OCIS_LOG_LEVEL: ${OCIS_LOG_LEVEL:-info}
+      # use the internal service name of the gateway
+      APP_PROVIDER_GRPC_ADDR: 0.0.0.0:9164
+      # configure the service name to avoid collision like with with collabora


Suggested change

# configure the service name to avoid collision like with with collabora

# configure the service name to avoid collision with collabora

phil-davis · 2024-06-20T15:03:51Z

deployments/examples/ocis_wopi/wopiserver.yml

+      - "traefik.http.routers.wopiserver.entrypoints=https"
+      - "traefik.http.routers.wopiserver.rule=Host(`${WOPISERVER_DOMAIN:-wopiserver.owncloud.test}`)"
+      - "traefik.http.routers.wopiserver.tls.certresolver=http"
+      #- "traefik.http.routers.wopiserver.service=wopiserver"


Should there be a comment about why this is commented out?

phil-davis · 2024-06-20T15:04:32Z

deployments/examples/ocis_wopi/.env

 WOPISERVER_DOMAIN=
-# JWT secret which is used for the documents to be request by the Wopi client from the cs3org Wopi server. Must be change in order to have a secure Wopi server. Defaults to "LoremIpsum567"
+
+# JWT secret which is used for the documents to be request by the WOPI client


Suggested change

# JWT secret which is used for the documents to be request by the WOPI client

# JWT secret which is used for the documents to be requested by the WOPI client

phil-davis · 2024-06-20T15:04:54Z

deployments/examples/ocis_wopi/.env

+# Domain for Inbucket. Defaults to "mail.owncloud.test"
+INBUCKET_DOMAIN=
+
+# Mutual exclusive with ocis settings, only uncomment when the ocis settings are NOT set


Suggested change

# Mutual exclusive with ocis settings, only uncomment when the ocis settings are NOT set

# Mutually exclusive with ocis settings, only uncomment when the ocis settings are NOT set

phil-davis · 2024-06-20T15:05:48Z

deployments/examples/ocis_wopi/.env

+
+### IMPORTANT ###
+# This MUST be the last line as it assembles the supplemental compose files to be used.
+# ALL supplemental configs must be added here, independent if commented or not.


Suggested change

# ALL supplemental configs must be added here, independent if commented or not.

# ALL supplemental configs must be added here, whether commented or not.

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example

[5.0] Refactor the 'ocis_wopi' deployment example

58c3caa

mmattel requested review from dragonchaser, micbar and kobergj June 19, 2024 10:18

mmattel mentioned this pull request Jun 19, 2024

[docs-only] Create new 'ocis_wopi_community' deployment example #9394

Closed

2 tasks

update traefik to 3.0.3

14db927

micbar force-pushed the refactor_ocis_wopi_deployment branch from 2a38192 to 11ca24a Compare June 20, 2024 10:13

fix: simplify one more time

6446f51

micbar force-pushed the refactor_ocis_wopi_deployment branch from 11ca24a to 6446f51 Compare June 20, 2024 10:17

feat: make ocis selectable

4ab23b0

micbar requested a review from dragotin June 20, 2024 11:59

micbar requested review from kulmann, fschade and rhafer June 20, 2024 12:07

rhafer approved these changes Jun 20, 2024

View reviewed changes

micbar approved these changes Jun 20, 2024

View reviewed changes

micbar merged commit 87c3384 into stable-5.0 Jun 20, 2024
2 checks passed

micbar deleted the refactor_ocis_wopi_deployment branch June 20, 2024 15:04

phil-davis reviewed Jun 20, 2024

View reviewed changes

phil-davis mentioned this pull request Jun 20, 2024

[docs-only] [5.0] Adjust some text in ocis_wopi example #9425

Merged

9 tasks

ownclouders pushed a commit that referenced this pull request Jun 20, 2024

Merge pull request #9412 from owncloud/refactor_ocis_wopi_deployment

ddcf780

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example #9412

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example #9412

mmattel commented Jun 19, 2024 •

edited

Loading

mmattel commented Jun 20, 2024

micbar commented Jun 20, 2024

sonarqubecloud bot commented Jun 20, 2024

micbar commented Jun 20, 2024

rhafer left a comment

phil-davis left a comment

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024

phil-davis Jun 20, 2024


		# Infinite Scale WOPI Deployment Example
		Note: This deployment setup is highly configurable. At minimum, it starts traefik`, ocis`, tika`, the wopiserver` and collabora`. Additional services can be started by removing the respective comment in the `.env` file. Depending on the service added, related variables need to be configured.

	# configure the service name to avoid collision with like with onlyoffice
	# configure the service name to avoid collision with onlyoffice

	# enable to allow using the banned passwords
	# enable to allow using the banned passwords list

	# JWT secret which is used for the documents to be request by the WOPI client
	# JWT secret which is used for the documents to be requested by the WOPI client

	# Mutual exclusive with ocis settings, only uncomment when the ocis settings are NOT set
	# Mutually exclusive with ocis settings, only uncomment when the ocis settings are NOT set

	# ALL supplemental configs must be added here, independent if commented or not.
	# ALL supplemental configs must be added here, whether commented or not.

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example #9412

[docs-only] [5.0] Refactor the 'ocis_wopi' deployment example #9412

Conversation

mmattel commented Jun 19, 2024 • edited Loading

mmattel commented Jun 20, 2024

micbar commented Jun 20, 2024

sonarqubecloud bot commented Jun 20, 2024

Quality Gate passed

micbar commented Jun 20, 2024

rhafer left a comment

Choose a reason for hiding this comment

phil-davis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mmattel commented Jun 19, 2024 •

edited

Loading