Compare commits

...

215 Commits

Author SHA1 Message Date
Thorsten Roßner
6060dd8cc2 fix(helmfile): Templating of storageClassNames; UPDATE MIGRATIONS.MD 2025-09-08 12:26:07 +00:00
Thorsten Roßner
70178bb512 chore(mr-templates): Update based on feedback from technical weekly 2025-09-04 11:23:02 +02:00
Thorsten Roßner
d90e3ff92f chore(mr-templates): Update Default.md to provide details on template selection 2025-09-04 11:23:02 +02:00
Thorsten Roßner
f848b9a0f4 fix(nextcloud): Update from 31.0.6 to 31.0.7 including the latest app versions 2025-09-04 11:22:59 +02:00
Oliver Günther
f77f3291ca feat(openproject): Update OpenProject from 16.2.1 to 16.3.2 2025-09-02 14:26:43 +00:00
Viktor Pracht
c70a0bdc4c feat(open-xchange): Update from 8.39 to 8.40 2025-09-02 12:23:55 +00:00
Niels Lindenthal
5ab706e204 chore(README.md): Streamline sentence based capitalization 2025-09-01 07:45:31 +02:00
Thorsten Roßner
5c771baa88 chore(mr-templates): Improve wording in "Developer Checklist" section(s) 2025-08-27 17:04:00 +02:00
Thorsten Roßner
a7400f0402 chore(functional.yaml.gotmpl): Fix default link for linkPrivacyStatement 2025-08-27 15:58:17 +02:00
Thorsten Roßner
38f2bdd2b9 feat(collabora): Support for macro execution controlled by functional.weboffice.macros.enabled (default: false) 2025-08-27 10:14:41 +02:00
Thorsten Roßner
0314a7076a fix(helmfile): Add more detailed descriptions on functional.authentication.realmSettings and provide two accessCodeLifespan* options 2025-08-27 06:18:54 +00:00
Thorsten Roßner
83e8cec991 chore(release): 1.7.1 [skip ci]
## [1.7.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.7.0...v1.7.1) (2025-08-26)

### Bug Fixes

* **collabora:** Update from 25.04.3 to 25.04.4 ([84d6b50](84d6b504d2))
* **helmfile:** When optional mail domain is set, use it as sender domain for system generated (noreply) mails ([bd4c997](bd4c997950))
* **jitsi:** Increase `patchJVB` job `backoffLimit` to avoid deployment failures on infrastructure where LoadBalancer services take longer to become available ([eb2a181](eb2a1811fb))
* **nextcloud:** Fetch central navigation from cluster internal service ([dd0e516](dd0e516778))
* **nextcloud:** Stop browser from caching server-generated files ([410a1ad](410a1ade69))
* **nextcloud:** Work around a bug that breaks the `nextcloud-management` job in case the theming `primary_color` was set in Nextcloud's web UI ([4aebe22](4aebe22f22))
* **notes:** Explicitly template security contexts; add missing ingress classes and pull secrets ([834c847](834c84768a))
* **nubus:** Remove temporary `nubusUdmListener` `livenessProbe` as recommended by supplier ([688a505](688a505ef7))
* **open-xchange:** Click on top bar logo to point to portal instead of mail inbox ([9f762a7](9f762a7c2e))
* **open-xchange:** Configure correct autoreply addresses and enable FTS in Dovecot EE ([997c083](997c083335))
* **open-xchange:** Explicitly deactivate DAV support if not enabled in `functional.yaml.gotmpl` ([62ba5ab](62ba5aba49))
* **open-xchange:** Fix FTS bulk delete in Dovecot EE ([cd2a356](cd2a356b89))
* **open-xchange:** Set mail quota using `functional.groupware.quota.default` ([67fe50e](67fe50e53c))
* **opendesk-static-files:** Serve missing `.png` favicons for Notes and the Nextcloud topbar logo ([42b1105](42b11059d2))
* **ox-connector:** Update OX Connector and OX Extension to v0.27.7 ([57c96af](57c96af5a5))
* **xwiki:** Templating of `imagePullSecrets` ([bbbcd68](bbbcd6807e))
2025-08-26 13:40:33 +00:00
Thorsten Roßner
9c7b8d772c chore(publiccode.yaml): Update for 1.7.1 2025-08-26 14:28:33 +02:00
Thomas Kaltenbrunner
cd2a356b89 fix(open-xchange): Fix FTS bulk delete in Dovecot EE 2025-08-26 09:29:27 +02:00
Thorsten Roßner
4aebe22f22 fix(nextcloud): Work around a bug that breaks the nextcloud-management job in case the theming primary_color was set in Nextcloud's web UI 2025-08-25 15:48:48 +02:00
Thorsten Roßner
eb2a1811fb fix(jitsi): Increase patchJVB job backoffLimit to avoid deployment failures on infrastructure where LoadBalancer services take longer to become available 2025-08-25 15:31:16 +02:00
Thorsten Roßner
dd0e516778 fix(nextcloud): Fetch central navigation from cluster internal service 2025-08-25 15:31:16 +02:00
Thorsten Roßner
42b11059d2 fix(opendesk-static-files): Serve missing .png favicons for Notes and the Nextcloud topbar logo 2025-08-25 15:31:16 +02:00
Norbert Tretkowski
57c96af5a5 fix(ox-connector): Update OX Connector and OX Extension to v0.27.7 2025-08-25 07:56:30 +00:00
Thorsten Roßner
84d6b504d2 fix(collabora): Update from 25.04.3 to 25.04.4 2025-08-22 12:12:13 +00:00
Axel Lender
6d7937a6ca chore(dev/charts-local.py): Ignore templating in base helmfile 2025-08-22 12:10:53 +00:00
Thorsten Roßner
62ba5aba49 fix(open-xchange): Explicitly deactivate DAV support if not enabled in functional.yaml.gotmpl 2025-08-20 07:51:57 +02:00
Thorsten Roßner
9f762a7c2e fix(open-xchange): Click on top bar logo to point to portal instead of mail inbox 2025-08-19 10:12:04 +02:00
Thomas Kaltenbrunner
67fe50e53c fix(open-xchange): Set mail quota using functional.groupware.quota.default 2025-08-19 10:10:45 +02:00
Thomas Kaltenbrunner
bd4c997950 fix(helmfile): When optional mail domain is set, use it as sender domain for system generated (noreply) mails 2025-08-19 09:59:48 +02:00
Thomas Kaltenbrunner
997c083335 fix(open-xchange): Configure correct autoreply addresses and enable FTS in Dovecot EE 2025-08-19 09:48:14 +02:00
Thorsten Roßner
688a505ef7 fix(nubus): Remove temporary nubusUdmListener livenessProbe as recommended by supplier 2025-08-19 06:40:38 +00:00
Thorsten Roßner
d249448794 docs(misc): Streamline sentence heading 2025-08-19 06:40:38 +00:00
Axel Lender
bbbcd6807e fix(xwiki): Templating of imagePullSecrets 2025-08-19 06:36:59 +00:00
Thomas Kaltenbrunner
834c84768a fix(notes): Explicitly template security contexts; add missing ingress classes and pull secrets 2025-08-19 05:25:40 +00:00
Thorsten Roßner
410a1ade69 fix(nextcloud): Stop browser from caching server-generated files 2025-08-18 16:51:46 +02:00
Thorsten Roßner
9980d50dce chore(release): 1.7.0 [skip ci]
# [1.7.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.6.0...v1.7.0) (2025-08-11)

### Bug Fixes

* **collabora:** Connect to Collabora Controller websocket via service ([5d01f60](5d01f6023d))
* **collabora:** Update from 25.04.2 to 25.04.3 ([3507c62](3507c62f83))
* **helmfile:** Adds default-enterprise-overrides to default values in helmfile-generic ([672e649](672e649b60))
* **nextcloud:** Block filesystem-unsafe characters in file and folder names ([0df6212](0df6212ca9))
* **nextcloud:** Include latest Helm chart version with supports `configuration.sharing.restrictUserEnumerationToGroup` ([c3dfa2a](c3dfa2a607))
* **notes:** Set Pod Disruption Budget (PDB) labels ([e35dac0](e35dac087a))
* **nubus:** Add `livenessProbe` for `nubusUdmListener` to mitigate cases where the listener becomes uninitialized and stops forwarding provisioning data to NATS. Temporary until upstream provides a probe ([ef8d67f](ef8d67f3c1))
* **open-xchange:** Disable documents role ([573e11f](573e11f5c5))
* **open-xchange:** Postfix to support submissions and external secrets ([13ab665](13ab665900))
* **open-xchange:** Support application specific passwords in groupware when CalDAV/CardDAV support is enabled, see `functional.groupware.davSupport.enabled` for reference ([90b2290](90b22904da))
* **open-xchange:** Use dedicated pod for migration ([6fd52b1](6fd52b167e))
* **opendesk-certificates:** Update Helm chart to remove default host for `webmail` being set even if OX App Suite is not enabled ([09a0aac](09a0aace45))
* **opendesk-services:** Update opendesk-alerts from 1.1.1 to 1.1.2, update opendesk-dashboards from 1.1.1 to 1.1.2 ([174d4fc](174d4fc61c))
* **openproject:** Update from 16.2.0 to 16.2.1 ([bba9b71](bba9b716a3))
* **ox-connector:** Update OX Connector and OX Extension to v0.27.2; review `migrations.md` for required upgrade steps ([9d51e40](9d51e40063))

### Features

* **nextcloud:** Enhance theming options for Nextcloud ([bdc7331](bdc7331cb5))
* **notes:** Switch to new Helm chart with support for self-signed deployments; review `migrations.md` for required upgrade steps ([3106ca7](3106ca793e))
* **nubus:** Allow configuration of limits for password reset requests via `security.passwordResetLimits` ([09f54b4](09f54b4134))
* **nubus:** Update from 1.11.2 to 1.12.0 ([5537dbb](5537dbbd7c))
* **open-xchange:** Update from 8.38 to 8.39 ([489986e](489986e906))
* **open-xchange:** Use internal endpoint for provisioning and support for optionally spinning up a dedicated internal Pod just for provisioning (see `technial.oxAppSuite.provisioning.dedicatedCoreMwPod` for details) ([31b7ec7](31b7ec7827))
* **openproject:** Update from 16.1.1 to 16.2.0 ([e273abb](e273abbecf))
2025-08-11 05:22:15 +00:00
Thorsten Roßner
25ba486ba0 chore(publiccode.yml): Update for openDesk 1.7.0 2025-08-10 21:24:16 +02:00
Franz Kuntke
a84d440f9f ci(db-cleanup): Add dovecot bucket 2025-08-09 07:44:05 +02:00
Thorsten Roßner
f549fdfd19 chore(publiccode.yml): Update for openDesk 1.7.0 2025-08-09 07:44:05 +02:00
Thorsten Roßner
3507c62f83 fix(collabora): Update from 25.04.2 to 25.04.3 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
5d01f6023d fix(collabora): Connect to Collabora Controller websocket via service 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
90b22904da fix(open-xchange): Support application specific passwords in groupware when CalDAV/CardDAV support is enabled, see functional.groupware.davSupport.enabled for reference 2025-08-09 07:44:05 +02:00
Simon Hermann
174d4fc61c fix(opendesk-services): Update opendesk-alerts from 1.1.1 to 1.1.2, update opendesk-dashboards from 1.1.1 to 1.1.2 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
e35dac087a fix(notes): Set Pod Disruption Budget (PDB) labels 2025-08-09 07:44:05 +02:00
Thorsten Roßner
ef8d67f3c1 fix(nubus): Add livenessProbe for nubusUdmListener to mitigate cases where the listener becomes uninitialized and stops forwarding provisioning data to NATS. Temporary until upstream provides a probe 2025-08-09 07:44:05 +02:00
Thorsten Roßner
7f17a80597 chore(mirror): Add mirror annotations to Bitnami images 2025-08-09 07:44:05 +02:00
Franz Kuntke
797308f1ec ci(db-cleanup): Fix connection to STACKIT PostgreSQL databases and add openxchange bucket 2025-08-09 07:44:05 +02:00
Simon Herman
39c057904a docs(migrations.md): Add note for default values in helmfile_generic.yaml.gotmpl 2025-08-09 07:44:05 +02:00
Oliver Günther
bba9b716a3 fix(openproject): Update from 16.2.0 to 16.2.1 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
6fd52b167e fix(open-xchange): Use dedicated pod for migration 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
3106ca793e feat(notes): Switch to new Helm chart with support for self-signed deployments; review migrations.md for required upgrade steps 2025-08-09 07:44:05 +02:00
Thorsten Roßner
8eaa12e53b chore(helmfile): Set global.systemInformation.releaseVersion to v1.7.0 2025-08-09 07:44:05 +02:00
Lilly Sell
09f54b4134 feat(nubus): Allow configuration of limits for password reset requests via security.passwordResetLimits 2025-08-09 07:44:05 +02:00
Norbert Tretkowski
5537dbbd7c feat(nubus): Update from 1.11.2 to 1.12.0 2025-08-09 07:44:05 +02:00
Norbert Tretkowski
9d51e40063 fix(ox-connector): Update OX Connector and OX Extension to v0.27.2; review migrations.md for required upgrade steps 2025-08-09 07:44:05 +02:00
Viktor Pracht
489986e906 feat(open-xchange): Update from 8.38 to 8.39 2025-08-09 07:44:05 +02:00
Thomas Kaltenbrunner
13ab665900 fix(open-xchange): Postfix to support submissions and external secrets 2025-08-09 07:44:05 +02:00
Philip Gaber
0df6212ca9 fix(nextcloud): Block filesystem-unsafe characters in file and folder names 2025-08-09 07:44:05 +02:00
Thorsten Roßner
0d8c148062 chore(mr-templates): Update merge request templates 2025-08-09 07:44:05 +02:00
Thorsten Roßner
f0057c6417 docs(workflow.md): Update conventional commits section 2025-08-09 07:44:05 +02:00
Thorsten Roßner
cd000826df docs(README-EE.md): Remove the # before some number references to avoid GitLab thinking these are issue references 2025-08-09 07:44:05 +02:00
Simon Herman
672e649b60 fix(helmfile): Adds default-enterprise-overrides to default values in helmfile-generic 2025-08-09 07:44:04 +02:00
Thorsten Roßner
09a0aace45 fix(opendesk-certificates): Update Helm chart to remove default host for webmail being set even if OX App Suite is not enabled 2025-08-09 07:44:04 +02:00
Thorsten Roßner
c3dfa2a607 fix(nextcloud): Include latest Helm chart version with supports configuration.sharing.restrictUserEnumerationToGroup 2025-08-09 07:44:04 +02:00
Thomas Kaltenbrunner
31b7ec7827 feat(open-xchange): Use internal endpoint for provisioning and support for optionally spinning up a dedicated internal Pod just for provisioning (see technial.oxAppSuite.provisioning.dedicatedCoreMwPod for details) 2025-08-09 07:44:04 +02:00
Philip Gaber
bdc7331cb5 feat(nextcloud): Enhance theming options for Nextcloud 2025-08-09 07:44:04 +02:00
Oliver Günther
e273abbecf feat(openproject): Update from 16.1.1 to 16.2.0 2025-08-09 07:44:04 +02:00
René Fischer
386dbbf453 docs(releases.md): Add release and patch management process 2025-08-09 07:44:04 +02:00
René Fischer
6e054008a2 docs(README-EE.md): Add EE features 2025-08-09 07:44:04 +02:00
René Fischer
02318a478a docs(README-EE.md): Add CE licenses 2025-08-09 07:44:04 +02:00
René Fischer
b610a8825c docs(README-EE.md): Add overview of CE vs. EE 2025-08-09 07:44:04 +02:00
Thorsten Roßner
248213a285 ci(dbcleanup): Fix RUN cluster cleanup 2025-08-09 07:44:04 +02:00
Philip Gaber
879838bbb2 ci(service-cleanup): Update for new opendesk-env structure and set STACKIT as default 2025-08-09 07:44:04 +02:00
Silvio Knizek
1185f4d97a docs(migrations.md): Broken markdown table 2025-08-09 07:44:04 +02:00
Thomas Kaltenbrunner
573e11f5c5 fix(open-xchange): Disable documents role 2025-08-09 07:44:04 +02:00
Alexander Smolianitski
3b9ddab603 docs(baseline-requirements): Fix broken links ins section "License Compliance" 2025-07-31 16:38:41 +02:00
Thorsten Roßner
c858692e6b chore(release): 1.6.0 [skip ci]
# [1.6.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.5.0...v1.6.0) (2025-07-14)

### Bug Fixes

* **dovecot-pro:** Use of `requiredEnv` instead of `env` and update `README-EE.md` ([a79e40f](a79e40f44a))
* **helmfile:** Prefix NATS passwords as workaround for upstream issue and add documentation to `gettings-started.md` [[#185](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/185), [#202](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/202)] ([7f478bf](7f478bffd6))
* **helmfile:** Remove default setting from `repositories.helm.registryOpencodeDeEnterprise` for better support of `PRIVATE_HELM_REGISTRY_URL` ([c5dd881](c5dd8814ae))
* **helmfile:** Set `nubusKeycloakBootstrap` debug mode when openDesk is running in debug mode ([4e0ffee](4e0ffeea1f))
* **helmfile:** Streamline license header comment style [[#192](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/192)] ([20cbad3](20cbad31e7))
* **nubus:** Explicitly template `nubusStackDataUms.stackDataContext.portalFqdn` to fix custom hostname support [[#193](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/193)] ([6aa6d3a](6aa6d3af2f))
* **nubus:** Replace openDesk portal fork with upstream `portal-frontend` image ([e4f1afc](e4f1afca0f))
* **nubus:** Update from 1.11.1 to 1.11.2 ([237c9af](237c9af3c1))
* **open-xchange:** Add missing `imagePullSecrets` for `core-imageconverter` and `core-documentconverter` ([9b7f439](9b7f439d83))
* **open-xchange:** Enable `com.openexchange.smime.test` only when openDesk is running with `debug.enabled: true` ([51ff7a5](51ff7a5fdb))
* **open-xchange:** Enable searching by LDAP `mailAlternativeAddress` when resolving global contacts. Note: OX App Suite evaluates all `mailAlternativeAddress` values of a user when searching, but only the first address is returned, which might differ from the one that matched the search criteria. ([9014324](9014324156))
* **open-xchange:** Use `objectstore.dovecot.secretKey` when defined ([5c33226](5c332264ed))
* **opendesk-services:** Add missing certificates ([acbabdb](acbabdb806))
* **openproject:** Update from 16.1.0 to 16.1.1 ([e30d4f1](e30d4f126d))

### Features

* **collabora:** Update from 24.04.13 to 25.04.2 ([c56f564](c56f564025))
* **element:** Update NeoBoard from 2.1.0 to 2.2.1, NeoChoice from 1.5.1. to 1.5.2, NeoDateFix from 1.7.0 to 1.7.1 widgets and NeoDateFixBot from 2.8.2 to 2.8.3 latest releases ([98d31f8](98d31f811b))
* **helmfile:** Add options in `functional.yaml.gotmpl` for setting the portal's corner links, toggling the welcome message and the newsfeed ([1a6f438](1a6f438724))
* **nextcloud:** Update from 30.0.10 to 31.0.6 and support for notify-push ([a4c8be6](a4c8be60f3))
* **nubus:** Update from 1.9.1 to 1.11.1; required minimum openDesk version for this upgrade is 1.5.0, see `migrations.md` for details ([ccd5ab8](ccd5ab84e3))
* **open-xchange:** Store attachments for calendar, contact and task objects in object storage; review `migrations.md` for required upgrade steps ([4eb6570](4eb6570b0a))
* **open-xchange:** Updated OX App Suite from 8.37 to 8.38 ([2b31751](2b317514c6))
2025-07-14 11:19:43 +00:00
Thorsten Roßner
de1554aed1 chore(publiccode.yml): Update for 1.6.0 2025-07-12 14:55:55 +02:00
Philip Gaber
a79e40f44a fix(dovecot-pro): Use of requiredEnv instead of env and update README-EE.md 2025-07-12 14:55:55 +02:00
Thomas Kaltenbrunner
5c332264ed fix(open-xchange): Use objectstore.dovecot.secretKey when defined 2025-07-12 14:55:55 +02:00
Thorsten Roßner
22c179d3f2 ci(db-cleanup): Fix cleanup when values files are loaded including go-template placeholders 2025-07-12 14:55:55 +02:00
Thorsten Roßner
20cbad31e7 fix(helmfile): Streamline license header comment style [#192] 2025-07-12 14:55:55 +02:00
Norbert Tretkowski
237c9af3c1 fix(nubus): Update from 1.11.1 to 1.11.2 2025-07-12 14:55:55 +02:00
Thomas Kaltenbrunner
acbabdb806 fix(opendesk-services): Add missing certificates 2025-07-12 14:55:55 +02:00
Philip Gaber
a4c8be60f3 feat(nextcloud): Update from 30.0.10 to 31.0.6 and support for notify-push 2025-07-12 14:55:55 +02:00
Franz Kuntke
9e92aa3005 ci(cleanup): Extend db-cleanup to flush data of external-services at StackIT 2025-07-12 14:55:55 +02:00
Thorsten Roßner
5160711050 chore(nubus): Update wrong SHA for nubusBlocklistCleanup to existing image on the openCode mirror 2025-07-12 14:55:55 +02:00
Mikhail Aheichyk
98d31f811b feat(element): Update NeoBoard from 2.1.0 to 2.2.1, NeoChoice from 1.5.1. to 1.5.2, NeoDateFix from 1.7.0 to 1.7.1 widgets and NeoDateFixBot from 2.8.2 to 2.8.3 latest releases 2025-07-12 14:55:55 +02:00
Thorsten Roßner
26e4b54cad docs(gettings-started.md): Explicitly require ingressClassName 2025-07-12 14:55:55 +02:00
Thorsten Roßner
7ae716bc82 docs(theming.md): Improve wording 2025-07-12 14:55:55 +02:00
Thorsten Roßner
d39c406d63 docs(migrations.md): Add "deprecation warning" section 2025-07-12 14:55:55 +02:00
Thorsten Roßner
1a6f438724 feat(helmfile): Add options in functional.yaml.gotmpl for setting the portal's corner links, toggling the welcome message and the newsfeed 2025-07-12 14:55:55 +02:00
Thorsten Roßner
e4f1afca0f fix(nubus): Replace openDesk portal fork with upstream portal-frontend image 2025-07-12 14:55:55 +02:00
Thorsten Roßner
19f4ea90e2 chore(helmfile): Set global.systemInformation.releaseVersion to v1.6.0 to allow migration tests 2025-07-12 14:55:55 +02:00
Thorsten Roßner
8777722cf1 ci(cleanup): Echo info which namespace is being worked on 2025-07-12 14:55:55 +02:00
Thorsten Roßner
0cc04c0be0 docs(data-storage.md): Update NC,XWiki as they use PostgreSQL as default, fix provisioning listener table entry [#198, #200] 2025-07-12 14:55:55 +02:00
Thorsten Roßner
6aa6d3af2f fix(nubus): Explicitly template nubusStackDataUms.stackDataContext.portalFqdn to fix custom hostname support [#193] 2025-07-12 14:55:55 +02:00
Thorsten Roßner
4e0ffeea1f fix(helmfile): Set nubusKeycloakBootstrap debug mode when openDesk is running in debug mode 2025-07-12 14:55:55 +02:00
Norbert Tretkowski
ccd5ab84e3 feat(nubus): Update from 1.9.1 to 1.11.1; required minimum openDesk version for this upgrade is 1.5.0, see migrations.md for details 2025-07-12 14:55:55 +02:00
René Fischer
8d832107c1 chore(publiccode.yml): Add English translation 2025-07-12 14:55:55 +02:00
Thorsten Roßner
51ff7a5fdb fix(open-xchange): Enable com.openexchange.smime.test only when openDesk is running with debug.enabled: true 2025-07-12 14:55:55 +02:00
Thorsten Roßner
4eb6570b0a feat(open-xchange): Store attachments for calendar, contact and task objects in object storage; review migrations.md for required upgrade steps 2025-07-12 14:55:55 +02:00
Philip Gaber
9b7f439d83 fix(open-xchange): Add missing imagePullSecrets for core-imageconverter and core-documentconverter 2025-07-12 14:55:55 +02:00
Viktor Pracht
2b317514c6 feat(open-xchange): Updated OX App Suite from 8.37 to 8.38 2025-07-12 14:55:55 +02:00
Thomas Kaltenbrunner
9014324156 fix(open-xchange): Enable searching by LDAP mailAlternativeAddress when resolving global contacts. Note: OX App Suite evaluates all mailAlternativeAddress values of a user when searching, but only the first address is returned, which might differ from the one that matched the search criteria. 2025-07-12 14:55:55 +02:00
Thorsten Roßner
c5dd8814ae fix(helmfile): Remove default setting from repositories.helm.registryOpencodeDeEnterprise for better support of PRIVATE_HELM_REGISTRY_URL 2025-07-12 14:55:55 +02:00
Thorsten Roßner
c56f564025 feat(collabora): Update from 24.04.13 to 25.04.2 2025-07-12 14:55:55 +02:00
Oliver Günther
e30d4f126d fix(openproject): Update from 16.1.0 to 16.1.1 2025-07-12 14:55:33 +02:00
Thorsten Roßner
55b93cb190 chore(helmfile): Add description for davSupport in functional.yaml.gotmpl 2025-07-01 11:54:18 +00:00
Thorsten Roßner
d3c7462371 docs(getting-started.md): Improve wording 2025-07-01 06:46:12 +00:00
Axel Lender
7f478bffd6 fix(helmfile): Prefix NATS passwords as workaround for upstream issue and add documentation to gettings-started.md [#185, #202] 2025-06-30 17:04:27 +02:00
Niels Lindenthal
3df9342b31 chore(changelog): Fix typo in component name open-xchange 2025-06-18 10:17:15 +02:00
Thorsten Roßner
6baec0b587 chore(reuse): Annotate merge request templates in REUSE.toml 2025-06-16 16:38:48 +02:00
René Fischer
5a3e47ea5d chore(merge_request_templates): Add merge request templates 2025-06-16 14:35:49 +02:00
Thorsten Roßner
74c4cc309d chore(notes): Remove "Beta" label from portal tile 2025-06-16 10:27:17 +02:00
Thorsten Roßner
feaaa81094 chore(release): 1.5.0 [skip ci]
# [1.5.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.4.1...v1.5.0) (2025-06-16)

### Bug Fixes

* **dovecot:** Enable Dovecot ACL for CE (file) & EE (cassandra) ([9354ee7](9354ee7196))
* **notes:** Support templating of Ingress annotations `bodyTimeout` and `bodySize` to allow application defined upload limits to be reached ([69faf77](69faf77d15))
* **nubus:** Create required LDAP objects for `global.additionalMailDomains` ([4dcb683](4dcb683118))
* **nubus:** Explicitly template security context for Keycloak proxy ([e959438](e9594382ed))
* **nubus:** Update CSS for login screen to show login button for federated IdP ([0d4e1b0](0d4e1b01e3))
* **nubus:** Use read-only root filesystem for Keycloak bootstrap ([1edd7c3](1edd7c3f06))
* **open-xchange:** Enabled mail login resolver ([7547f49](7547f4948e))
* **open-xchange:** Update Dovecot CE chart to support ACLs (mailbox sharing) and usernames different from local part of mail address ([87c30ab](87c30ab8e3))
* **open-xchange:** Use login name instead of email between OX and Dovecot ([8e9ef08](8e9ef0867b))
* **openproject:** Update from 16.0.0 to 16.0.1 ([b60f9c7](b60f9c7576))
* **openxchange:** Update App Suite 8.37 to latest patch level (8.37.69) ([bc436b2](bc436b2485))

### Features

* **ci:** Update Helm to 3.18.1 and Helmfile to 1.1.1 ([59a4086](59a40864ed))
* **notes:** Update from 2.4.0 to 3.2.1 ([9f4e3c8](9f4e3c86c7))
* **open-xchange:** Support for `mailAlternativAddress`(es) for sending and receiving emails ([6d6b1a6](6d6b1a6dd7))
* **openproject:** Update from 15.5.1 to 16.0.0 including Helm chart update ([add7266](add72669ae))
2025-06-16 08:03:51 +00:00
Thorsten Roßner
03f414ffaf chore(publiccode.yml): Update version number to 1.5.0 2025-06-16 08:38:18 +02:00
Thorsten Roßner
f773a9371c ci(diff-on-branch): Merge doublette variables block 2025-06-16 08:36:25 +02:00
rweber
69faf77d15 fix(notes): Support templating of Ingress annotations bodyTimeout and bodySize to allow application defined upload limits to be reached 2025-06-16 08:36:25 +02:00
rweber
9f4e3c86c7 feat(notes): Update from 2.4.0 to 3.2.1 2025-06-16 08:36:25 +02:00
Thorsten Roßner
e06642f6b6 ci(diff-on-branch): Update to ensure opendesk-env files are loaded 2025-06-16 08:36:25 +02:00
Thorsten Roßner
0d4e1b01e3 fix(nubus): Update CSS for login screen to show login button for federated IdP 2025-06-16 08:36:25 +02:00
Viktor Pracht
bc436b2485 fix(openxchange): Update App Suite 8.37 to latest patch level (8.37.69) 2025-06-16 08:35:28 +02:00
René Fischer
3b9fd4eb99 docs(README-EE.md): Add link to enterprise_keys.yml.gotmpl 2025-06-16 08:35:28 +02:00
Yannik Schmidt
e9594382ed fix(nubus): Explicitly template security context for Keycloak proxy 2025-06-16 08:35:28 +02:00
Timo Hollwedel
1edd7c3f06 fix(nubus): Use read-only root filesystem for Keycloak bootstrap 2025-06-16 08:35:28 +02:00
Thomas Kaltenbrunner
6d6b1a6dd7 feat(open-xchange): Support for mailAlternativAddress(es) for sending and receiving emails 2025-06-16 08:35:28 +02:00
Christophe Bliard
b60f9c7576 fix(openproject): Update from 16.0.0 to 16.0.1 2025-06-16 08:35:28 +02:00
Thorsten Roßner
4dcb683118 fix(nubus): Create required LDAP objects for global.additionalMailDomains 2025-06-16 08:35:28 +02:00
Thorsten Roßner
bc8028dd93 ci: Add diff-on-branch feature 2025-06-16 08:35:28 +02:00
Thorsten Roßner
e143a9c9d8 chore(helmfile): Bump images of opendesk-element-syncadmins, opendesk-nextcloud-exporter and postfix to current builds using the gitlab-config v2.4.10 to avoid layer mimetype issues when mirroring images 2025-06-16 08:35:28 +02:00
Thomas Kaltenbrunner
9354ee7196 fix(dovecot): Enable Dovecot ACL for CE (file) & EE (cassandra) 2025-06-16 08:35:28 +02:00
Viktor Pracht
8e9ef0867b fix(open-xchange): Use login name instead of email between OX and Dovecot 2025-06-16 08:35:28 +02:00
Thorsten Roßner
87c30ab8e3 fix(open-xchange): Update Dovecot CE chart to support ACLs (mailbox sharing) and usernames different from local part of mail address 2025-06-16 08:35:28 +02:00
Viktor Pracht
7547f4948e fix(open-xchange): Enabled mail login resolver 2025-06-16 08:35:28 +02:00
Viktor Pracht
b608a610fe chore(openxchange): Updated OX App Suite Pro charts only to 8.37 2025-06-16 08:35:09 +02:00
Thorsten Roßner
59a40864ed feat(ci): Update Helm to 3.18.1 and Helmfile to 1.1.1 2025-06-03 07:42:45 +00:00
Markus Kahl
add72669ae feat(openproject): Update from 15.5.1 to 16.0.0 including Helm chart update 2025-06-03 06:49:58 +00:00
Thorsten Roßner
fe510fa679 chore(helmfile): Post release update of global.generated.yaml.gotmpl 2025-06-02 10:10:32 +02:00
Thorsten Roßner
805cdf26ae chore(release): 1.4.1 [skip ci]
## [1.4.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.4.0...v1.4.1) (2025-06-02)

### Bug Fixes

* **nextcloud:** Update NC CE to 30.0.10 ([785be8b](785be8b662))
* **nextcloud:** Update Nextcloud incl. apps to 30.0.10 ([559fbf6](559fbf6801))
* **nubus:** Use `.Values.theme.texts.productName` for Keycloak's `loginTitle` instead of static product name string ([d1a1e5d](d1a1e5dc29))
* **open-xchange:** Re-adding `com.openexchange.oauth.provider.*` to fix central contacts feature ([561e44f](561e44fd4c))
* **open-xchange:** Set `com.openexchange.hostname` to get working links in outgoing system mails (e.g. task assignments) ([0d61687](0d616871e3))
* **postfix:** Require TLSv1.3 ([3b3d8ac](3b3d8aca54))
* **requirements.md:** Helm 3.18.x is not supported due to upstream bug ([1ea9cae](1ea9cae1ce))
2025-06-02 08:01:20 +00:00
Thorsten Roßner
559fbf6801 fix(nextcloud): Update Nextcloud incl. apps to 30.0.10 2025-06-02 07:05:58 +02:00
Thorsten Roßner
561e44fd4c fix(open-xchange): Re-adding com.openexchange.oauth.provider.* to fix central contacts feature 2025-06-02 07:05:58 +02:00
Thomas Kaltenbrunner
0d616871e3 fix(open-xchange): Set com.openexchange.hostname to get working links in outgoing system mails (e.g. task assignments) 2025-06-02 07:05:58 +02:00
Thorsten Roßner
b185fe055c docs(migrations.md): [#188] Update to point out requirement for IdP federation configuration 2025-06-02 07:05:58 +02:00
Thorsten Roßner
d1a1e5dc29 fix(nubus): Use .Values.theme.texts.productName for Keycloak's loginTitle instead of static product name string 2025-06-02 07:05:58 +02:00
Tilman Lüttje
1ea9cae1ce fix(requirements.md): Helm 3.18.x is not supported due to upstream bug 2025-06-02 07:05:52 +02:00
Thomas Kaltenbrunner
3b3d8aca54 fix(postfix): Require TLSv1.3 2025-05-30 17:02:07 +02:00
Tilman Lüttje
785be8b662 fix(nextcloud): Update NC CE to 30.0.10 2025-05-30 17:01:45 +02:00
Dominik Kaminski
6d06e1fcc2 chore(release): 1.4.0 [skip ci]
# [1.4.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.2...v1.4.0) (2025-05-20)

### Bug Fixes

* **docs:** Update requirements, bump helmfile to v1.0.0 ([88b29c5](88b29c57e8))
* **dovecot:** Encode object storage password and add more template values ([c40de73](c40de73ccf))
* **nubus:** [[#182](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/182)] Add `KC_TRUSTSTORE_PATHS` to Keycloak when using self-signed certificates ([006aed7](006aed791e))
* **nubus:** [[#183](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/183)] Do not override `nubusPortalConsumer.waitForDependency.image` when using self-signed certificates ([b45a0bf](b45a0bf832))
* **nubus:** Update ArgoCD hook annotations ([f2b1384](f2b1384670))
* **open-xchange:** Update Open-Xchange to v8.36 ([b40b863](b40b8630c1))
* **open-xchange:** Update Open-Xchange to v8.37 ([174c73c](174c73c012))
* **openproject:** Update to 15.5.1 ([e91efa8](e91efa8ecc))
* **openxchange:** Add proper dav URLs in client onboarding and disable unnecessary oauth section ([bba2af0](bba2af0f06))
* **openxchange:** Disable redundant o-x-authentication-oauth package ([1d2b17b](1d2b17b495))
* **openxchange:** Enable DAV support ([709e50f](709e50ff7c))

### Features

* **collabora:** Update enterprise image to 24.04.13.4.1 ([b590810](b5908100dd))
* **helmfile:** Define `global.additionalMailDomains` as list; if you use the setting already, check `migrations.md` for details ([4b30576](4b305768c4))
* **helmfile:** Option to select default file format for weboffice using; see `functional.weboffice.defaultFormat` in `functional.yaml.gotmpl` for details ([5f58a85](5f58a857ac))
* **nubus:** Update nubus to v1.9.1 ([3d694a8](3d694a8248))
2025-05-20 00:46:42 +00:00
Justus Holzberger
b9640d9321 chore(docs): Update links, images and tables in docs 2025-05-20 00:05:43 +02:00
Thomas Kaltenbrunner
c40de73ccf fix(dovecot): Encode object storage password and add more template values 2025-05-20 00:00:55 +02:00
Norbert Tretkowski
3d694a8248 feat(nubus): Update nubus to v1.9.1 2025-05-19 23:57:45 +02:00
renovate
174c73c012 fix(open-xchange): Update Open-Xchange to v8.37 2025-05-19 14:56:20 +02:00
openDesk Bot
b1acec9171 chore(renovate): Update Element 2025-05-19 08:48:00 +00:00
Uta Lemke
2f56a94b2a docs(README-EE.md): Add caution note on XWiki license key format 2025-05-16 13:57:55 +00:00
Tilman Lüttje
b5908100dd feat(collabora): Update enterprise image to 24.04.13.4.1 2025-05-16 09:08:32 +00:00
renovate
cc16bee370 chore(renovate): Update bmi/opendesk/components/supplier/collabora/images/collabora-online-for-opendesk Docker tag to v24.04.14.3.1 2025-05-16 09:08:32 +00:00
Dominik Kaminski
26970483b2 chore(helmfile): Update a bunch of external images 2025-05-15 23:03:33 +02:00
openDesk Bot
f8fa301b6c chore(renovate): Update alpine/k8s Docker tag to v1.33.0 2025-05-15 20:47:42 +02:00
Dominik Kaminski
b40b8630c1 fix(open-xchange): Update Open-Xchange to v8.36 2025-05-15 19:39:01 +02:00
openDesk Bot
9b9726087f chore(renovate): Update Open-Xchange 2025-05-15 15:22:39 +02:00
Dominik Kaminski
88b29c57e8 fix(docs): Update requirements, bump helmfile to v1.0.0 2025-05-15 14:34:34 +02:00
Dominik Kaminski
f2b1384670 fix(nubus): Update ArgoCD hook annotations 2025-05-15 13:39:59 +02:00
openDesk Bot
d916365cb4 chore(renovate): Update collabora-online Docker tag to v1.1.38 2025-05-14 13:29:59 +00:00
Thomas Kaltenbrunner
bba2af0f06 fix(openxchange): Add proper dav URLs in client onboarding and disable unnecessary oauth section 2025-05-13 19:25:47 +02:00
Viktor Pracht
1d2b17b495 fix(openxchange): Disable redundant o-x-authentication-oauth package
Also fixed a typo in oidcPath.
2025-05-13 19:25:47 +02:00
Thomas Kaltenbrunner
709e50ff7c fix(openxchange): Enable DAV support 2025-05-13 19:25:47 +02:00
openDesk Bot
7603bbdc64 chore(renovate): Update library/postgres Docker tag to v16.9 2025-05-10 03:36:39 +00:00
Thomas Kaltenbrunner
4b305768c4 feat(helmfile): Define global.additionalMailDomains as list; if you use the setting already, check migrations.md for details 2025-05-07 18:33:55 +02:00
Thorsten Roßner
91a25f4c18 ci(gitlab): Update gitlab-config image to v2.4.9 2025-05-07 15:02:12 +02:00
Thorsten Roßner
006aed791e fix(nubus): [#182] Add KC_TRUSTSTORE_PATHS to Keycloak when using self-signed certificates 2025-05-07 14:52:35 +02:00
Thorsten Roßner
b45a0bf832 fix(nubus): [#183] Do not override nubusPortalConsumer.waitForDependency.image when using self-signed certificates 2025-05-07 14:03:03 +02:00
Thorsten Roßner
8e638b6714 chore(global.generated.yaml.gotmpl): Bump version to fake a newer release for migrations (testing) 2025-05-07 12:26:49 +02:00
Oliver Günther
e91efa8ecc fix(openproject): Update to 15.5.1 2025-05-07 12:19:21 +02:00
Thorsten Roßner
58b74c7cfd docs(theming.md): Update to latest state 2025-05-07 12:19:21 +02:00
René Fischer
c3417f404c chore(scaling.md): Fix Postgres RAM scaling 2025-05-07 12:19:21 +02:00
René Fischer
799ba97b3c chore(docs): Separate developer from operations docs 2025-05-07 12:19:21 +02:00
Thorsten Roßner
9320274162 docs(misc): Fix typos 2025-05-07 12:19:21 +02:00
Thorsten Roßner
5f58a857ac feat(helmfile): Option to select default file format for weboffice using; see functional.weboffice.defaultFormat in functional.yaml.gotmpl for details 2025-05-07 12:19:21 +02:00
René Fischer
86bfa3e559 chore(publiccode.yaml): Fix logo in publiccode.yaml 2025-05-07 12:19:21 +02:00
Thorsten Roßner
42f6151121 chore(release): 1.3.2 [skip ci]
## [1.3.2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.1...v1.3.2) (2025-05-06)

### Bug Fixes

* **dovecot:** Update Helm chart to fix migration mode ([7ba84b9](7ba84b99ca))
* **helmfile:** Explicitly template auth-modules in OX App Suite; Streamline name of OX App Suite EE image ([6cbb6b6](6cbb6b6922))
2025-05-06 19:18:51 +00:00
Thorsten Roßner
6cbb6b6922 fix(helmfile): Explicitly template auth-modules in OX App Suite; Streamline name of OX App Suite EE image 2025-05-06 16:33:37 +02:00
Thorsten Roßner
7ba84b99ca fix(dovecot): Update Helm chart to fix migration mode 2025-05-06 16:33:37 +02:00
Thorsten Roßner
f49980b3ef docs(groupware-migration.md): Update with more details 2025-05-06 16:33:37 +02:00
René Fischer
69e66c65f6 chore(scaling.md): Second round of review changes 2025-05-05 11:25:50 +02:00
René Fischer
aed14e1ce1 chore(scaling.md): Review changes 2025-05-05 11:25:50 +02:00
René Fischer
e557393025 docs(scaling.md): Add scaling guidelines 2025-05-05 11:25:50 +02:00
Thorsten Roßner
45b924e8fa chore(release): 1.3.1 [skip ci]
## [1.3.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.0...v1.3.1) (2025-04-24)

### Bug Fixes

* **ci:** Update Helm to v3.17.3 ([9446faa](9446faaa59))
* **ci:** Update Helm to v3.17.3 ([d794a20](d794a2036e))
* **docs:** Update "Ingress controller" section and add footnote on volume provisioner in `requirements.md` ([17efbd7](17efbd79f1))
* **helmfile:** Conditional templating of additional annotations in selected components to unblock openDesk deployment despite a bug in Helm 3.17 (https://github.com/helm/helm/issues/30587) ([861b84b](861b84b14d))
* **postfix:** Disable unauthenticated relaying of mails in `postfix-ox` ([7414f05](7414f05005))
2025-04-24 12:05:42 +00:00
Thorsten Roßner
9446faaa59 fix(ci): Update Helm to v3.17.3 2025-04-24 11:44:22 +02:00
Thorsten Roßner
17efbd79f1 fix(docs): Update "Ingress controller" section and add footnote on volume provisioner in requirements.md 2025-04-24 11:09:22 +02:00
Thorsten Roßner
d794a2036e fix(ci): Update Helm to v3.17.3 2025-04-24 09:50:19 +02:00
Thomas Kaltenbrunner
7414f05005 fix(postfix): Disable unauthenticated relaying of mails in postfix-ox 2025-04-24 07:54:34 +02:00
Thorsten Roßner
3d80c7e2b1 chore: Update publiccode.yml for v1.3.1 2025-04-23 16:53:16 +02:00
Thorsten Roßner
d74742808c ci: Authorize container access in scan job 2025-04-23 16:53:16 +02:00
Thorsten Roßner
861b84b14d fix(helmfile): Conditional templating of additional annotations in selected components to unblock openDesk deployment despite a bug in Helm 3.17 (https://github.com/helm/helm/issues/30587) 2025-04-23 16:52:32 +02:00
Thorsten Roßner
a9fae59b74 chore(release): 1.3.0 [skip ci]
# [1.3.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.2.1...v1.3.0) (2025-04-22)

### Bug Fixes

* **helmfile:** Fix Kyverno lint issues for EE components ([46b3834](46b38342d3))
* **helmfile:** Remove no longer used `secrets.nubus.defaultAccounts.*` ([6e6d155](6e6d15552e))
* **helmfile:** Support for Keycloak session settings via `functional.authentication.realmSettings.*` ([3fcfa00](3fcfa00503))
* **migrations:** Optional delete of `ums-minio-rewrites` Ingress, as it is non-existing in deployments with external object storage ([6932953](693295391b))
* **ox-connector:** Update to v0.19.0 ([fe664a7](fe664a7f8d))
* **xwiki:** Update Helm chart to v1.4.4 to fix the problem with XWiki not starting when secrets contained specific (XML interpreted) characters ([67a1df0](67a1df0f80))

### Features

* **collabora:** Update to 24.04.13 ([8f12208](8f12208074))
* **helmfile:** Add template support for annotations ([9cde57d](9cde57d74b))
* **helmfile:** Support for SSO federation; see `ssoFederation` section in `functional.yaml.gotmpl` for details ([79975a5](79975a58e3))
* **nubus:** Show openDesk version to all users (instead of admin users only) ([393ee31](393ee31163))
* **nubus:** Update to 1.8.0 ([90c49f6](90c49f6f83))
* **openproject:** Update to 15.5.0 ([7f1cfc5](7f1cfc5555))
2025-04-22 13:02:30 +00:00
Thorsten Roßner
693295391b fix(migrations): Optional delete of ums-minio-rewrites Ingress, as it is non-existing in deployments with external object storage 2025-04-22 14:08:04 +02:00
Thorsten Roßner
393ee31163 feat(nubus): Show openDesk version to all users (instead of admin users only) 2025-04-22 14:07:55 +02:00
Jonas Schulz
b0088b028c docs: Supplement changes from 0e3b6615 2025-04-22 14:07:55 +02:00
Oliver Günther
7f1cfc5555 feat(openproject): Update to 15.5.0 2025-04-22 14:07:55 +02:00
Dominik Kaminski
9cde57d74b feat(helmfile): Add template support for annotations 2025-04-22 14:07:55 +02:00
Thorsten Roßner
cf750a8ddb chore: Update release/version info in publiccode.yml and global.generated.yaml.gotmpl 2025-04-22 14:07:55 +02:00
Thorsten Roßner
8f12208074 feat(collabora): Update to 24.04.13 2025-04-22 14:07:55 +02:00
Norbert Tretkowski
90c49f6f83 feat(nubus): Update to 1.8.0 2025-04-22 14:07:55 +02:00
René Fischer
e25cb5e0f3 docs(testing.md): Add link to load test repo and information about nightly tests 2025-04-22 14:07:55 +02:00
Thorsten Roßner
79975a58e3 feat(helmfile): Support for SSO federation; see ssoFederation section in functional.yaml.gotmpl for details 2025-04-22 14:07:55 +02:00
Ben Schlagbauer
02867c47c0 docs: Overall fixes improvements 2025-04-22 14:07:55 +02:00
Thorsten Roßner
4df50b011d ci: Ensure "DEPLOY" options are grouped together 2025-04-22 14:07:55 +02:00
Thorsten Roßner
c22b467a61 docs(README-EE.md): More detailled information regarding oD EE artifacts 2025-04-22 14:07:55 +02:00
René Fischer
4bf98d0da0 chore(docs): Fix links in docs 2025-04-22 14:07:55 +02:00
Ben Schlagbauer
8585b8419e docs: Overall fixes improvements 2025-04-22 14:07:55 +02:00
Simon Herman
464efb41f2 docs(requirements): Add information on compatibility with Ingress-NGINX >= 1.12.0 2025-04-22 14:07:54 +02:00
René Fischer
790baebf71 chore(docs): Merge info repo contents 2025-04-22 14:07:54 +02:00
Thorsten Roßner
3fcfa00503 fix(helmfile): Support for Keycloak session settings via functional.authentication.realmSettings.* 2025-04-22 14:07:47 +02:00
Norbert Tretkowski
fe664a7f8d fix(ox-connector): Update to v0.19.0 2025-04-22 07:49:27 +02:00
Thorsten Roßner
67a1df0f80 fix(xwiki): Update Helm chart to v1.4.4 to fix the problem with XWiki not starting when secrets contained specific (XML interpreted) characters 2025-04-22 07:49:27 +02:00
Thorsten Roßner
6e6d15552e fix(helmfile): Remove no longer used secrets.nubus.defaultAccounts.* 2025-04-22 07:49:27 +02:00
Thomas Kaltenbrunner
46b38342d3 fix(helmfile): Fix Kyverno lint issues for EE components 2025-04-22 07:49:27 +02:00
René Fischer
08ee9ee44c chore(docs): Fix links in docs 2025-04-11 10:15:18 +02:00
158 changed files with 8427 additions and 2369 deletions

View File

@@ -4,7 +4,7 @@
--- ---
include: include:
- project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}" - project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}"
ref: "v2.4.8" ref: "v2.4.10"
file: file:
- "ci/common/lint.yml" - "ci/common/lint.yml"
- "ci/release-automation/semantic-release.yml" - "ci/release-automation/semantic-release.yml"
@@ -29,7 +29,7 @@ include:
rules: rules:
- if: > - if: >
$JOB_OPENDESK_LINTER_ENABLED == 'false' || $JOB_OPENDESK_LINTER_ENABLED == 'false' ||
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event|web|trigger|api|schedules' $CI_PIPELINE_SOURCE =~ 'tags|merge_request_event|web|trigger|api'
when: "never" when: "never"
- when: "always" - when: "always"
@@ -80,6 +80,15 @@ variables:
options: options:
- "yes" - "yes"
- "no" - "no"
FLUSH_EXTERNAL_SERVICES_TYPE:
description: >
Select the type of external services (e.g. "RUN", or "STACKIT"), as they require different
cleanup strategies. Requires `FLUSH_EXTERNAL_SERVICES_BEFORE=yes` and `ENV_STOP_BEFORE=yes`.
value: "CHANGE ME"
options:
- "RUN"
- "STACKIT"
- "CHANGE ME"
DEBUG_ENABLED: DEBUG_ENABLED:
description: > description: >
Allows to set `debug.enabled` to true for a deployment, needs to be supported by stage specific Allows to set `debug.enabled` to true for a deployment, needs to be supported by stage specific
@@ -168,6 +177,12 @@ variables:
options: options:
- "yes" - "yes"
- "no" - "no"
DEPLOY_NOTES:
description: "Enable Notes deployment."
value: "no"
options:
- "yes"
- "no"
CREATE_DEFAULT_ACCOUNTS: CREATE_DEFAULT_ACCOUNTS:
description: > description: >
Creates `default` and `default-admin` in the instance using the password defined as CI variable Creates `default` and `default-admin` in the instance using the password defined as CI variable
@@ -176,12 +191,9 @@ variables:
options: options:
- "yes" - "yes"
- "no" - "no"
DEPLOY_NOTES: DIFF_ON_BRANCH:
description: "Enable Notes deployment." description: "Provide a branch to run `helmfile diff` for the specified branch."
value: "no" value: ""
options:
- "yes"
- "no"
RUN_TESTS: RUN_TESTS:
description: "Triggers execution of E2E-tests." description: "Triggers execution of E2E-tests."
value: "no" value: "no"
@@ -220,6 +232,9 @@ variables:
TESTS_PROJECT_URL: TESTS_PROJECT_URL:
description: "Project url for e2e-tests (`<domain of gitlab>/api/v4/projects/<id>`)" description: "Project url for e2e-tests (`<domain of gitlab>/api/v4/projects/<id>`)"
value: "gitlab.opencode.de/api/v4/projects/1506" value: "gitlab.opencode.de/api/v4/projects/1506"
HELM_IMAGE_PIN:
description: "The Helm image tag/checksum."
value: "1.3.3@sha256:3e195942e6988b8b93c62349700c0ed8428e3a8fbe2655bd7f5378dc88bc8ccb"
# Declare .environments which is in `opendesk-env` repository. In case it is not available # Declare .environments which is in `opendesk-env` repository. In case it is not available
# 'cache' is used because job as a dummy key, as the job is not allowed to be empty. # 'cache' is used because job as a dummy key, as the job is not allowed to be empty.
@@ -232,8 +247,7 @@ variables:
extends: ".environments" extends: ".environments"
environment: environment:
name: "${NAMESPACE}" name: "${NAMESPACE}"
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:1.1.0\ image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:${HELM_IMAGE_PIN}"
@sha256:74f349066ac5d20e3afaa6abd28781b4c8dc086f67e3d3c1b8345e4a9c3371b1"
script: script:
- "cd ${CI_PROJECT_DIR}/helmfile/apps/${COMPONENT}" - "cd ${CI_PROJECT_DIR}/helmfile/apps/${COMPONENT}"
# MASTER_PASSWORD_WEB_VAR as precedence for MASTER_PASSWORD # MASTER_PASSWORD_WEB_VAR as precedence for MASTER_PASSWORD
@@ -267,53 +281,77 @@ db-cleanup:
when: "on_success" when: "on_success"
script: script:
# yamllint disable-line rule:line-length rule:quoted-strings # yamllint disable-line rule:line-length rule:quoted-strings
- export FILES=(${CI_PROJECT_DIR}/helmfile/environments/default/database.yaml.gotmpl ${CI_PROJECT_DIR}/helmfile/environments/dev/write-over-values-for-environment.yaml.gotmpl)
# Cleanup MariaDB
- | - |
export DATABASES="oxAppSuite" echo "Checking FLUSH_EXTERNAL_SERVICES_TYPE value..."
export MARIADB_HOST="" case "$FLUSH_EXTERNAL_SERVICES_TYPE" in
export MARIADB_PORT="" "RUN")
export MARIADB_USERNAME="" echo " ... running flush procedure for RUN cluster."
export MARIADB_PASSWORD="" ;;
"STACKIT")
for DATABASE in $DATABASES; do echo " ... running flush procedure for STACKIT provider."
export ENV_DATABASE=${DATABASE} ;;
*)
echo "ERROR: FLUSH_EXTERNAL_SERVICES_TYPE is not set to valid value."
echo " Expected 'RUN' or 'STACKIT', got ${FLUSH_EXTERNAL_SERVICES_TYPE}."
exit 1
;;
esac
# First: Gather all files that contain the "database:" keyword in the default environment
- |
export FILES="$(grep -r 'databases:' "${CI_PROJECT_DIR}/helmfile/environments/default" |
awk -F ':' '{print $1}')"
# Second: Gather all files that contain the "database:" keyword in the dev environment
# where the adjustments from opendesk-env are placed
- |
export FILES="${FILES} $(grep -r 'databases:' "${CI_PROJECT_DIR}/helmfile/environments/dev" |
awk -F ':' '{print $1}')"
- "echo \"${FILES[@]}\""
# Cleanup MariaDB
- "export MARIADB_HOST=\"\""
- "export MARIADB_PORT=\"\""
- "export MARIADB_USERNAME=\"\""
- "export MARIADB_PASSWORD=\"\""
- "export ENV_DATABASE=\"oxAppSuite\""
# Parse cluster values # Parse cluster values
- |
for FILE in ${FILES[@]}; do for FILE in ${FILES[@]}; do
if [ -f ${FILE} ]; then if [ -f "${FILE}" ]; then
if [[ $(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)]') != "null" ]]; then if [[ $(tail -n +1 "${FILE}" | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)]') != "null" ]]; then
MARIADB_DATABASE=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].name') MARIADB_DATABASE=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].name')
MARIADB_USERNAME=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].username') MARIADB_USERNAME=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].username')
MARIADB_PASSWORD=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].password') MARIADB_PASSWORD=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].password')
MARIADB_HOST=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].host') MARIADB_HOST=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].host')
MARIADB_PORT=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].port') MARIADB_PORT=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].port')
fi; fi;
fi; fi;
done; done;
CONNECTION="--host=${MARIADB_HOST} \ - |
--port=${MARIADB_PORT} \ export CONNECTION=(
--user=${MARIADB_USERNAME} \ "--host=${MARIADB_HOST}"
--password=${MARIADB_PASSWORD} \ "--port=${MARIADB_PORT}"
--skip-ssl" "--user=${MARIADB_USERNAME}"
"--password=${MARIADB_PASSWORD}"
"--skip-ssl"
)
echo "[mysql] [${ENV_DATABASE}] DROP ${MARIADB_DATABASE} on ${MARIADB_HOST}" - "echo \"[mysql] [${ENV_DATABASE}] DROP ${MARIADB_DATABASE} on ${MARIADB_HOST}\""
mariadb ${CONNECTION} -e "DROP DATABASE IF EXISTS ${MARIADB_DATABASE};" - "mariadb ${CONNECTION[@]} -e \"DROP DATABASE IF EXISTS ${MARIADB_DATABASE};\""
- |
if [ "${ENV_DATABASE}" = "oxAppSuite" ]; then if [ "${ENV_DATABASE}" = "oxAppSuite" ]; then
echo "[mysql] [${ENV_DATABASE}] DROP oxguard on ${MARIADB_HOST}" echo "[mysql] [${ENV_DATABASE}] DROP oxguard on ${MARIADB_HOST}"
mariadb ${CONNECTION} -e "DROP DATABASE IF EXISTS oxguard;" mariadb ${CONNECTION[@]} -e "DROP DATABASE IF EXISTS oxguard;"
echo "[mysql] [${ENV_DATABASE}] DROP oxguard_1 on ${MARIADB_HOST}" echo "[mysql] [${ENV_DATABASE}] DROP oxguard_1 on ${MARIADB_HOST}"
mariadb ${CONNECTION} -e "DROP DATABASE IF EXISTS oxguard_1;" mariadb ${CONNECTION[@]} -e "DROP DATABASE IF EXISTS oxguard_1;"
echo "[mysql] [${ENV_DATABASE}] DROP PRIMARYDB_9 on ${MARIADB_HOST}" echo "[mysql] [${ENV_DATABASE}] DROP PRIMARYDB_9 on ${MARIADB_HOST}"
mariadb ${CONNECTION} -e "DROP DATABASE IF EXISTS PRIMARYDB_9;" mariadb ${CONNECTION[@]} -e "DROP DATABASE IF EXISTS PRIMARYDB_9;"
else else
mariadb ${CONNECTION} -e "CREATE DATABASE ${MARIADB_DATABASE};" mariadb ${CONNECTION[@]} -e "CREATE DATABASE ${MARIADB_DATABASE};"
mariadb ${CONNECTION} -e "GRANT ALL PRIVILEGES ON ${MARIADB_DATABASE}.* TO ${MARIADB_USERNAME}@\"%\";" mariadb ${CONNECTION[@]} -e "GRANT ALL PRIVILEGES ON ${MARIADB_DATABASE}.* TO ${MARIADB_USERNAME}@\"%\";"
mariadb ${CONNECTION} -e "FLUSH PRIVILEGES;" mariadb ${CONNECTION[@]} -e "FLUSH PRIVILEGES;"
fi; fi;
done;
# Cleanup PostgreSQL # Cleanup PostgreSQL
- | - |
export DATABASES="keycloak keycloakExtension nextcloud notes openproject synapse umsGuardianManagementApi \ export DATABASES="keycloak keycloakExtension nextcloud notes openproject synapse umsGuardianManagementApi \
@@ -331,17 +369,27 @@ db-cleanup:
# Parse cluster values # Parse cluster values
for FILE in ${FILES[@]}; do for FILE in ${FILES[@]}; do
if [ -f $FILE ]; then if [ -f $FILE ]; then
if [[ $(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)]') != "null" ]]; then if [[ $(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)]') != "null" ]]; then
POSTGRES_DATABASE=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].name') POSTGRES_DATABASE=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].name')
PGUSER=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].username') PGUSER=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].username')
PGPASSWORD=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].password') PGPASSWORD=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].password')
PGHOST=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].host') PGHOST=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].host')
PGPORT=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].port') PGPORT=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].port')
PGPARAMS=$(tail -n +5 $FILE | yq '.databases.[env(ENV_DATABASE)].parameters') PGPARAMS=$(tail -n +1 $FILE | grep -v '{{' | yq '.databases.[env(ENV_DATABASE)].parameters')
fi; fi;
fi; fi;
done; done;
case "$FLUSH_EXTERNAL_SERVICES_TYPE" in
"STACKIT")
# In case of STACKIT resources the db content should just be dropped
echo "[psql] [${ENV_DATABASE}] DROP OWNED BY ${PGUSER} in ${POSTGRES_DATABASE} on ${PGHOST}"
PGDATABASE=${POSTGRES_DATABASE} # env var PGDATABASE is interpreted by psql
psql -c "DROP OWNED BY ${PGUSER};" || true;
;;
"RUN")
# Usually, e.g. in "RUN" cluster, databases can simply be dropped and recreated
echo "[psql] [${ENV_DATABASE}] DROP ${POSTGRES_DATABASE} on ${PGHOST}" echo "[psql] [${ENV_DATABASE}] DROP ${POSTGRES_DATABASE} on ${PGHOST}"
psql -c "DROP DATABASE ${POSTGRES_DATABASE}" || true; psql -c "DROP DATABASE ${POSTGRES_DATABASE}" || true;
if [ "${PGPARAMS}" = "null" ]; then if [ "${PGPARAMS}" = "null" ]; then
@@ -351,10 +399,12 @@ db-cleanup:
fi; fi;
psql -c "ALTER DATABASE \"${POSTGRES_DATABASE}\" OWNER TO \"${PGUSER}\""; psql -c "ALTER DATABASE \"${POSTGRES_DATABASE}\" OWNER TO \"${PGUSER}\"";
psql -c "GRANT ALL PRIVILEGES ON DATABASE \"${POSTGRES_DATABASE}\" TO \"${PGUSER}\""; psql -c "GRANT ALL PRIVILEGES ON DATABASE \"${POSTGRES_DATABASE}\" TO \"${PGUSER}\"";
;;
esac
done; done;
# Cleanup Objectstore # Cleanup Objectstore
- | - |
export BUCKETS="migrations nextcloud openproject nubus notes" export BUCKETS="migrations nextcloud openproject nubus notes openxchange dovecot"
export AWS_DEFAULT_REGION="" export AWS_DEFAULT_REGION=""
export AWS_ENDPOINT="" export AWS_ENDPOINT=""
export AWS_ACCESS_KEY_ID="" export AWS_ACCESS_KEY_ID=""
@@ -366,12 +416,12 @@ db-cleanup:
# Parse cluster values # Parse cluster values
for FILE in ${FILES[@]}; do for FILE in ${FILES[@]}; do
if [ -f $FILE ]; then if [ -f $FILE ]; then
if [[ $(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)]') != "null" ]]; then if [[ $(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)]') != "null" ]]; then
AWS_BUCKET=$(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)].bucket') AWS_BUCKET=$(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)].bucket')
AWS_ENDPOINT=$(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)].endpoint') AWS_ENDPOINT=$(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)].endpoint')
AWS_ACCESS_KEY_ID=$(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)].username') AWS_ACCESS_KEY_ID=$(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)].username')
AWS_SECRET_ACCESS_KEY=$(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)].secretKey') AWS_SECRET_ACCESS_KEY=$(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)].secretKey')
AWS_DEFAULT_REGION=$(tail -n +5 $FILE | yq '.objectstores.[env(ENV_BUCKET)].region') AWS_DEFAULT_REGION=$(tail -n +1 $FILE | grep -v '{{' | yq '.objectstores.[env(ENV_BUCKET)].region')
fi; fi;
fi; fi;
done; done;
@@ -390,6 +440,7 @@ env-cleanup:
when: "on_success" when: "on_success"
script: script:
- | - |
echo "Cleaning up ${NAMESPACE}"
if [ "${OPENDESK_SLEDGEHAMMER_DESTROY_ENABLED}" = "yes" ]; then if [ "${OPENDESK_SLEDGEHAMMER_DESTROY_ENABLED}" = "yes" ]; then
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE}; helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
@@ -671,6 +722,35 @@ fetch-administrator-credentials:
reports: reports:
dotenv: ".env" dotenv: ".env"
diff-on-branch:
stage: "post-execute"
cache: {}
dependencies: []
extends: ".environments"
environment:
name: "${NAMESPACE}"
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:${HELM_IMAGE_PIN}"
rules:
- if: "$DIFF_ON_BRANCH"
script:
- |
echo "Downloading branch ${DIFF_ON_BRANCH}"
SAFE_BRANCH_NAME=$(echo "$DIFF_ON_BRANCH" | tr '/' '-')
BASE_URL="https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/archive"
FILE_NAME="opendesk-${SAFE_BRANCH_NAME}.tar.gz"
curl -L "${BASE_URL}/${DIFF_ON_BRANCH}/${FILE_NAME}" -o branch.tar.gz
mkdir ${DIFF_ON_BRANCH_SUBDIRECTORY} &&
tar -xzf branch.tar.gz -C ${DIFF_ON_BRANCH_SUBDIRECTORY} --strip-components=1
cd ${DIFF_ON_BRANCH_SUBDIRECTORY}
helmfile --namespace ${NAMESPACE} diff | grep -v '^ ' || true
tags:
- "docker"
- "kubernetes"
- "${CLUSTER}"
variables:
HELMFILE_ENVIRONMENT: "dev"
DIFF_ON_BRANCH_SUBDIRECTORY: "diff-on-branch"
import-default-accounts: import-default-accounts:
stage: "post-execute" stage: "post-execute"
extends: ".environments" extends: ".environments"
@@ -696,6 +776,7 @@ import-default-accounts:
--admin_enable_knowledgemanagement True \ --admin_enable_knowledgemanagement True \
--admin_enable_projectmanagement True \ --admin_enable_projectmanagement True \
--create_admin_accounts True \ --create_admin_accounts True \
--create_maildomains True \
--verify_certificate False --verify_certificate False
run-tests: run-tests:
@@ -769,6 +850,17 @@ avscan-prepare:
stage: "scan" stage: "scan"
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/clamav-imagescan:1.0.0" image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/clamav-imagescan:1.0.0"
before_script: before_script:
- "mkdir -p ~/.docker"
- |
cat << EOF > ~/.docker/config.json
{
"auths": {
"$CI_REGISTRY": {
"auth": "$(printf %s:%s ${CI_REGISTRY_USER} ${CI_REGISTRY_PASSWORD} | base64 | tr -d '\n')"
}
}
}
EOF
- "sed -i \"/^DatabaseMirror .*$/c DatabaseMirror ${DATABASE_MIRROR}\" /etc/clamav/freshclam.conf" - "sed -i \"/^DatabaseMirror .*$/c DatabaseMirror ${DATABASE_MIRROR}\" /etc/clamav/freshclam.conf"
- "freshclam" - "freshclam"
- "mkdir /scan" - "mkdir /scan"

View File

@@ -0,0 +1,62 @@
# 🪲 Bugfix
*Expected MR Title and git commit message*
*`fix(<app-name>): <Short description of what has been fixed>`*
## ✅ Changes
Explain for the reviewer how the change addresses the issue, providing some insights on the underlaying cause of the bug.
- ...
## 🧪 How to reproduce & test
Provida a link to the issue or document the required details below.
In case it is a GitLab issue, reference it at the end of the commit message in square brackets, like `[#123]`
Provide steps for QA or reviewers to test the fix and mention anything reviewers should be aware of.
### Steps to reproduce
1. ...
### Actual behaviour
*Based on the "Steps to reproduce" explain what the user sees while the bug isn't fixed.*
### Expected behaviour
*Based on the "Steps to reproduce" explain what the user gets to see with the bug fix merged.*
## 🔄 Requirements for migrations
- [ ] Describe manual steps required to update existing deployments. This especially applies if this MR introduces breaking changes:
- [ ] Any other considerations in context of the update:
# Checklist / Sign-offs
## 🏷️ Labels
Set labels:
```
/label ~"MR-Type::Bugfix"
/label ~"PO::👀"
/label ~"Tech Lead::👀"
/label ~"QA::👀"
/label ~"Testautomation::👀"
```
# 👷 Developer Checklist
**Documentation:**
Does this MR introduce changes (e.g., new secrets, configuration options) that require documentation?
- [ ] No
- [ ] Yes, and the documentation has been updated accordingly
**Quality Assurance:**
- [ ] Verified that the feature works as expected, including upgrade scenarios
- [ ] Performed regression testing
- Link to internal comment(s) with detailed QA results (to avoid exposing infrastructure details):
- ...

View File

@@ -1,16 +1,13 @@
<!-- Thank you for your contribution!
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0
-->
# Summary Please follow these simple guidelines to continue:
- *describe the reason for/content of the MR* - Select a MR template in case you contribution is covers more than simple documentation/non functional changes:
- `Update`: Major/minor updates of openDesk core applications, the ones listed on the [README.md](../../README.md). Main commit should be `feat(component): ...`
# Commits - `Bugfix`: For (bug)fixes in the platform or non-update/feature releases of the openDesk core applications. Main commit should be `fix(component): ...`
- `Feature`: An update in the platform providing support for a specific feature. Main commit should be `feat(component): ...`
%{all_commits} - `Other`: All other changes.
- In case you just do a `chore`/`docs` commit, you can skip the templates from above.
# Authors - Create MRs early and use the "draft" state to show that this MR isn't ready for review and merge.
- Always assign the MR to yourself and set somebody from the development team as reviewer. If you do not know whom to chose leave the reviewer empty.
%{co_authored_by} - Flag the MR "ready" as soon as it can be reviewed and QA'd.

View File

@@ -0,0 +1,49 @@
# ⬆️ Feature
*Expected MR Title and git commit message*
*`feat(<app-name>): <Short description of the new feature>`*
## ✅ Changes
List the key changes made in this MR:
- ...
## 🧪 Tests
Provide steps for QA or reviewers to test the feature and mention anything reviewers should be aware of:
- ...
## 🔄 Requirements for migrations
- [ ] Describe manual steps required to update existing deployments. This especially applies if this MR introduces breaking changes:
- [ ] Any other considerations in context of the update:
# Checklist / Sign-offs
## 🏷️ Labels
Set labels:
```
/label ~"MR-Type::Feature"
/label ~"PO::👀"
/label ~"Tech Lead::👀"
/label ~"QA::👀"
/label ~"Testautomation::👀"
```
# 👷 Developer Checklist
**Documentation:**
Does this MR introduce changes (e.g., new secrets, configuration options) that require documentation?
- [ ] No
- [ ] Yes, and the documentation has been updated accordingly
**Quality Assurance:**
- [ ] Verified that the feature works as expected, including upgrade scenarios
- [ ] Performed regression testing
- Link to internal comment(s) with detailed QA results (to avoid exposing infrastructure details):
- ...

View File

@@ -0,0 +1,43 @@
# 🎉 Other
*Expected MR Title and git commit message*
*`fix(<component>): <Short description of what has been changed>`*
## ✅ Changes
Explain for the reviewer and QA the reason for the MR and what changes are included.
- ...
## 🔄 Requirements for migrations
- [ ] Describe manual steps required to update existing deployments. This especially applies if this MR introduces breaking changes:
- [ ] Any other considerations in context of the update:
# Checklist / Sign-offs
## 🏷️ Labels
Set labels:
```
/label ~"MR-Type::Other"
/label ~"PO::👀"
/label ~"Tech Lead::👀"
/label ~"QA::👀"
/label ~"Testautomation::👀"
```
# 👷 Developer Checklist
**Documentation:**
Does this MR introduce changes (e.g., new secrets, configuration options) that require documentation?
- [ ] No
- [ ] Yes, and the documentation has been updated accordingly
**Quality Assurance:**
- [ ] Verified that the feature works as expected, including upgrade scenarios
- [ ] Performed regression testing
- Link to internal comment(s) with detailed QA results (to avoid exposing infrastructure details):
- ...

View File

@@ -0,0 +1,43 @@
# ⬆️ Application Update
*Expected MR Title and git commit message*
*`feat/fix(<app-name>): Update from <old-version> to <new-version>`*
## 📋 Changelog/Release Notes
- [ ] [README.md](../../README.md) component table updated including the link to the related release notes of the updated application.
- [ ] Provide significant improvements you would like to see in the [openDesk release notes](https://www.opendesk.eu/en/blog/opendesk-1-6). If you have a lot of details to provide or someone else is providing the details, you can use a comment on this MR and provide a link here.
## 🔄 Requirements for migrations
- [ ] Minimum version of the application required in existing depoyments to update/upgrade:
- [ ] Describe manual steps required to update existing deployments. This especially applies if the upgrade includes any breaking changes:
- [ ] Any other considerations in context of the update:
# Checklist / Sign-offs
## 🏷️ Labels
Set labels:
```
/label ~"MR-Type::AppUpdate"
/label ~"PO::👀"
/label ~"Tech Lead::👀"
/label ~"QA::👀"
/label ~"Testautomation::👀"
```
# 👷 Developer Checklist
**Documentation:**
Does this MR introduce changes (e.g., new secrets, configuration options) that require documentation?
- [ ] No
- [ ] Yes, and the documentation has been updated accordingly
**Quality Assurance:**
- [ ] Verified that the feature works as expected, including upgrade scenarios
- [ ] Performed regression testing
- Link to internal comment(s) with detailed QA results (to avoid exposing infrastructure details):
- ...

View File

@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<svg id="Ebene_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 693.25 214.02">
<defs>
<style>
.cls-1 {
fill: #571efa;
}
.cls-2 {
fill: #927afa;
}
</style>
</defs>
<g>
<path class="cls-2" d="M126.14,140.32v2.13c0,8.99-7.31,16.3-16.3,16.3h-38.26c-8.99,0-16.3-7.31-16.3-16.3v-38.26c0-8.99,7.31-16.3,16.3-16.3h2.13v52.44h52.44Z"/>
<path class="cls-1" d="M126.85,127.56h-40.39v-44.65c0-15.24,12.4-27.64,27.64-27.64h12.76c17.58,0,31.89,14.31,31.89,31.89v8.5c0,17.58-14.31,31.89-31.89,31.89ZM104.88,109.13h21.97c7.42,0,13.46-6.04,13.46-13.46v-8.5c0-7.42-6.04-13.46-13.46-13.46h-12.76c-5.08,0-9.21,4.13-9.21,9.21v26.22Z"/>
</g>
<g>
<path d="M210.82,90.76c14.85,0,24.34,10.9,24.34,24.25s-9.49,24.25-24.34,24.25-24.44-10.9-24.44-24.25,9.49-24.25,24.44-24.25ZM210.82,133.34c11.37,0,17.39-8.46,17.39-18.33s-6.02-18.33-17.39-18.33-17.48,8.46-17.48,18.33,6.01,18.33,17.48,18.33Z"/>
<path d="M244.19,91.7h6.96v11.84c3.29-7.8,10.25-12.78,20.4-12.78,13.07,0,21.9,9.87,21.9,24.34s-8.83,24.16-21.9,24.16c-10.34,0-17.2-5.17-20.4-12.78v28.95h-6.96v-63.73ZM269.38,133.34c9.4,0,17.11-5.83,17.11-18.24s-7.71-18.42-17.11-18.42-17.95,6.11-17.95,18.42,8.65,18.24,17.95,18.24Z"/>
<path d="M322.96,90.76c13.35,0,22.28,8.37,22.28,22.65v2.82h-37.5c.28,9.78,5.26,17.29,15.6,17.29,8.55,0,13.54-4.51,15.23-11.47h6.86c-1.97,8.27-7.61,17.2-21.9,17.2-15.13,0-22.46-11.28-22.46-24.91,0-15.04,8.74-23.59,21.9-23.59ZM338.37,110.78c-.66-9.12-6.77-14.29-15.51-14.29-8.18,0-14.29,5.26-15.04,14.29h30.55Z"/>
<path d="M355.01,91.7h6.96v12.97c2.54-8.65,9.12-13.91,19.36-13.91s16.73,6.77,16.73,18.99v28.57h-7.05v-28.01c0-9.68-3.76-13.63-12.03-13.63-10.53,0-17.01,8.84-17.01,21.34v20.3h-6.96v-46.62Z"/>
<path d="M409.81,72.05h24.35c6.89,0,12.97.85,18.24,2.54,5.26,1.69,9.57,4.98,12.92,9.87,3.35,4.89,5.03,11.78,5.03,20.68s-1.68,15.89-5.03,20.77c-3.35,4.89-7.66,8.18-12.92,9.87-5.27,1.69-11.34,2.54-18.24,2.54h-24.35v-66.27ZM434.16,125.07c4.76,0,8.57-.38,11.42-1.13s5.17-2.55,6.96-5.41c1.79-2.85,2.68-7.32,2.68-13.39s-.91-10.46-2.72-13.35c-1.82-2.88-4.14-4.7-6.96-5.45s-6.61-1.13-11.37-1.13h-9.31v39.86h9.31Z"/>
<path d="M480.17,101.33c2.1-3.67,5.01-6.47,8.74-8.41s8.01-2.91,12.83-2.91c7.9,0,14.07,2.1,18.52,6.3,4.45,4.2,6.67,10,6.67,17.39v3.95h-35.53c.25,3.38,1.32,6.03,3.2,7.94,1.88,1.91,4.45,2.87,7.71,2.87,2.82,0,5.15-.59,7-1.79,1.85-1.19,3.02-2.88,3.53-5.08h14.19c-.75,5.26-3.28,9.53-7.57,12.78-4.29,3.26-9.98,4.89-17.06,4.89-5.2,0-9.71-1.05-13.54-3.15-3.82-2.1-6.75-5.03-8.79-8.79-2.04-3.76-3.05-8.08-3.05-12.97s1.05-9.35,3.15-13.02ZM513.02,109.93c-.25-3.01-1.36-5.33-3.34-6.96-1.97-1.63-4.53-2.44-7.66-2.44s-5.56.82-7.47,2.44c-1.91,1.63-2.99,3.95-3.24,6.96h21.71Z"/>
<path d="M539.62,134.65c-4.14-3.07-6.21-7.58-6.21-13.54h14.29c0,2.7.85,4.69,2.54,5.97,1.69,1.29,4.29,1.93,7.8,1.93,2.57,0,4.43-.33,5.59-.99,1.16-.66,1.74-1.71,1.74-3.15,0-1-.34-1.82-1.03-2.44-.69-.63-1.79-1.16-3.29-1.6l-14.48-3.95c-3.2-.81-5.95-2.27-8.27-4.37-2.32-2.1-3.48-5-3.48-8.7,0-4.45,1.83-7.86,5.5-10.25,3.67-2.38,8.79-3.57,15.37-3.57,7.27,0,12.94,1.46,17.01,4.37s6.11,7.13,6.11,12.64h-14.29c0-4.57-2.91-6.86-8.74-6.86-2.07,0-3.7.35-4.89,1.03-1.19.69-1.79,1.6-1.79,2.73,0,1.94,1.72,3.35,5.17,4.23l11.09,2.73c4.32,1.07,7.79,2.71,10.39,4.94,2.6,2.22,3.9,5.34,3.9,9.35,0,4.58-1.83,8.07-5.5,10.48-3.67,2.41-9.1,3.62-16.31,3.62-8.02,0-14.1-1.54-18.24-4.61Z"/>
<path d="M587.56,69.23h14.29v40.04l18.89-18.33h17.48l-23.59,23.03,23.5,24.35h-17.39l-18.89-19.93v19.93h-14.29v-69.09Z"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 370 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 321 KiB

View File

@@ -1,3 +1,192 @@
## [1.7.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.7.0...v1.7.1) (2025-08-26)
### Bug Fixes
* **collabora:** Update from 25.04.3 to 25.04.4 ([84d6b50](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/84d6b504d21e687de3fb4cdabafc9cff6fe1f1d7))
* **helmfile:** When optional mail domain is set, use it as sender domain for system generated (noreply) mails ([bd4c997](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bd4c997950750e36168434e82daf48f20d0a42df))
* **jitsi:** Increase `patchJVB` job `backoffLimit` to avoid deployment failures on infrastructure where LoadBalancer services take longer to become available ([eb2a181](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/eb2a1811fb1d11b0dd0ea0e9987f96846a855ac7))
* **nextcloud:** Fetch central navigation from cluster internal service ([dd0e516](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/dd0e516778104c47ef990d95d01bdec6b33d9bab))
* **nextcloud:** Stop browser from caching server-generated files ([410a1ad](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/410a1ade6907f676d3c4cbc68b33754e0e41e9fb))
* **nextcloud:** Work around a bug that breaks the `nextcloud-management` job in case the theming `primary_color` was set in Nextcloud's web UI ([4aebe22](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4aebe22f22dc9e679563a46687ebdc8793c281e8))
* **notes:** Explicitly template security contexts; add missing ingress classes and pull secrets ([834c847](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/834c84768a3a6537990e27377acb170b6269dfb0))
* **nubus:** Remove temporary `nubusUdmListener` `livenessProbe` as recommended by supplier ([688a505](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/688a505ef780e7c81006a73db6465ef75dea1404))
* **open-xchange:** Click on top bar logo to point to portal instead of mail inbox ([9f762a7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9f762a7c2ea3f8e4d3207d8d2aae44597a366ee0))
* **open-xchange:** Configure correct autoreply addresses and enable FTS in Dovecot EE ([997c083](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/997c083335b79aa7446894b6ebbb6ed1d5950a3d))
* **open-xchange:** Explicitly deactivate DAV support if not enabled in `functional.yaml.gotmpl` ([62ba5ab](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/62ba5aba496af40208a13abeb6c8f1de62e98e35))
* **open-xchange:** Fix FTS bulk delete in Dovecot EE ([cd2a356](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/cd2a356b89249b8a163f2becc57832164bc6c8e5))
* **open-xchange:** Set mail quota using `functional.groupware.quota.default` ([67fe50e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/67fe50e53c7477016efe3b3d90c63214928f165c))
* **opendesk-static-files:** Serve missing `.png` favicons for Notes and the Nextcloud topbar logo ([42b1105](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/42b11059d29d6445e1e4e3309ad7a9a026b56c92))
* **ox-connector:** Update OX Connector and OX Extension to v0.27.7 ([57c96af](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/57c96af5a545a6a6851926b85bca0dc24263b55e))
* **xwiki:** Templating of `imagePullSecrets` ([bbbcd68](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bbbcd6807e972c6120d90df52b8ffe9da03ebce3))
# [1.7.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.6.0...v1.7.0) (2025-08-11)
### Bug Fixes
* **collabora:** Connect to Collabora Controller websocket via service ([5d01f60](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5d01f6023d6d300e106cc86dfca09a4ae388f4ca))
* **collabora:** Update from 25.04.2 to 25.04.3 ([3507c62](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3507c62f832556c5d76e7a5b206acbdbcaca37a8))
* **helmfile:** Adds default-enterprise-overrides to default values in helmfile-generic ([672e649](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/672e649b608fa03f04834837f13c360a08e8eb6c))
* **nextcloud:** Block filesystem-unsafe characters in file and folder names ([0df6212](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0df6212ca9399d39bedc30c064cbae80c2684e44))
* **nextcloud:** Include latest Helm chart version with supports `configuration.sharing.restrictUserEnumerationToGroup` ([c3dfa2a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c3dfa2a6075ae388764acbb20bd8282a64183ed3))
* **notes:** Set Pod Disruption Budget (PDB) labels ([e35dac0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e35dac087aac54f545d361dee881196b264af906))
* **nubus:** Add `livenessProbe` for `nubusUdmListener` to mitigate cases where the listener becomes uninitialized and stops forwarding provisioning data to NATS. Temporary until upstream provides a probe ([ef8d67f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/ef8d67f3c1525de6f958ac7a8893b4b30ea3f7dc))
* **open-xchange:** Disable documents role ([573e11f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/573e11f5c5103ee5906b0168317054a7e5a22e87))
* **open-xchange:** Postfix to support submissions and external secrets ([13ab665](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/13ab6659001abf5b6c683bf6a9309972ef7412b3))
* **open-xchange:** Support application specific passwords in groupware when CalDAV/CardDAV support is enabled, see `functional.groupware.davSupport.enabled` for reference ([90b2290](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/90b22904dab0195f505021beb785317f8969ff7d))
* **open-xchange:** Use dedicated pod for migration ([6fd52b1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6fd52b167eeed5c7e9eda2a21b209680131380ee))
* **opendesk-certificates:** Update Helm chart to remove default host for `webmail` being set even if OX App Suite is not enabled ([09a0aac](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/09a0aace45227b60e9b39671e747958bd339c8c9))
* **opendesk-services:** Update opendesk-alerts from 1.1.1 to 1.1.2, update opendesk-dashboards from 1.1.1 to 1.1.2 ([174d4fc](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/174d4fc61cbb718818015779012fa65353987f3c))
* **openproject:** Update from 16.2.0 to 16.2.1 ([bba9b71](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bba9b716a3fdf915bfc2925f1c27fe91494edcb0))
* **ox-connector:** Update OX Connector and OX Extension to v0.27.2; review `migrations.md` for required upgrade steps ([9d51e40](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9d51e40063d73226fc8a25365cbfa92ff09f0910))
### Features
* **nextcloud:** Enhance theming options for Nextcloud ([bdc7331](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bdc7331cb59da96941c3250625af3cb5f9b12e15))
* **notes:** Switch to new Helm chart with support for self-signed deployments; review `migrations.md` for required upgrade steps ([3106ca7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3106ca793ee1e0021f7c03e620873c49adb54199))
* **nubus:** Allow configuration of limits for password reset requests via `security.passwordResetLimits` ([09f54b4](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/09f54b41347ff5c90064c8d4c2c6a9db7f05d54c))
* **nubus:** Update from 1.11.2 to 1.12.0 ([5537dbb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5537dbbd7cb93dcb2aeafe9017c68a89d2e19293))
* **open-xchange:** Update from 8.38 to 8.39 ([489986e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/489986e906e828f3877e7a9087541f10c5bbfe8c))
* **open-xchange:** Use internal endpoint for provisioning and support for optionally spinning up a dedicated internal Pod just for provisioning (see `technial.oxAppSuite.provisioning.dedicatedCoreMwPod` for details) ([31b7ec7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/31b7ec78274e5a901b51aaaeed01e6ac82298b73))
* **openproject:** Update from 16.1.1 to 16.2.0 ([e273abb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e273abbecf58b098e76c49e1763b4c3074bf5cec))
# [1.6.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.5.0...v1.6.0) (2025-07-14)
### Bug Fixes
* **dovecot-pro:** Use of `requiredEnv` instead of `env` and update `README-EE.md` ([a79e40f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a79e40f44af68a16f0944265cc447ec9b0d84922))
* **helmfile:** Prefix NATS passwords as workaround for upstream issue and add documentation to `gettings-started.md` [[#185](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/185), [#202](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/202)] ([7f478bf](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7f478bffd60bdf3af536bc593ef397d823a22e88))
* **helmfile:** Remove default setting from `repositories.helm.registryOpencodeDeEnterprise` for better support of `PRIVATE_HELM_REGISTRY_URL` ([c5dd881](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c5dd8814ae7576eaaf7cfcdd1cb4aa101f164c62))
* **helmfile:** Set `nubusKeycloakBootstrap` debug mode when openDesk is running in debug mode ([4e0ffee](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4e0ffeea1f9d0420c404d78c5188ff6bdb0f81ea))
* **helmfile:** Streamline license header comment style [[#192](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/192)] ([20cbad3](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/20cbad31e75d9ae27081675072561650fa168935))
* **nubus:** Explicitly template `nubusStackDataUms.stackDataContext.portalFqdn` to fix custom hostname support [[#193](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/193)] ([6aa6d3a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6aa6d3af2fed1be99b4f4eb5de2e2703ca00578a))
* **nubus:** Replace openDesk portal fork with upstream `portal-frontend` image ([e4f1afc](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e4f1afca0fdf4af184f4e287f1317ed57d229013))
* **nubus:** Update from 1.11.1 to 1.11.2 ([237c9af](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/237c9af3c16885b51dcd1d7c793bf7fd23dbcefb))
* **open-xchange:** Add missing `imagePullSecrets` for `core-imageconverter` and `core-documentconverter` ([9b7f439](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9b7f439d83c9cd5a60b70f8d3ba7d36bb35ebd5c))
* **open-xchange:** Enable `com.openexchange.smime.test` only when openDesk is running with `debug.enabled: true` ([51ff7a5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/51ff7a5fdb7b7f3bdef02a32e44e6204df9db6ea))
* **open-xchange:** Enable searching by LDAP `mailAlternativeAddress` when resolving global contacts. Note: OX App Suite evaluates all `mailAlternativeAddress` values of a user when searching, but only the first address is returned, which might differ from the one that matched the search criteria. ([9014324](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/90143241564d7e66bf1b864c704e13c677dcbc93))
* **open-xchange:** Use `objectstore.dovecot.secretKey` when defined ([5c33226](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5c332264edfcbb3343bcfd39352db6ddefd0a85c))
* **opendesk-services:** Add missing certificates ([acbabdb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/acbabdb80662bf0599a157b24d3f8461e1f98cad))
* **openproject:** Update from 16.1.0 to 16.1.1 ([e30d4f1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e30d4f126dda29183cffc078307d41d3dce6f4fa))
### Features
* **collabora:** Update from 24.04.13 to 25.04.2 ([c56f564](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c56f564025531d25a1966792f8c161aedf644c99))
* **element:** Update NeoBoard from 2.1.0 to 2.2.1, NeoChoice from 1.5.1. to 1.5.2, NeoDateFix from 1.7.0 to 1.7.1 widgets and NeoDateFixBot from 2.8.2 to 2.8.3 latest releases ([98d31f8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/98d31f811bdb007e40c4b3436ff65cdcf610db7e))
* **helmfile:** Add options in `functional.yaml.gotmpl` for setting the portal's corner links, toggling the welcome message and the newsfeed ([1a6f438](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1a6f438724cc442ca7b9c423a326c67690510301))
* **nextcloud:** Update from 30.0.10 to 31.0.6 and support for notify-push ([a4c8be6](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a4c8be60f335af98270e40478e53e6fa34c23d38))
* **nubus:** Update from 1.9.1 to 1.11.1; required minimum openDesk version for this upgrade is 1.5.0, see `migrations.md` for details ([ccd5ab8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/ccd5ab84e3f5bb67eb879a3683c299d7a61ddba0))
* **open-xchange:** Store attachments for calendar, contact and task objects in object storage; review `migrations.md` for required upgrade steps ([4eb6570](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4eb6570b0a69931f09042bdc40edfad23e6f28c1))
* **open-xchange:** Updated OX App Suite from 8.37 to 8.38 ([2b31751](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/2b317514c61eba4ebc4cc9e7041aac606d8c16b8))
# [1.5.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.4.1...v1.5.0) (2025-06-16)
### Bug Fixes
* **dovecot:** Enable Dovecot ACL for CE (file) & EE (cassandra) ([9354ee7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9354ee719628c876c26e91e1b57a4a0cfafedca1))
* **notes:** Support templating of Ingress annotations `bodyTimeout` and `bodySize` to allow application defined upload limits to be reached ([69faf77](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/69faf77d15d1df441eb62c58374620f8035f2596))
* **nubus:** Create required LDAP objects for `global.additionalMailDomains` ([4dcb683](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4dcb6831189fc9cedb244c3fd7997d57e8a78c5a))
* **nubus:** Explicitly template security context for Keycloak proxy ([e959438](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e9594382ed7a2469240d62134b34bcf3e5d06a59))
* **nubus:** Update CSS for login screen to show login button for federated IdP ([0d4e1b0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0d4e1b01e3e82ace7f7438a754235a009036b90d))
* **nubus:** Use read-only root filesystem for Keycloak bootstrap ([1edd7c3](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1edd7c3f062ec411b8b38f45be9ef22a200b4bea))
* **open-xchange:** Enabled mail login resolver ([7547f49](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7547f4948ea13357c4cbc3ae69ae4e7210fdf4a2))
* **open-xchange:** Update App Suite 8.37 to latest patch level (8.37.69) ([bc436b2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bc436b248525bf76584dd21f735694065bcb67a5))
* **open-xchange:** Update Dovecot CE chart to support ACLs (mailbox sharing) and usernames different from local part of mail address ([87c30ab](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/87c30ab8e32c1b405f6aff8eda5eed5f74d5df0a))
* **open-xchange:** Use login name instead of email between OX and Dovecot ([8e9ef08](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/8e9ef0867beb8381ad4a5f55f2e9d12bd7dbbba2))
* **openproject:** Update from 16.0.0 to 16.0.1 ([b60f9c7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b60f9c7576deca327ad36c48ad0b1a7e3e9d3c9c))
### Features
* **ci:** Update Helm to 3.18.1 and Helmfile to 1.1.1 ([59a4086](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/59a40864edbdf9775e0d6003425c3b05b7b7cb15))
* **notes:** Update from 2.4.0 to 3.2.1 ([9f4e3c8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9f4e3c86c74ef6c6f618150a7a9d0935fb5ed437))
* **open-xchange:** Support for `mailAlternativAddress`(es) for sending and receiving emails ([6d6b1a6](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6d6b1a6dd754dcb283fd23f08f9df937f8e08c59))
* **openproject:** Update from 15.5.1 to 16.0.0 including Helm chart update ([add7266](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/add72669aedfcd57b41fe8680f14940ab77f6aef))
## [1.4.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.4.0...v1.4.1) (2025-06-02)
### Bug Fixes
* **nextcloud:** Update NC CE to 30.0.10 ([785be8b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/785be8b6621305e79acca62250720028b9ca7a30))
* **nextcloud:** Update Nextcloud incl. apps to 30.0.10 ([559fbf6](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/559fbf6801fc785f26f9e6287e0730f86b459a01))
* **nubus:** Use `.Values.theme.texts.productName` for Keycloak's `loginTitle` instead of static product name string ([d1a1e5d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/d1a1e5dc29ca21fd822abd127406f6859603b9c7))
* **open-xchange:** Re-adding `com.openexchange.oauth.provider.*` to fix central contacts feature ([561e44f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/561e44fd4cc42089954868da60edbd210b9a2608))
* **open-xchange:** Set `com.openexchange.hostname` to get working links in outgoing system mails (e.g. task assignments) ([0d61687](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0d616871e3f5114ec429714658500c09af842fe6))
* **postfix:** Require TLSv1.3 ([3b3d8ac](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3b3d8aca54bdaea055289c993e3f158d93864223))
* **requirements.md:** Helm 3.18.x is not supported due to upstream bug ([1ea9cae](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1ea9cae1ce46f864dc03d94c1a72956c5f5ba9a9))
# [1.4.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.2...v1.4.0) (2025-05-20)
### Bug Fixes
* **docs:** Update requirements, bump helmfile to v1.0.0 ([88b29c5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/88b29c57e8197f072b9c80019255ee0b7d1188e1))
* **dovecot:** Encode object storage password and add more template values ([c40de73](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c40de73ccf02bf77df0c3a17c2fccf2e113c4b35))
* **nubus:** [[#182](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/182)] Add `KC_TRUSTSTORE_PATHS` to Keycloak when using self-signed certificates ([006aed7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/006aed791e5cf58850712e468a15c8abe1ee0973))
* **nubus:** [[#183](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/183)] Do not override `nubusPortalConsumer.waitForDependency.image` when using self-signed certificates ([b45a0bf](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b45a0bf832506fb60488cd01c9c883b58e1d60b6))
* **nubus:** Update ArgoCD hook annotations ([f2b1384](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/f2b13846700d8a49a066b3343b043dac89d326f5))
* **open-xchange:** Update Open-Xchange to v8.36 ([b40b863](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b40b8630c1a5ba7452d0461d38b1175fa647226d))
* **open-xchange:** Update Open-Xchange to v8.37 ([174c73c](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/174c73c012e911342644bdcb89d22b35be9baa36))
* **openproject:** Update to 15.5.1 ([e91efa8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e91efa8ecc1be9b444092e1a291747bb9f0c00ea))
* **openxchange:** Add proper dav URLs in client onboarding and disable unnecessary oauth section ([bba2af0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bba2af0f06942bd2063cc7b79f3e39fdb07838f0))
* **openxchange:** Disable redundant o-x-authentication-oauth package ([1d2b17b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1d2b17b4951581e1f60d8a7f2402512dc1c1c568))
* **openxchange:** Enable DAV support ([709e50f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/709e50ff7c020347dad953be7380d08438d3ab69))
### Features
* **collabora:** Update enterprise image to 24.04.13.4.1 ([b590810](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b5908100ddbd7497f7f858e874bcbf7979480d1b))
* **helmfile:** Define `global.additionalMailDomains` as list; if you use the setting already, check `migrations.md` for details ([4b30576](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4b305768c444c166e28829ee05631451ba997126))
* **helmfile:** Option to select default file format for weboffice using; see `functional.weboffice.defaultFormat` in `functional.yaml.gotmpl` for details ([5f58a85](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5f58a857acab38fa7f56e1e14ef0a6f805c7622e))
* **nubus:** Update nubus to v1.9.1 ([3d694a8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3d694a8248d5e983ab3e05753326088b375f2d82))
## [1.3.2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.1...v1.3.2) (2025-05-06)
### Bug Fixes
* **dovecot:** Update Helm chart to fix migration mode ([7ba84b9](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7ba84b99caf61e5a4a35b71d875e9ede0f71423e))
* **helmfile:** Explicitly template auth-modules in OX App Suite; Streamline name of OX App Suite EE image ([6cbb6b6](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6cbb6b6922864467ca365bcc9b1cfa49182df050))
## [1.3.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.3.0...v1.3.1) (2025-04-24)
### Bug Fixes
* **ci:** Update Helm to v3.17.3 ([9446faa](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9446faaa597777e9fb15d33953e02fdbfef646b2))
* **ci:** Update Helm to v3.17.3 ([d794a20](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/d794a2036ed6543bf89a0b661cc8a4c8a383a5f0))
* **docs:** Update "Ingress controller" section and add footnote on volume provisioner in `requirements.md` ([17efbd7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/17efbd79f177f635885735823696a6e50b919d3e))
* **helmfile:** Conditional templating of additional annotations in selected components to unblock openDesk deployment despite a bug in Helm 3.17 (https://github.com/helm/helm/issues/30587) ([861b84b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/861b84b14de9fb42c483f3ddb9e083305750d137))
* **postfix:** Disable unauthenticated relaying of mails in `postfix-ox` ([7414f05](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7414f05005e019f2121e8458fe63e795819fe92c))
# [1.3.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.2.1...v1.3.0) (2025-04-22)
### Bug Fixes
* **helmfile:** Fix Kyverno lint issues for EE components ([46b3834](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/46b38342d3cb6789e1734cd6eba412bc726c834b))
* **helmfile:** Remove no longer used `secrets.nubus.defaultAccounts.*` ([6e6d155](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6e6d15552e87a77870755db3b48f2af686916c1f))
* **helmfile:** Support for Keycloak session settings via `functional.authentication.realmSettings.*` ([3fcfa00](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3fcfa00503854f752a3885321b16b3f3597cb09a))
* **migrations:** Optional delete of `ums-minio-rewrites` Ingress, as it is non-existing in deployments with external object storage ([6932953](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/693295391bb02892b537a48513c9e0c2824ed466))
* **ox-connector:** Update to v0.19.0 ([fe664a7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/fe664a7f8d696fea53b6abadec5a0cb5db751f43))
* **xwiki:** Update Helm chart to v1.4.4 to fix the problem with XWiki not starting when secrets contained specific (XML interpreted) characters ([67a1df0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/67a1df0f80dc598287174a8dd6bda3f477227f0d))
### Features
* **collabora:** Update to 24.04.13 ([8f12208](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/8f12208074b2947ec65ebc3c21920d4f775e0c6e))
* **helmfile:** Add template support for annotations ([9cde57d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9cde57d74b8cfdd09e4f6b82cf45f1b1a686e035))
* **helmfile:** Support for SSO federation; see `ssoFederation` section in `functional.yaml.gotmpl` for details ([79975a5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/79975a58e3a4f50e59d1d790045c22a32ab49372))
* **nubus:** Show openDesk version to all users (instead of admin users only) ([393ee31](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/393ee311630630fd1aae8354ead90bcaaf5e4dba))
* **nubus:** Update to 1.8.0 ([90c49f6](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/90c49f6f83df0b34b86c17164eaa4e137d0cd9be))
* **openproject:** Update to 15.5.0 ([7f1cfc5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7f1cfc55551f608603e0401dfef24bbb9cc334e5))
## [1.2.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.2.0...v1.2.1) (2025-03-28) ## [1.2.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.2.0...v1.2.1) (2025-03-28)

View File

@@ -5,19 +5,19 @@ SPDX-License-Identifier: Apache-2.0
# Read me first # Read me first
Please read the [project's overall CONTRIBUTING.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md) first. Please read the [project's entire CONTRIBUTING.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md) first.
# How to contribute? # How to contribute?
Please also read the [project's workflow documentation](./docs/workflow.md) for more details on standards like commit Please also read the [project's workflow documentation](./docs/developer/workflow.md) for more details on standards like commit
messages and branching. messages and branching convention.
## Helm vs. Operators vs. Manifests ## Helm vs. Operators vs. Manifests
Due to DVS requirements: Due to DVS requirements:
- we have to use [Helm charts](https://helm.sh/) (that can consist of Manifests). - we have to use [Helm charts](https://helm.sh/) (that can consist of Manifests).
- we should avoid stand alone Manifests. - we should avoid stand-alone Manifests.
- we do not use Operators and CRDs. - we do not use Operators and CRDs.
In order to align the Helm files from various sources into the unified deployment of openDesk we make use of In order to align the Helm files from various sources into the unified deployment of openDesk we make use of
@@ -25,13 +25,12 @@ In order to align the Helm files from various sources into the unified deploymen
## Tooling ## Tooling
We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should New tools should not be introduced without first discussing it with the team. A proposal is fine, but let the team decide if the tool should
be used. be used or not.
We should avoid adding unnecessary complexity. We should avoid adding unnecessary complexity.
## In doubt? Ask! ## In doubt? Ask!
We are always happy about contributions, but also like to discuss technical approaches to solve a problem to ensure We are always happy to receive contributions, but we also like to discuss technical approaches in order to solve a problem. This helps to ensure
a contribution fits the openDesk platform strategy or clarify that specific topics might be must ahead on our own a contribution fits the openDesk platform strategy and roadmap, and potentially avoids otherwise wasted time. So when in doubt please [open an issue](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues/new) and start a discussion.
roadmap. So when in doubt please [open an issue](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues/new) and start a discussion.

170
LICENSES/CC-BY-SA-4.0.txt Normal file
View File

@@ -0,0 +1,170 @@
Creative Commons Attribution-ShareAlike 4.0 International
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensors permission is not necessary for any reasonfor example, because of any applicable exception or limitation to copyrightthen that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
Creative Commons Attribution-ShareAlike 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
Section 1 Definitions.
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
Section 2 Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
A. reproduce and Share the Licensed Material, in whole or in part; and
B. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
3. Term. The term of this Public License is specified in Section 6(a).
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
5. Downstream recipients.
A. Offer from the Licensor Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
B. Additional offer from the Licensor Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapters License You apply.
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public License.
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
Section 3 License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified form), You must:
A. retain the following if it is supplied by the Licensor with the Licensed Material:
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
1. The Adapters License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
Section 4 Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
Section 5 Disclaimer of Warranties and Limitation of Liability.
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
Section 6 Term and Termination.
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
Section 8 Interpretation.
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
Creative Commons may be contacted at creativecommons.org.

View File

@@ -6,40 +6,127 @@ SPDX-License-Identifier: Apache-2.0
<h1>openDesk Enterprise Edition</h1> <h1>openDesk Enterprise Edition</h1>
<!-- TOC --> <!-- TOC -->
* [Components](#components) * [Overview](#overview)
* [Enterprise Features](#enterprise-features)
* [CE vs. EE](#ce-vs-ee)
* [CE Components](#ce-components)
* [EE Components](#ee-components)
* [Collabora](#collabora)
* [Element](#element)
* [Nextcloud](#nextcloud)
* [Open-Xchange](#open-xchange)
* [OX App Suite](#ox-app-suite)
* [OX Dovecot](#ox-dovecot)
* [Enabling the Enterprise deployment](#enabling-the-enterprise-deployment) * [Enabling the Enterprise deployment](#enabling-the-enterprise-deployment)
* [Configuring the oD EE deployment for self-hosted installations](#configuring-the-od-ee-deployment-for-self-hosted-installations) * [Configuring the oD EE deployment for self-hosted installations](#configuring-the-od-ee-deployment-for-self-hosted-installations)
* [Registry access](#registry-access) * [Registry access](#registry-access)
* [License keys](#license-keys) * [License keys](#license-keys)
<!-- TOC --> <!-- TOC -->
openDesk Enterprise Edition is recommended for production use. It receives support and patches from ZenDiS and the suppliers of the components due to the included product subscriptions. # Overview
The document refers to openDesk Community Edition as "oD CE" and for the openDesk Enterprise Edition it is "oD EE". openDesk Enterprise Edition is recommended for production use. It receives support and patches from ZenDiS and the suppliers of the components due to the product subscriptions included.
Please contact [ZenDiS](mailto:opendesk@zendis.de) to get openDesk Enterprise, either as SaaS offering or for you on-premise installation. This document refers to the openDesk Community Edition as "oD CE" and the openDesk Enterprise Edition as "oD EE".
# Components Please contact [ZenDiS](mailto:opendesk@zendis.de) to get openDesk Enterprise, either as a SaaS offering or for your on-premises installation.
# Enterprise Features
oD EE ships the following features for Enterprise use that are not available in oD CE.
| Component | Enterprise-only Features |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Collabora** | Branding |
| | [Automatic load scaling](https://www.collaboraonline.com/collabora-online-controller/) |
| **Element** | [AdminBot](https://ems-docs.element.io/books/element-cloud-documentation/page/admin-bot) |
| | [GroupSync](https://ems-docs.element.io/books/element-server-suite-classic-documentation-lts-2504/page/setting-up-group-sync-with-the-installer#bkmrk-what-is-group-sync?) |
| | [Admin Console](https://ems-docs.element.io/books/element-server-suite-classic-documentation-lts-2504/page/using-the-admin-console) |
| **Nextcloud** | Enterprise security patches |
| | [Guard app](https://nextcloud.com/features/#guard) |
| **OpenXchange** | S3 storage |
| | Central orchestration of cluster topology, health checks, and configuration |
| | Advanced Full-Text Search (FTS) functionality for mailboxes |
| **OpenProject**. | [Enterprise addons](https://www.openproject.org/docs/enterprise-guide/) (*Corporate Plan*) |
| **XWiki** | [XWiki Pro apps](https://xwiki.com/en/offerings/products/xwiki-pro) |
# CE vs. EE
The following table summarizes the differences between oD CE and oD EE.
| Aspect | Community Edition (CE) | Enterprise Edition (EE) |
| -------------------------------- | --------------------------------------- | -------------------------------------------------------------------------- |
| **Licensing of core components** | OSS (Apache2.0 / GPL, etc.) | Same OSS licenses |
| **Closedsource modules** | None | Collabora (branding), Element (admin tools), Nextcloud (guard app), OX Pro, Dovecot Pro |
| **Technical enablement** | Fully public images/charts via openCode | EEonly registry, license file (`enterprise.yaml`) |
| **Support & updates** | Community via openCode, no SLA | SLAbacked support, patches, 2nd/3rd level |
| **Access to source code** | All CE code on openCode | Proprietary modules NOT on openCode |
## CE Components
The following components are using the same codebase and artifacts for their Community and Enterprise offering:
The following components using the same codebase and artifacts for their Enterprise and Community offering:
- Cryptpad - Cryptpad
- Jitsi - Jitsi
- Notes
- Nubus - Nubus
- OpenProject - OpenProject
- XWiki - XWiki
The following components have - at least partially - Enterprise specific artifacts: ## EE Components
- Collabora: Collabora Online image version `<major>.<minor>.<patch>.3` will be used once available, at the same time the Collabora Development Edition image will be updated to `<major>.<minor>.<patch>.2` for oD CE. This section provides information about the components that have - at least partially - Enterprise-specific artifacts.
- Element: Some artifacts providing additional functionality are only available in oD EE. For the shared artifacts we keep the ones in oD CE and oD EE in sync.
- Nextcloud: Specific enterprise image based on the NC Enterprise package is build based on the same release version as used in oD CE.
- OX AppSuite: oD CE and EE are using the same release version, in EE an enterprise-built container of the AppSuite's Core-Middleware is being integrated.
- OX Dovecot Pro 3: Dovecot Pro provides support for S3 storage and this feature is used by default.
If you want to check in detail which artifacts are specific to openDesk Enterprise and thereby may contain non open source code, please check the `repository:` If you want to check in detail which artifacts are specific to openDesk Enterprise and thereby may contain proprietary code, please check the `repository:`
values in the image ([1](./helmfile/environments/default/images.yaml.gotmpl) / [2](./helmfile/environments/default-enterprise-overrides/images.yaml.gotmpl)) values in the image ([1](./helmfile/environments/default/images.yaml.gotmpl) / [2](./helmfile/environments/default-enterprise-overrides/images.yaml.gotmpl))
and chart ([1](./helmfile/environments/default/charts.yaml.gotmpl) / [2](./helmfile/environments/default-enterprise-overrides/charts.yaml.gotmpl)) definitions. and chart ([1](./helmfile/environments/default/charts.yaml.gotmpl) / [2](./helmfile/environments/default-enterprise-overrides/charts.yaml.gotmpl)) definitions.
When a repository path starts with `/zendis` the artifact is only available in an openDesk Enterprise deployment. When a repository path starts with `/zendis`, the artifact is only available in an openDesk Enterprise deployment.
### Collabora
- Collabora Online (COOL) container image: Is build from the same public source code as Collabora Development Edition (CODE), only the build configurations might differ. COOL includes a brand package that is not public and its license is not open source.
- COOL Controller container image and Helm chart: Source code and chart are using Mozilla Public License Version 2.0, but the source code is not public. It is provided to customers upon request.
openDesk updates Collabora once a COOL image based on the version pattern `<major>.<minor>.<patch>.3+.<build>` was made available. This happens usually at the same time the CODE image with `<major>.<minor>.<patch>.2+.<build>` is made available.
### Element
- AdminBot and GroupSync container image: 100% closed source
- Admin Console container image: 100% closed source, though ~65% of the total runtime code is from the [matrix-bot-sdk](https://github.com/turt2live/matrix-bot-sdk/)
### Nextcloud
- Nextcloud Enterprise: openDesk uses the Nextcloud Enterprise to the build Nextcloud container image for oD EE. The Nextcloud EE codebase might contain EE exclusive (longterm support) security patches, plus the Guard app, that is not publicly available, while it is AGPL-3.0 licensed.
openDesk updates the Nextcloud images for openDesk CE and EE in parallel, therefore we will not upgrade to a new major Nextcloud release before the related Nextcloud Enterprise release is available. When patches are released exclusively for Nextcloud Enterprise, they are made available also exclusively in oD EE.
### Open-Xchange
#### OX App Suite
- OX App Suite Core Middleware container image: The amount of code, that is not open source and has a proprietary license, is <10%.
- OX App Suite Pro Helm chart: It is not publicly available, though it is "just" an umbrella chart re-using the publicly available charts referencing the EE images, so it has <10% prorietary content.
openDesk updates OX App Suite in oD CE and EE always to the same release version. Only the App Suíte Pro Helm chart has the same versioning as the actual App Suite release, the chart used in oD CE has a different versioning scheme.
#### OX Dovecot
- Dovecot Pro container image: Dovecot Pro is based on the open source components Dovecot and Pigeonhole but extended by modules providing additional functionality like obox2, cluster, cluster controller and dovecot fts. The additional modules make up about 15% of the overall Dovecot Pro code and are subject to a closed source license.
openDesk aims to keep Dovecot's shared codebases in sync between oD CE and EE, though the versioning between the releases differs (CE: 2.x, EE: 3.y).
Dovecot Pro requires two additional environment variables:
- `DOVECOT_CRYPT_PRIVATE_KEY`
- `DOVECOT_CRYPT_PUBLIC_KEY`
These variables must contain the base64 encoded strings of the private and public
key. These keys can be generated with the following commands:
- Private Key: `openssl genpkey -algorithm X25519 -out private.pem && cat private.pem | base64 -w0`
- Public Key: `openssl pkey -in private.pem -out public.pem -pubout && cat public.pem | base64 -w0`
# Enabling the Enterprise deployment # Enabling the Enterprise deployment
@@ -59,7 +146,7 @@ OPENDESK_ENTERPRISE=true
With openDesk EE you get access to the related artifact registry owned by ZenDiS. With openDesk EE you get access to the related artifact registry owned by ZenDiS.
Three steps are required to access the registry - for step #1 and #2 you can set some variables. You can to define a `<your_name_for_the_secret>` freely, like `enterprise-secret`, as long as it consistent in step #1 and #3. Three steps are required to access the registry - for step 1 and 2 you can set some variables. Below, you can define `<your_name_for_the_secret>` freely, like `enterprise-secret`, as long as it consistent in step 1 and 3.
```shell ```shell
NAMESPACE=<your_namespace> NAMESPACE=<your_namespace>
@@ -68,7 +155,7 @@ YOUR_ENTERPRISE_REGISTRY_USERNAME=<your_registry_credential_username>
YOUR_ENTERPRISE_REGISTRY_PASSWORD=<your_registry_credential_password> YOUR_ENTERPRISE_REGISTRY_PASSWORD=<your_registry_credential_password>
``` ```
1. Add your registry credentials as secret to the namespace you want to deploy openDesk to. Do not forget to create the namespace if it does not exist yet (`kubectl create namespace ${NAMESPACE}`). 1. Add your registry credentials as a secret to the namespace you want to deploy openDesk to. Do not forget to create the namespace if it does not exist yet (`kubectl create namespace ${NAMESPACE}`).
```shell ```shell
kubectl create secret --namespace "${NAMESPACE}" \ kubectl create secret --namespace "${NAMESPACE}" \
@@ -100,7 +187,7 @@ repositories:
## License keys ## License keys
Some applications require license information for their Enterprise features to be enabled. With the aforementioned registry credentials you will also receive a file called `enterprise.yaml` containing the relevant license keys. Some applications require license information for their Enterprise features to be enabled. With the aforementioned registry credentials you will also receive a file called [`enterprise.yaml`](./helmfile/environments/default/enterprise_keys.yaml.gotmpl) containing the relevant license keys.
Please place the file next your other `.yaml.gotmpl` file(s) that configure your deployment. Please place the file next your other `.yaml.gotmpl` file(s) that configure your deployment.
@@ -108,4 +195,4 @@ Details regarding the scope/limitation of the component's licenses:
- Nextcloud: Enterprise license to enable [Nextcloud Enterprise](https://nextcloud.com/de/enterprise/) specific features, can be used across multiple installations until the licensed number of users is reached. - Nextcloud: Enterprise license to enable [Nextcloud Enterprise](https://nextcloud.com/de/enterprise/) specific features, can be used across multiple installations until the licensed number of users is reached.
- OpenProject: Domain specific enterprise license to enable [OpenProject's Enterprise feature set](https://www.openproject.org/enterprise-edition/), domain matching can use regular expressions. - OpenProject: Domain specific enterprise license to enable [OpenProject's Enterprise feature set](https://www.openproject.org/enterprise-edition/), domain matching can use regular expressions.
- XWiki: Deployment specific enterprise license (key pair) to activate the [XWiki Pro](https://xwiki.com/en/offerings/products/xwiki-pro) apps. - XWiki: Deployment specific enterprise license (key pair) to activate the [XWiki Pro](https://xwiki.com/en/offerings/products/xwiki-pro) apps. *Caution! XWiki needs these license keys as one-line strings. Multi-line strings result in installation failure*

View File

@@ -16,7 +16,7 @@ SPDX-License-Identifier: Apache-2.0
* [Testing](#testing) * [Testing](#testing)
* [Permissions](#permissions) * [Permissions](#permissions)
* [Releases](#releases) * [Releases](#releases)
* [Data Storage](#data-storage) * [Data storage](#data-storage)
* [Feedback](#feedback) * [Feedback](#feedback)
* [Development](#development) * [Development](#development)
* [License](#license) * [License](#license)
@@ -25,27 +25,27 @@ SPDX-License-Identifier: Apache-2.0
# Overview # Overview
openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the openDesk is a Kubernetes-based, open-source and cloud-native digital workplace suite provided by the
*Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH*. *Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH*.
For production use the [openDesk Enterprise Edition](./README-EE.md) is required. For production use, the [openDesk Enterprise Edition](./README-EE.md) is recommended.
openDesk currently features the following functional main components: openDesk currently features the following functional main components:
| Function | Functional Component | Component<br/>Version | Upstream Documentation | | Function | Functional component | License | Component<br/>version | Upstream documentation |
|----------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| |----------------------|-----------------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Chat & collaboration | Element ft. Nordeck widgets | [1.11.89](https://github.com/element-hq/element-desktop/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) | | Chat & collaboration | Element ft. Nordeck widgets | AGPL-3.0-or-later (Element Web), AGPL-3.0-only (Synapse), Apache-2.0 (Nordeck widgets) | [1.11.89](https://github.com/element-hq/element-web/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) |
| Collaborative notes | Notes (aka Docs) | [2.4.0](https://github.com/suitenumerique/docs/releases/tag/v2.4.0) | Online documentation/welcome document available in installed application | | Collaborative notes | Notes (aka Docs) | MIT | [3.2.1](https://github.com/suitenumerique/docs/releases/tag/v3.2.1) | Online documentation/welcome document available in installed application |
| Diagram editor | CryptPad ft. diagrams.net | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) | | Diagram editor | CryptPad ft. diagrams.net | AGPL-3.0-only | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) |
| File management | Nextcloud | [30.0.6](https://nextcloud.com/de/changelog/#30-0-6) | [Nextcloud 30](https://docs.nextcloud.com/) | | File management | Nextcloud | AGPL-3.0-or-later | [31.0.7](https://nextcloud.com/de/changelog/#31-0-7) | [Nextcloud 31](https://docs.nextcloud.com/) |
| Groupware | OX App Suite | [8.35](https://documentation.open-xchange.com/appsuite/releases/8.35/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) | | Groupware | OX App Suite | GPL-2.0-only (backend), AGPL-3.0-or-later (frontend) | [8.40](https://documentation.open-xchange.com/appsuite/releases/8.40/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) |
| Knowledge management | XWiki | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) | | Knowledge management | XWiki | LGPL-2.1-or-later | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) |
| Portal & IAM | Nubus | [1.7.0](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html#version-1-7-0-2025-02-23) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) | | Portal & IAM | Nubus | AGPL-3.0-or-later | [1.12.0](https://docs.software-univention.de/nubus-kubernetes-release-notes/1.x/en/1.12.html#version-1-12-0-2025-07-31) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) |
| Project management | OpenProject | [15.4.2](https://www.openproject.org/docs/release-notes/15-4-2/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) | | Project management | OpenProject | GPL-3.0-only | [16.3.2](https://www.openproject.org/docs/release-notes/16-3-2/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) |
| Videoconferencing | Jitsi | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) | | Videoconferencing | Jitsi | Apache-2.0 | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) |
| Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) | | Weboffice | Collabora | MPL-2.0 | [25.04.4](https://www.collaboraoffice.com/code-25-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) |
While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to While not all components are perfectly designed for the execution inside containers, one of the project's objectives is to
align the applications with best practices regarding container design and operations. align the applications with best practices regarding container design and operations.
This documentation aims to give you all that is needed to set up your own instance of the openDesk. This documentation aims to give you all that is needed to set up your own instance of the openDesk.
@@ -81,22 +81,24 @@ You would like to install openDesk in your own infrastructure?
# Architecture # Architecture
More information on openDesk's architecture can be found in our [architecture docs](./docs/architecture.md). More information on openDesk's architecture can be found in our [architecture documentation](./docs/architecture.md).
# Testing # Testing
openDesk is continously tested to ensure a high quality. Read how we test in openDesk in our [test concept](./docs/testing.md). openDesk is continuously tested to ensure it meets high quality standards. Read how we test in openDesk in our [testing concept](./docs/testing.md).
# Permissions # Permissions
Find out more about the permission system in the[roles & permissions concept](./docs/permissions.md) Find out more about the permission system in the [roles & permissions concept](./docs/permissions.md)
# Releases # Releases
All technical releases are created using [Semantic Versioning](https://semver.org/lang/de/). openDesk implements a defined [release and patch management process](./docs/releases.md) to ensure stability and security.
All technical releases are created using [Semantic Versioning](https://semver.org/).
Gitlab provides an Gitlab provides an
[overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) [overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/releases)
of this project. of this project.
Please find a list of the artifacts related to the release either in the source code archive attached to the release or Please find a list of the artifacts related to the release either in the source code archive attached to the release or
@@ -104,9 +106,9 @@ in the files from the release's git-tag:
- `./helmfile/environments/default/images.yaml.gotmpl` - `./helmfile/environments/default/images.yaml.gotmpl`
- `./helmfile/environments/default/charts.yaml.gotmpl` - `./helmfile/environments/default/charts.yaml.gotmpl`
Find more information in our [Workflow documentation](./docs/workflow.md). Find more information in our [Workflow documentation](./docs/developer/workflow.md).
# Data Storage # Data storage
More information about different data storages used within openDesk are described in the More information about different data storages used within openDesk are described in the
[Data Storage documentation](./docs/data-storage.md). [Data Storage documentation](./docs/data-storage.md).
@@ -115,15 +117,15 @@ More information about different data storages used within openDesk are describe
We love to get feedback from you! We love to get feedback from you!
Related to the deployment / contents of this repository, For feedback related to the deployment / contents of this repository,
please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues). please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues).
If you want to address other topics, please check the section If you want to address other topics, please check the section
["Rückmeldungen und Beteiligung" in the OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung) of the [openDesk Info Repository](https://gitlab.opencode.de/bmi/opendesk/info). ["Rückmeldungen und Beteiligung" in the OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung) of the [openDesk Info Repository](https://gitlab.opencode.de/bmi/opendesk/info).
# Development # Development
If you want to join or contribute to the development of openDesk please read the [Development guide](./docs/development.md). If you want to join or contribute to the development of openDesk please read the [Development guide](./docs/developer/development.md).
# License # License

View File

@@ -24,6 +24,16 @@ SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentl
SPDX-License-Identifier = "Apache-2.0" SPDX-License-Identifier = "Apache-2.0"
[[annotations]] [[annotations]]
path = "helmfile/files/portal-tiles/*" path = ".opencode/openDesk-logo-rgb-color.svg"
SPDX-FileCopyrightText = "2024 Google LLC" SPDX-FileCopyrightText = "2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
SPDX-License-Identifier = "CC-BY-SA-4.0"
[[annotations]]
path = ".opencode/screenshots/*"
SPDX-FileCopyrightText = "2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
SPDX-License-Identifier = "CC-BY-SA-4.0"
[[annotations]]
path = ".gitlab/merge_request_templates/*.md"
SPDX-FileCopyrightText = "2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
SPDX-License-Identifier = "Apache-2.0" SPDX-License-Identifier = "Apache-2.0"

View File

@@ -129,7 +129,7 @@ def grep_yaml(file):
with open(file, 'r') as file: with open(file, 'r') as file:
content = '' content = ''
for line in file.readlines(): for line in file.readlines():
if not ': {{' in line and not '- {{' in line: if not '{{' in line:
content += line content += line
return yaml.safe_load(content) return yaml.safe_load(content)

View File

@@ -15,27 +15,27 @@ SPDX-License-Identifier: Apache-2.0
* [Keycloak Extensions](#keycloak-extensions) * [Keycloak Extensions](#keycloak-extensions)
* [OpenLDAP](#openldap) * [OpenLDAP](#openldap)
* [Authorization](#authorization) * [Authorization](#authorization)
* [LDAP Group Synchronization](#ldap-group-synchronization) * [LDAP group synchronization](#ldap-group-synchronization)
* [Provisioning](#provisioning) * [Provisioning](#provisioning)
* [OX Connector](#ox-connector) * [OX Connector](#ox-connector)
* [SCIM](#scim) * [SCIM](#scim)
* [Component integration](#component-integration) * [Component integration](#component-integration)
* [Intercom Service / Silent Login](#intercom-service--silent-login) * [Intercom Service / Silent login](#intercom-service--silent-login)
* [Central Contacts](#central-contacts) * [Central contacts](#central-contacts)
* [Central Navigation](#central-navigation) * [Central navigation](#central-navigation)
* [Filepicker](#filepicker) * [Filepicker](#filepicker)
* [Newsfeed](#newsfeed) * [Newsfeed](#newsfeed)
* [(OpenProject) File Store](#openproject-file-store) * [(OpenProject) File store](#openproject-file-store)
* [Applications vs. Services](#applications-vs-services) * [Applications vs. services](#applications-vs-services)
* [Collabora (Office)](#collabora-office) * [Collabora (weboffice)](#collabora-weboffice)
* [CryptPad Online (Diagrams)](#cryptpad-online-diagrams) * [CryptPad Online (diagrams)](#cryptpad-online-diagrams)
* [Element/Synapse (Chat \& Call)](#elementsynapse-chat--call) * [Element/Synapse (chat \& call)](#elementsynapse-chat--call)
* [Jitsi (Video Conferencing)](#jitsi-video-conferencing) * [Jitsi (video conferencing)](#jitsi-video-conferencing)
* [Nextcloud (Files)](#nextcloud-files) * [Nextcloud (files)](#nextcloud-files)
* [Nubus (Identity and Access Management / Portal)](#nubus-identity-and-access-management--portal) * [Nubus (identity and access management / portal)](#nubus-identity-and-access-management--portal)
* [OpenProject (Project management)](#openproject-project-management) * [OpenProject (project management)](#openproject-project-management)
* [OX App Suite (Groupware) with OX Dovecot (Mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend) * [OX App Suite (groupware) with OX Dovecot (mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend)
* [XWiki (Knowledge management)](#xwiki-knowledge-management) * [XWiki (knowledge management)](#xwiki-knowledge-management)
* [Application specific user accounts](#application-specific-user-accounts) * [Application specific user accounts](#application-specific-user-accounts)
* [Footnotes](#footnotes) * [Footnotes](#footnotes)
<!-- TOC --> <!-- TOC -->
@@ -44,7 +44,7 @@ openDesk is designed as a [Kubernetes](https://kubernetes.io) deployment.
It consists of a set of [Helm charts](https://helm.sh/) orchestrated by [Helmfile](https://github.com/helmfile/helmfile). It consists of a set of [Helm charts](https://helm.sh/) orchestrated by [Helmfile](https://github.com/helmfile/helmfile).
openDesk includes the functional applications, like file management, chat, and email. Other services such openDesk includes functional applications, like file management, chat, and email. Other services such
as databases and object storage are included for evaluation purposes only. In production, you must provide as databases and object storage are included for evaluation purposes only. In production, you must provide
these services yourself. these services yourself.
@@ -73,12 +73,12 @@ flowchart TD
openDesk includes a portal that allows navigation to the respective application. The portal is part of the openDesk includes a portal that allows navigation to the respective application. The portal is part of the
Identity and Access Management (IAM) application shipped with openDesk: *Nubus*. Nubus includes OpenLDAP Identity and Access Management (IAM) application shipped with openDesk: *Nubus*. Nubus includes OpenLDAP
for storing users, groups, and permissions, and Keycloak for single sign-on with LDAP user federation for storing users, groups, and permissions, and Keycloak for single sign-on with LDAP user federation
configured to the aforementioned OpenLDAP. configured to use the aforementioned OpenLDAP.
When the user is authenticated by Keycloak, the portal shows the applications the user is permitted to access. When the user is authenticated by Keycloak, the portal shows the applications the user is permitted to access.
The user can now access applications and use the corresponding functionality without the need to authenticate to The user can now access applications and use the corresponding functionality without the need to authenticate
applications again. This is implemented using the OpenID Connect (OIDC) protocol. again. This is implemented using the OpenID Connect (OIDC) protocol.
# Nubus (IAM) # Nubus (IAM)
@@ -111,11 +111,11 @@ In openDesk, Nubus serves the following purposes:
6. Frontend Integration Authentication 6. Frontend Integration Authentication
A specialized component - the Intercom Service - acts according to the Backend-for-Frontend pattern when it comes to certain integration use cases requiring the frontend of one application to call the API of another service that also has the need for user authentication. See [Component integration](#component-integration) for more details. A specialized component - the Intercom Service - acts according to the Backend-for-Frontend pattern when it comes to certain integration use cases, for example, ones that require the frontend of one application to call the API of another service, that also has the need for user authentication. See [Component integration](#component-integration) for more details.
7. Portal 7. Portal
Nubus provides a Portal component for users to access the connected applications, that also includes a self service e.g. for password reset. Nubus provides a Portal component for users to access the connected applications. This component also includes self-service possibilities e.g. for password resetting.
For additional information, refer to the [Nubus for Kubernetes Architecture Manual](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/index.html). For additional information, refer to the [Nubus for Kubernetes Architecture Manual](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/index.html).
@@ -197,38 +197,38 @@ For more information, see the [Keycloak Documentation](https://www.keycloak.org/
## Keycloak Extensions ## Keycloak Extensions
Part of Nubus are the [Keycloak Extensions](https://docs.software-univention.de/nubus-kubernetes-operation/1.0/en/configuration/keycloak-extensions.html) used for Part of Nubus are the [Keycloak Extensions](https://docs.software-univention.de/nubus-kubernetes-operation/1.0/en/configuration/keycloak-extensions.html) which are used for:
- Login brute force protection: Blocking authentication requests upon too much failed attempts from a device or IP. The available [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) option is deactivated in openDesk. - Login brute force protection: Blocking authentication requests upon too many failed attempts from a device or IP. _The available [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) option is deactivated in openDesk._
- New device notification: Sending the use an email after successful login from a new device. - New device notification: Sending the user an email after successful login from a new device.
To address these use cases the Keycloak Extensions act as a proxy to Keycloak. To address these use cases, the Keycloak Extensions act as a proxy to Keycloak.
## OpenLDAP ## OpenLDAP
[OpenLDAP](https://www.openldap.org) is an open-source implementation of the Lightweight Directory Access Protocol (LDAP) that provides a central repository for user and group information. In openDesk, OpenLDAP is used as the user directory to store user and group data and manage access control policies across the applications. [OpenLDAP](https://www.openldap.org) is an open-source implementation of the Lightweight Directory Access Protocol (LDAP) that provides a central repository for user and group information. In openDesk, OpenLDAP is used as the user directory to store user and group data, and also manages access control policies across the applications.
# Authorization # Authorization
## LDAP Group Synchronization ## LDAP group synchronization
LDAP group synchronization ensures that user group memberships are consistent across the applications in openDesk that make use of the IAM group information. Nubus uses OpenLDAP to store and manage user groups, which are synchronized with integrated applications to enforce access control policies. LDAP group synchronization ensures that user group memberships are consistent across the applications in openDesk that make use of the IAM group information. Nubus uses OpenLDAP to store and manage user groups, which are synchronized with integrated applications to enforce access control policies.
Beside Keycloak LDAP groups are available to the following applications, none of the application supports nested groups. It means that users must be direct members of a group, as members of sub groups are ignored. Keycloak LDAP groups are available to the following applications, however, none of the applications support nested groups. This means that users must be direct members of a group, as members of subgroups will be ignored.
- Files / Nextcloud: Reads all groups that are enabled for Nextcloud twice a day based on the setting `background_sync_interval` in the `user_ldap` app. - Files / Nextcloud: Reads all groups that are enabled for Nextcloud, twice a day. Determined by the setting `background_sync_interval` in the `user_ldap` app.
- Knowledge Management / XWiki: Reads all groups that are enabled for XWiki use, this is done nightly based the jobs `LDAP Group Import Job` and `Mapped groups daily updater` that admin users can access in `/bin/view/Scheduler`. - Knowledge Management / XWiki: Reads all groups that are enabled for XWiki use, once daily during the night. Based on the jobs `LDAP Group Import Job` and `Mapped groups daily updater` that are accessible to admin users in `/bin/view/Scheduler`.
- Project Management / OpenProject: Reads all groups that are enabled for OpenProject [hourly](https://www.openproject.org/docs/system-admin-guide/authentication/ldap-connections/ldap-group-synchronization/#create-a-synchronized-group). - Project Management / OpenProject: Reads all groups that are enabled for OpenProject, [hourly](https://www.openproject.org/docs/system-admin-guide/authentication/ldap-connections/ldap-group-synchronization/#create-a-synchronized-group).
- Webmail / OX AppSuite: Requires a webmail user to be part of a group before the group is actively provisioned to OX AppSuite. - Webmail / OX AppSuite: Requires a webmail user to be a part of a group before the group is actively provisioned to OX AppSuite.
# Provisioning # Provisioning
Part of the already mentioned Nubus IAM is a [provisioning service](https://docs.software-univention.de/nubus-kubernetes-architecture/0.5/en/components/provisioning-service.html). Part of the already mentioned Nubus IAM is a [provisioning service](https://docs.software-univention.de/nubus-kubernetes-architecture/0.5/en/components/provisioning-service.html).
Beside the Nubus internal user of the provisioning service the OX AppSuite is currently the only openDesk application that is getting data actively provisioned in contrast to scenarios where applications fetch the required information from the LDAP. Besides the Nubus internal user of the provisioning service, the OX AppSuite is currently the only openDesk application that is getting data actively provisioned to it. This is in contrast to the norm, where applications fetch the required information from the LDAP themselves.
## OX Connector ## OX Connector
As the OX AppSuite is using an application specific format to get e.g. users provisioned, there is also a specific connector component that links to provisioning service to the OX AppSuite, it is called the [OX Connector](https://docs.software-univention.de/manual/5.0/de/mail/ox-connector.html). As the OX AppSuite is using an application specific format to get e.g. users provisioned, there is also a specific connector component that links the provisioning service to the OX AppSuite, it is called the [OX Connector](https://docs.software-univention.de/manual/5.0/de/mail/ox-connector.html).
The [OX SOAP API](https://oxpedia.org/wiki/index.php?title=Open-Xchange_Provisioning_using_SOAP) is used by the OX Connector to synchronize information about the follow OX AppSuite objects: The [OX SOAP API](https://oxpedia.org/wiki/index.php?title=Open-Xchange_Provisioning_using_SOAP) is used by the OX Connector to synchronize information about the follow OX AppSuite objects:
- Contexts - Contexts
@@ -237,20 +237,20 @@ The [OX SOAP API](https://oxpedia.org/wiki/index.php?title=Open-Xchange_Provisio
- (Managed) Resources - (Managed) Resources
- Users - Users
To find out more, see [Roles & Permissions](permissions.md). To find out more, see [Roles & Permissions](./docs/permissions.md).
## SCIM ## SCIM
[System for Cross-domain Identity Management](https://scim.cloud) (SCIM) is an open standard for automating the exchange of user identity information between identity domains or IT systems. SCIM is designed to make user provisioning and management easier by providing a standardized way to manage user identities in cloud-based applications and services. [System for Cross-domain Identity Management](https://scim.cloud) (SCIM) is an open standard for automating the exchange of user identity information between identity domains or IT systems. SCIM is designed to make user provisioning and management easier by providing a standardized way to manage user identities in cloud-based applications and services.
In openDesk, SCIM will be used in the future to automate the process of creating, updating, and deactivating user accounts across the applications. This ensures that user data is consistent and up-to-date across all applications, reducing the administrative overhead and potential for errors. In openDesk, SCIM will be used in the future to automate the process of creating, updating, and deactivating user accounts across the applications. This ensures that user data is consistent across all applications, reducing the administrative overhead and potential for errors.
> **Note:**<br> > **Note:**<br>
> SCIM support is planned in openDesk for 2025. > SCIM support is planned in openDesk for 2025.
# Component integration # Component integration
Important, especially from the end user perspective are the functional integrations between the different openDesk applications. Important, especially from the end user perspective, are the functional integrations between the different openDesk applications.
```mermaid ```mermaid
flowchart TD flowchart TD
@@ -273,22 +273,22 @@ flowchart TD
Details can be found in the upstream documentation that is linked in the respective sections. Details can be found in the upstream documentation that is linked in the respective sections.
## Intercom Service / Silent Login ## Intercom Service / Silent login
The Intercom Service is deployed in the context of Nubus. Its role is to enable cross-application integration The Intercom Service is deployed in the context of Nubus. Its role is to enable cross-application integration
based on the user's browser interaction as handling authentication when the frontend of an application has to call based on the user's browser interaction, as handling authentication when the frontend of an application has to call
the API from another application is often a challenge. the API from another application is often challenging.
To establish a session with the Intercom Service, applications can use the silent login feature within an iframe. To establish a session with the Intercom Service, applications can use the silent login feature within an iframe.
Currently, only OX AppSuite and Element are using the frontend-based integration. Currently, only OX AppSuite and Element are using the frontend-based integration.
**Links** **Links:**
- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html). - [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
## Central Contacts ## Central contacts
OX App Suite is managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to OX App Suite is responsible for managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to
- create a new contact in the user's contacts folder when a file is shared with an unknown email address. - create a new contact in the user's contacts folder when a file is shared with an unknown email address.
- retrieve contacts from the user's contacts folder to support search-as-you-type when starting to share a file. - retrieve contacts from the user's contacts folder to support search-as-you-type when starting to share a file.
@@ -296,13 +296,13 @@ OX App Suite is managing contacts in openDesk. Therefore, Nextcloud's PHP backen
- Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts). - Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts).
- New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to. - New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to.
## Central Navigation ## Central navigation
Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for
a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation. a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation.
The API can be called by The API can be called by
- frontend services through the Intercom Service's `/navigation.json` endpoint or - frontend services through the Intercom Service's `/navigation.json` endpoint.
- backend services directly at the portal's `/univention/portal/navigation.json` endpoint. - backend services directly at the portal's `/univention/portal/navigation.json` endpoint.
The central navigation expects the API caller to present a shared secret for authentication and the username for whom the portal The central navigation expects the API caller to present a shared secret for authentication and the username for whom the portal
@@ -316,7 +316,7 @@ curl 'https://portal.<DOMAIN>/univention/portal/navigation.json?base=https%3A//p
## Filepicker ## Filepicker
The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the following use cases against the respective openDesk instance's Nextcloud: The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the following use cases within the respective openDesk instance's Nextcloud:
- Attach files from Nextcloud to emails. - Attach files from Nextcloud to emails.
- Create and add links to Nextcloud files into emails. - Create and add links to Nextcloud files into emails.
- Save attachments from emails into Nextcloud. - Save attachments from emails into Nextcloud.
@@ -324,10 +324,10 @@ The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the foll
The Filepicker uses frontend and backend-based integration: The Filepicker uses frontend and backend-based integration:
- For frontend-based integration, the OX AppSuite frontend uses the Intercom Service. - For frontend-based integration, the OX AppSuite frontend uses the Intercom Service.
- Backend-based integration is coming from OX AppSuite middleware. The middleware communicates directly with Nextcloud - Backend-based integration is coming from the OX AppSuite middleware. The middleware communicates directly with Nextcloud
when adding a file to an email or storing a file into Nextcloud to avoid passing these files through the user's browser. when attaching a file to an email or storing a file in Nextcloud to avoid passing these files through the user's browser.
**Links** **Links:**
- [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation). - [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation).
## Newsfeed ## Newsfeed
@@ -338,7 +338,7 @@ service through the Intercom Service's `/wiki` endpoint, in combination with the
**Links:** **Links:**
- [XWiki Blog feature](https://extensions.xwiki.org/xwiki/bin/view/Extension/Blog%20Application) - [XWiki Blog feature](https://extensions.xwiki.org/xwiki/bin/view/Extension/Blog%20Application)
## (OpenProject) File Store ## (OpenProject) File store
While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are
stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package. stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package.
@@ -351,7 +351,7 @@ The file store must still be enabled per project in OpenProject's project admin
- [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/) - [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/)
- [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject) - [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject)
# Applications vs. Services # Applications vs. services
openDesk consists of a variety of open-source projects, please find an overview below: openDesk consists of a variety of open-source projects, please find an overview below:
@@ -366,42 +366,42 @@ openDesk consists of a variety of open-source projects, please find an overview
| Element | Secure communications platform | Application | | Element | Secure communications platform | Application |
| Jitsi | Videoconferencing | Application | | Jitsi | Videoconferencing | Application |
| MariaDB | Database | Service | | MariaDB | Database | Service |
| Memcached | Cache Database | Service | | Memcached | Cache database | Service |
| MinIO | Object Storage | Service | | MinIO | Object storage | Service |
| Nextcloud | File share | Application | | Nextcloud | File share | Application |
| Nubus (UMS) | Identity Management & Portal | Application | | Nubus (UMS) | Identity management & portal | Application |
| OpenProject | Project management | Application | | OpenProject | Project management | Application |
| OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application | | OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application |
| Postfix | MTA | Service | | Postfix | MTA | Service |
| PostgreSQL | Database | Service | | PostgreSQL | Database | Service |
| Redis | Cache Database | Service | | Redis | Cache database | Service |
| XWiki | Knowledge Management | Application | | XWiki | Knowledge management | Application |
The end user focussed components are called applications and provide the functional scope of openDesk, please find separate paragraphs on each of the applications below. The end user focussed components are called applications and provide the functional scope of openDesk, please find separate paragraphs on each of the applications below.
Other components are of type "Service", these are used for development and evaluation purposes only, they need to be replaced in production deployments. Other components are of type "Service", these are used for development and evaluation purposes only, they need to be replaced in production deployments.
For the APIs / Protocols supported by the applications, please read the [apis.md](./architecture/apis.md). For the APIs / Protocols supported by the applications, please read the [apis.md](./docs/architecture/apis.md).
## Collabora (Office) ## Collabora (weboffice)
[Collabora](https://www.collaboraonline.com) is a powerful online document editing suite. [Collabora](https://www.collaboraonline.com) is a powerful online document editing suite.
In openDesk, Collabora is used for editing Office documents such as rich texts, spreadsheets and presentations. In openDesk, Collabora is used for editing Office documents such as rich texts, spreadsheets and presentations.
## CryptPad Online (Diagrams) ## CryptPad Online (diagrams)
[CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption.. [CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption.
In openDesk, CryptPad is for editing diagrams.net documents. In openDesk, CryptPad is for editing diagrams.net documents.
## Element/Synapse (Chat & Call) ## Element/Synapse (chat & call)
[Element Web](https://github.com/element-hq/element-web) is the web frontend for [Synapse](https://github.com/element-hq/synapse), the reference implementation of the sovereign and secure [Matrix protocol](https://matrix.org). [Element Web](https://github.com/element-hq/element-web) is the web frontend for [Synapse](https://github.com/element-hq/synapse), the reference implementation of the sovereign and secure [Matrix protocol](https://matrix.org).
In openDesk, Element is used for chat and direct audio & video calling. In openDesk, Element is used for chat and direct audio & video calling.
## Jitsi (Video Conferencing) ## Jitsi (video conferencing)
[Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings. [Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings.
@@ -409,33 +409,33 @@ In openDesk, Jitsi is used for video conferencing and online meetings. It integr
[Jigasi](https://github.com/jitsi/jigasi) (Jitsi's SIP component) also allows joining the meeting via phone call if an external SIP server and SIP trunk are provided. [Jigasi](https://github.com/jitsi/jigasi) (Jitsi's SIP component) also allows joining the meeting via phone call if an external SIP server and SIP trunk are provided.
## Nextcloud (Files) ## Nextcloud (files)
[Nextcloud](https://nextcloud.com) is a file storage and sync platform with powerful collaboration capabilities with desktop, mobile and web interfaces. [Nextcloud](https://nextcloud.com) is a file storage and sync platform with powerful collaboration capabilities with desktop, mobile and web interfaces.
## Nubus (Identity and Access Management / Portal) ## Nubus (identity and access management / portal)
[Nubus](https://www.univention.com/products/nubus/) is a unified Identity & Access Management, providing you with full control and digital sovereignty over your IAM processes and data. [Nubus](https://www.univention.com/products/nubus/) is a unified Identity & Access Management, providing you with full control and digital sovereignty over your IAM processes and data.
In openDesk Nubus is providing the management for user, groups and other IAM stored objects, as well as the portal, the Identity provider for Single Sign-On and federation scenarios and the In openDesk, Nubus provides the management required for users, groups and other IAM objects, as well as the portal, the Identity provider for Single Sign-On and federation scenarios.
## OpenProject (Project management) ## OpenProject (project management)
[OpenProject](https://www.openproject.org) is a project management tool that supports agile project management, team collaboration, issue tracking, and more. [OpenProject](https://www.openproject.org) is a project management tool that supports agile project management, team collaboration, issue tracking, and more.
## OX App Suite (Groupware) with OX Dovecot (Mail backend) ## OX App Suite (groupware) with OX Dovecot (mail backend)
[OX App Suite](https://www.open-xchange.com/products/ox-app-suite) is a groupware application using [OX Dovecot](https://www.dovecot.org/) as its backend mail store. [OX App Suite](https://www.open-xchange.com/products/ox-app-suite) is a groupware application using [OX Dovecot](https://www.dovecot.org/) as its backend mail store.
In openDesk, OX App Suite is used for email, calendar, address book and personal task management. In openDesk, OX App Suite is used for email, calendar, address book and personal task management.
## XWiki (Knowledge management) ## XWiki (knowledge management)
[XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration. [XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration.
# Application specific user accounts # Application specific user accounts
While the IAM managed users centrally, some applications come with local accounts for administrative purposes. While the IAM manages users centrally, some applications come with local accounts for administrative purposes:
| Application | Account name | Purpose | Password | | Application | Account name | Purpose | Password |
| ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
@@ -443,7 +443,7 @@ While the IAM managed users centrally, some applications come with local account
| Element | `uvs` | The account for the "User Verification Service". It is used by Jitsi integrated into Element. | `secrets.matrixUserVerificationService.password` | | Element | `uvs` | The account for the "User Verification Service". It is used by Jitsi integrated into Element. | `secrets.matrixUserVerificationService.password` |
| | `meeting-bot` | Used by the Nordeck Meeting-Bot to manage meeting rooms in Synapse. | `secrets.matrixNeoDateFixBot.password` | | | `meeting-bot` | Used by the Nordeck Meeting-Bot to manage meeting rooms in Synapse. | `secrets.matrixNeoDateFixBot.password` |
| Nextcloud | `nextcloud` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.nextcloud.adminPassword` | | Nextcloud | `nextcloud` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.nextcloud.adminPassword` |
| OX App Suite | `admin` | OX-Connector to provision context, users, groups etc. | `secrets.oxAppsuite.adminPassword` | | OX App Suite | `admin` | OX Connector to provision context, users, groups etc. | `secrets.oxAppsuite.adminPassword` |
| OpenProject | set in `secrets.openproject.apiAdminUsername` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.openproject.apiAdminPassword` | | OpenProject | set in `secrets.openproject.apiAdminUsername` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.openproject.apiAdminPassword` |
| XWiki | `superadmin` | Only available with `debug.enabled: true`, can be used for interactive login using `/bin/view/Main/?oidc.skipped=true`. | `secrets.xwiki.superadminpassword` | | XWiki | `superadmin` | Only available with `debug.enabled: true`, can be used for interactive login using `/bin/view/Main/?oidc.skipped=true`. | `secrets.xwiki.superadminpassword` |

View File

@@ -5,7 +5,7 @@ SPDX-License-Identifier: Apache-2.0
<h1>openDesk APIs</h1> <h1>openDesk APIs</h1>
This chapter presents APIs available in openDesk grouped by applications. This chapter presents APIs available in openDesk, grouped by application.
<!-- TOC --> <!-- TOC -->
* [IAM - Nubus](#iam---nubus) * [IAM - Nubus](#iam---nubus)
@@ -16,9 +16,9 @@ This chapter presents APIs available in openDesk grouped by applications.
* [UDM Simple API](#udm-simple-api) * [UDM Simple API](#udm-simple-api)
* [UDM REST API](#udm-rest-api) * [UDM REST API](#udm-rest-api)
* [UCR Python API](#ucr-python-api) * [UCR Python API](#ucr-python-api)
* [LDAP](#ldap) * [Identity Store and Directory Service (LDAP)](#identity-store-and-directory-service-ldap)
* [Nubus Provisioning Service (**TBD**)](#nubus-provisioning-service-tbd) * [Nubus Provisioning Service](#nubus-provisioning-service)
* [Nubus Authorization Service (**TBD**)](#nubus-authorization-service-tbd) * [Nubus Authorization Service](#nubus-authorization-service)
* [Groupware - OX AppSuite / OX Dovecot](#groupware---ox-appsuite--ox-dovecot) * [Groupware - OX AppSuite / OX Dovecot](#groupware---ox-appsuite--ox-dovecot)
* [Usage of APIs within openDesk](#usage-of-apis-within-opendesk) * [Usage of APIs within openDesk](#usage-of-apis-within-opendesk)
* [HTTP API](#http-api) * [HTTP API](#http-api)
@@ -65,11 +65,13 @@ This chapter presents APIs available in openDesk grouped by applications.
# IAM - Nubus # IAM - Nubus
![High-level architecture of Univention part withAPIs/interfaces highlighted](./apis_images/IAM-overview.png) ![Overview of functional components in Univention Nubus for Kubernetes](./apis_images/IAM-overview_functional_components_structured.svg)
[Source](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/overview/components.html#overview-components-fig)
## UMC Python API ## UMC Python API
![Composition of UMC component with APIs highlighted](./apis_images/IAM-umc-architecture.png) ![Composition of UMC component with APIs highlighted](./apis_images/IAM-umc-architecture.png)
[Source](https://docs.software-univention.de/developer-reference/latest/en/umc/architecture.html#umc-api)
| Name | UMC Python API | | Name | UMC Python API |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -89,8 +91,8 @@ This chapter presents APIs available in openDesk grouped by applications.
## UMC store API ## UMC store API
| Name | UMC store API (also named UMC JavaScript API or Dojo/UMC JavaScript API) | | Name | UMC store API (also named UMC JavaScript API or Dojo/UMC JavaScript API) |
| ------------------------------ | --------------------------------------------------------------------------------------------------------- | | ------------------------------ | ---------------------------------------------------------------------------------------------------------- |
| Purpose | Encapsulate and ease the access to module data from JavaScript | | Purpose | Encapsulate and ease the access to JavaScript module data |
| Versioning | | | Versioning | |
| Authentication | | | Authentication | |
| In openDesk provided by | Nubus UMC | | In openDesk provided by | Nubus UMC |
@@ -101,7 +103,7 @@ This chapter presents APIs available in openDesk grouped by applications.
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | | | Message protocol | |
| Supported standards | | | Supported standards | |
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/umc/local-system-module.html#umc-store-api | | Documentation | https://docs.software-univention.de/developer-reference/latest/en/umc/local-system-module.html#umc-store-api |
## IntercomService (ICS) API ## IntercomService (ICS) API
@@ -113,7 +115,7 @@ This chapter presents APIs available in openDesk grouped by applications.
| In openDesk provided by | Nubus UMC | | In openDesk provided by | Nubus UMC |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
| Usage within component | | | Usage within component | |
| Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see also [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) | | Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) |
| Usage for external integration | | | Usage for external integration | |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Depends on the integration use case. | | Message protocol | Depends on the integration use case. |
@@ -129,34 +131,35 @@ This chapter presents APIs available in openDesk grouped by applications.
| Authentication | | | Authentication | |
| In openDesk provided by | Univention Event Processing | | In openDesk provided by | Univention Event Processing |
| Transport protocol | | | Transport protocol | |
| Usage within component | The listener mechanism is used to dispatch events from the LDAP to the Nubus provisioning service. It should be replaced by another approach in the future. | | Usage within component | The listener mechanism is used to dispatch events from the LDAP to the Nubus provisioning service. It should be replaced with another approach in the future. |
| Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see also [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) | | Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see also [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) |
| Usage for external integration | | | Usage for external integration | |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Depends on the integration use case. | | Message protocol | Depends on the integration use case. |
| Supported standards | | | Supported standards | |
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/listener/api.html | | Documentation | https://docs.software-univention.de/developer-reference/latest/en/listener/api.html |
More details on the Nubus provisioning service can be found here: https://docs.software-univention.de/nubus-kubernetes-architecture/0.5/en/components/provisioning-service.html More details on the Nubus provisioning service can be found here: https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/components/provisioning-service.html
## UDM Simple API ## UDM Simple API
![Composition of UMC component with APIs highlighted](./apis_images/IAM-udm.png) ![Architecture of UDM](./apis_images/IAM-udm-architecture.svg)
[Source](https://docs.software-univention.de/architecture/latest/en/services/udm.html#architecture-model-udm)
| Name | UDM Simple API | | Name | UDM Simple API |
| ------------------------------ | ----------------------------------------------------------------- | | ------------------------------ | ------------------------------------------------------------------- |
| Purpose | Allows to use capability and objects directly in Python programs. | | Purpose | Allows use of capability and objects directly in Python programs. |
| Versioning | | | Versioning | |
| Authentication | | | Authentication | |
| In openDesk provided by | Univention Directory Manager | | In openDesk provided by | Univention Directory Manager |
| Transport protocol | | | Transport protocol | |
| Usage within component | | | Usage within component | Allows to use UDM capability and objects directly in Python programs. UDM Simple API provides Python modules and classes below `univention.udm.*` |
| Usage within openDesk | | | Usage within openDesk | |
| Usage for external integration | | | Usage for external integration | |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Depends on the integration use case. | | Message protocol | Depends on the integration use case. |
| Supported standards | | | Supported standards | |
| Documentation | | | Documentation | https://docs.software-univention.de/ucs-python-api/univention.udm.html#module-univention.udm. |
## UDM REST API ## UDM REST API
@@ -166,18 +169,19 @@ More details on the Nubus provisioning service can be found here: https://docs.s
| Versioning | | | Versioning | |
| Authentication | Basic Auth | | Authentication | Basic Auth |
| In openDesk provided by | Univention Directory Manager | | In openDesk provided by | Univention Directory Manager |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP() |
| Usage within component | The Nubus bootstrapping makes use of the API. | | Usage within component | The Nubus bootstrapping process makes use of the API. |
| Usage within openDesk | | | Usage within openDesk | |
| Usage for external integration | The [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import) utilizes the API. | | Usage for external integration | The [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import) utilizes the API. |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Depends on the integration use case. | | Message protocol | Depends on the integration use case. |
| Supported standards | | | Supported standards | |
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html | | Documentation | https://docs.software-univention.de/nubus-kubernetes-customization/latest/en/api/udm-rest.html |
## UCR Python API ## UCR Python API
![Composition of UCR component with APIs/interfaces highlighted](./apis_images/IAM-ucr.png) ![Architecture overview of UCR](./apis_images/IAM-ucr-architecture.svg)
[Source](https://docs.software-univention.de/architecture/latest/en/services/ucr.html#services-ucr-architecture-model)
| Name | UCR Python API | | Name | UCR Python API |
| ------------------------------ | --------------------------------------------------------------------------------------------------- | | ------------------------------ | --------------------------------------------------------------------------------------------------- |
@@ -186,54 +190,67 @@ More details on the Nubus provisioning service can be found here: https://docs.s
| Authentication | | | Authentication | |
| In openDesk provided by | Nubus | | In openDesk provided by | Nubus |
| Transport protocol | | | Transport protocol | |
| Usage within component | The Nubus bootstrapping makes use of the API. | | Usage within component | The Nubus bootstrapping process makes use of the API. |
| Usage within openDesk | | | Usage within openDesk | |
| Usage for external integration | | | Usage for external integration | |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | | | Message protocol | |
| Supported standards | | | Supported standards | |
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/ucr/usage.html#using-ucr-from-python | | Documentation | https://docs.software-univention.de/developer-reference/latest/en/ucr/usage.html#using-ucr-from-python |
## LDAP ## Identity Store and Directory Service (LDAP)
| Name | LDAP | ![Overview of the Identity Store and Directory Service](./apis_images/IAM-functional_component_identity_store.svg)
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | [Source](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/components/identity-store.html#component-identity-store-figure)
| Name | Identity Store and Directory Service (LDAP) |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Read access to Nubus LDAP | | Purpose | Read access to Nubus LDAP |
| Versioning | n/a | | Versioning | n/a |
| Authentication | LDAP user auth | | Authentication | LDAP user auth |
| In openDesk provided by | Nubus openLDAP | | In openDesk provided by | Nubus openLDAP |
| Transport protocol | LDAP | | Transport protocol | LDAP |
| Usage within component | Data backend for Nubus | | Usage within component | Data backend for Nubus |
| Usage within openDesk | Used by multiple application to access user/group data, e.g. Nextcloud Server, OpenProject, OX AppSuite backend, XWiki | | Usage within openDesk | Used by multiple applications to access user/group data, e.g. Nextcloud Server, OpenProject, OX AppSuite backend, XWiki |
| Usage for external integration | No recommended | | Usage for external integration | Not recommended |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | LDAP | | Message protocol | LDAP |
| Supported standards | LDAP | | Supported standards | LDAP |
| Documentation | https://docs.software-univention.de/manual/5.0/en/domain-ldap/ldap-directory.html | | Documentation | https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/components/identity-store.html#component-identity-store-directory-service |
## Nubus Provisioning Service (**TBD**) ## Nubus Provisioning Service
To be delivered. ![Overview of the Provisioning Service and its components](./apis_images/IAM-functional_component_provisioning_service_complete.svg)
[Source](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/components/provisioning-service.html#component-provisioning-service-complete-figure)
## Nubus Authorization Service (**TBD**) | Name | Nubus Proisioning Service |
| ------------- | --------------------------------------------------------------------------------------------------- |
| Documentation | https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/components/provisioning-service.html |
To be delivered. ## Nubus Authorization Service
![ArchiMate view of the interfaces and protocols of the Authorization Service](./apis_images/IAM-interfaces_authorization_service.svg)
[Source](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/overview/interfaces-protocols.html#authorization-service)
| Name | Nubus Authorization Service |
| ------------- | --------------------------------------------------------------------------------------------------- |
| Documentation | https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/overview/interfaces-protocols.html#authorization-service |
# Groupware - OX AppSuite / OX Dovecot # Groupware - OX AppSuite / OX Dovecot
![OX AppSuite APIs overview](./apis_images/Groupware-apis.png) ![OX AppSuite APIs overview](./apis_images/Groupware-api.png)
![Use of OX AppSuite APIs by other components](./apis_images/Groupware-api-usage.png) ![Use of OX AppSuite APIs by other components](./apis_images/Groupware-api-usage.png)
## Usage of APIs within openDesk ## Usage of APIs within openDesk
Following are APIs used by the Groupware application: The following are the APIs used by the Groupware application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| ------------------------------ | ------------------ | ------------------ | ----------------------------------------------------------- | -------------------------------- | | ------------------------------ | ------------------ | ------------------ | ----------------------------------------------------------- | -------------------------------- |
| AppSuite Middleware | Keycloak | Authentication | Single sign-on / sign-out | OIDC | | AppSuite Middleware | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
| Dovecot | Keycloak | Authentication | Authenticate user | OIDC | | Dovecot | Keycloak | Authentication | Authenticate user | OIDC |
| AppSuite Frontend (in Browser) | Intercom Service | Silent Login | Stablish Intercom Service session | | | AppSuite Frontend (in Browser) | Intercom Service | Silent Login | Establish Intercom Service session | |
| AppSuite Frontend (in Browser) | Intercom Service | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON | | AppSuite Frontend (in Browser) | Intercom Service | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
| AppSuite Frontend (in Browser) | Intercom Service | Element Bot | Manage (CUD) meetings in Element | Custom JSON (based on iCalender) | | AppSuite Frontend (in Browser) | Intercom Service | Element Bot | Manage (CUD) meetings in Element | Custom JSON (based on iCalender) |
| AppSuite Frontend (in Browser) | Intercom Service | Filepicker | Read/write contents from/to Nextcloud or create share links | WebDAV & Nextcloud API | | AppSuite Frontend (in Browser) | Intercom Service | Filepicker | Read/write contents from/to Nextcloud or create share links | WebDAV & Nextcloud API |
@@ -249,13 +266,13 @@ Following are APIs used by the Groupware application:
| Name | HTTP API | | Name | HTTP API |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Login, accessing email, contacts, calendar, tasks, configs, email filtering, task automation, workflow automation, etc most of the AppSuite's functionality that is available to the user through the Web-UI. | | Purpose | Login, accessing email, contacts, calendar, tasks, configs, email filtering, task automation, workflow automation, etc most of the AppSuite's functionality that is available to the user through the Web-UI. |
| Versioning | No API-specific versioning. The version can be considered identical with OX App Suite version, which is contained in URL of online documentation of API. | | Versioning | No API-specific versioning. The version can be considered identical to the OX App Suite version, which is contained in the URL of the online API documentation. |
| Authentication | | | Authentication | |
| In openDesk provided by | OX AppSuite Middleware | | In openDesk provided by | OX AppSuite Middleware |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
| Usage within component | Used by OX Web-UI (Frontend) | | Usage within component | Used by OX Web-UI (Frontend) |
| Usage within openDesk | - Nextcloud used the SearchAPI to synchronize contacts<br>- Nordeck Meeting bot synchronizes OX meeting changes applied in Element. | | Usage within openDesk | - Nextcloud uses the SearchAPI to synchronize contacts<br>- Nordeck Meeting bot synchronizes OX meeting changes applied in Element. |
| Usage for external integration | Not used at the moment, but recommended way to integrate with OX AppSuite. | | Usage for external integration | Not used at the moment, but is the recommended way to integrate with OX AppSuite. |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | JSON based, AppSuite specific format | | Message protocol | JSON based, AppSuite specific format |
| Supported standards | iCal, defined by RFC, fully implemented | | Supported standards | iCal, defined by RFC, fully implemented |
@@ -271,7 +288,7 @@ Following are APIs used by the Groupware application:
| In openDesk provided by | OX AppSuite Middleware | | In openDesk provided by | OX AppSuite Middleware |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
| Usage within component | none | | Usage within component | none |
| Usage within openDesk | OX-Connector synchronizes the state of the objects (users, groups etc.) managed in the LDAP. | | Usage within openDesk | OX Connector synchronizes the state of the objects (users, groups etc.) managed in the LDAP. |
| Usage for external integration | none | | Usage for external integration | none |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | XML based, exactly following the format of Java RMI. | | Message protocol | XML based, exactly following the format of Java RMI. |
@@ -284,9 +301,9 @@ Following are APIs used by the Groupware application:
## REST API ## REST API
| Name | REST API | | Name | REST API |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Delivers services in following functional groups:<br>- *Admin*: Interface for provisioning and other administrative operations<br>- *Advertisement*: The advertisement module<br>- *Health*: The health-check module<br>- *InternetFreeBusy*: Servlet for requesting free busy data<br>- *Metrics*: The metrics module<br>- *Preliminary*: This module contains preliminary endpoints which can change in the future<br>- *Push*: The push module<br>- *Userfeedback*: The user feedback module | | Purpose | Delivers services in the following functional groups:<br>- *Admin*: Interface for provisioning and other administrative operations<br>- *Advertisement*: The advertisement module<br>- *Health*: The health-check module<br>- *InternetFreeBusy*: Servlet for requesting free busy data<br>- *Metrics*: The metrics module<br>- *Preliminary*: This module contains preliminary endpoints which may change in the future<br>- *Push*: The push module<br>- *Userfeedback*: The user feedback module |
| Versioning | No API-specific versioning. The version can be considered identical with OX App Suite version, which is contained in URL of online documentation of API. | | Versioning | No API-specific versioning. The version can be considered identical to the OX App Suite version, which is contained in the URL of the online API documentation. |
| Authentication | Basic Auth | | Authentication | Basic Auth |
| In openDesk provided by | OX AppSuite Middleware | | In openDesk provided by | OX AppSuite Middleware |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
@@ -302,7 +319,7 @@ Following are APIs used by the Groupware application:
| Name | CardDAV | | Name | CardDAV |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API | | Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API |
| Versioning | Yes, API version is specific to the version of underlying protocol | | Versioning | Yes, API version is specific to the version of the underlying protocol |
| Authentication | | | Authentication | |
| In openDesk provided by | OX AppSuite Middleware | | In openDesk provided by | OX AppSuite Middleware |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
@@ -319,7 +336,7 @@ Following are APIs used by the Groupware application:
| Name | CalDAV | | Name | CalDAV |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API | | Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API |
| Versioning | Yes, API version is specific to the version of underlying protocol | | Versioning | Yes, API version is specific to the version of the underlying protocol |
| Authentication | | | Authentication | |
| In openDesk provided by | OX AppSuite Middleware | | In openDesk provided by | OX AppSuite Middleware |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
@@ -334,9 +351,9 @@ Following are APIs used by the Groupware application:
## IMAP ## IMAP
| Name | IMAP | | Name | IMAP |
| ------------------------------ | ------------------------------------------------------------------ | | ------------------------------ |--------------------------------------------------------------------------------------|
| Purpose | Used for retrieval of emails, designed for rich clients | | Purpose | Used for retrieval of emails, designed for rich clients |
| Versioning | Yes, API version is specific to the version of underlying protocol | | Versioning | Yes, API version is specific to the version of the underlying protocol |
| Authentication | | | Authentication | |
| In openDesk provided by | OX Dovecot | | In openDesk provided by | OX Dovecot |
| Transport protocol | TCP | | Transport protocol | TCP |
@@ -351,9 +368,9 @@ Following are APIs used by the Groupware application:
## POP3 ## POP3
| Name | POP3 | | Name | POP3 |
| ------------------------------ | ------------------------------------------------------------------ | | ------------------------------ |------------------------------------------------------------------------|
| Purpose | Used for retrieval of emails, designed for rich clients | | Purpose | Used for retrieval of emails, designed for rich clients |
| Versioning | Yes, API version is specific to the version of underlying protocol | | Versioning | Yes, API version is specific to the version of the underlying protocol |
| Authentication | | | Authentication | |
| In openDesk provided by | OX Dovecot | | In openDesk provided by | OX Dovecot |
| Transport protocol | TCP | | Transport protocol | TCP |
@@ -371,7 +388,7 @@ Following are APIs used by the Groupware application:
## Usage of APIs within openDesk ## Usage of APIs within openDesk
Following are APIs used by the Files application: The following are the APIs used by the Files application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| ---------------- | ---------------------- | ---------------------- | -------------------------------------------------- | -------------- | | ---------------- | ---------------------- | ---------------------- | -------------------------------------------------- | -------------- |
@@ -385,12 +402,12 @@ Following are APIs used by the Files application:
| Name | OCS API | | Name | OCS API |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Obtain and/or manage user status, user preferences, shares, sharees, recommendations. API is likely to be extended to other use cases in the future. Nextcloud apps can extend the functionality of OCS API by providing new endpoints | | Purpose | Obtain and/or manage user status, user preferences, shares, sharees, recommendations. API is likely to be extended to other use cases in the future. Nextcloud apps can extend the functionality of OCS API by providing new endpoints |
| Versioning | Identical with component release version | | Versioning | Identical to component release version |
| Authentication | Basic Auth or by passing a set of valid session cookies | | Authentication | Basic Auth or by passing a set of valid session cookies |
| In openDesk provided by | Nextcloud Server | | In openDesk provided by | Nextcloud Server |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
| Usage within component | none | | Usage within component | none |
| Usage within openDesk | Filepicker is using the API to create share links. | | Usage within openDesk | Filepicker uses the API to create share links. |
| Usage for external integration | none | | Usage for external integration | none |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Requests in JSON, responses in JSON or XML | | Message protocol | Requests in JSON, responses in JSON or XML |
@@ -418,9 +435,9 @@ Following are APIs used by the Files application:
## Activity API ## Activity API
| Name | Activity API | | Name | Activity API |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------ |----------------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Allows to obtain the list of actions initiated or involving a specific user (files created, shared, deleted etc and other activities reported by apps) | | Purpose | Obtaining the list of actions initiated by or involving a specific user (files created, shared, deleted etc and other activities reported by apps) |
| Versioning | Identical with component release version | | Versioning | Identical to component release version |
| Authentication | See linked documentation (which also names the version), address via URL path, e.g. `/ocs/v2.php/apps/activity/api/v2` | | Authentication | See linked documentation (which also names the version), address via URL path, e.g. `/ocs/v2.php/apps/activity/api/v2` |
| In openDesk provided by | Nextcloud Server | | In openDesk provided by | Nextcloud Server |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
@@ -435,9 +452,9 @@ Following are APIs used by the Files application:
## Remote wipe API ## Remote wipe API
| Name | Remote wipe API | | Name | Remote wipe API |
| ------------------------------ | ------------------------------------------------------------------------------------------- | | ------------------------------ |--------------------------------------------------------------------------------------------|
| Purpose | Used to wipe storage remotely (e.g. on a lost device) | | Purpose | Used to wipe storage remotely (e.g. on a lost device) |
| Versioning | Identical with component release version | | Versioning | Identical to component release version |
| Authentication | Login flow token | | Authentication | Login flow token |
| In openDesk provided by | Nextcloud Server | | In openDesk provided by | Nextcloud Server |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
@@ -452,14 +469,14 @@ Following are APIs used by the Files application:
## WebDAV ## WebDAV
| Name | WebDAV | | Name | WebDAV |
| ------------------------------ | --------------------------------------------------------------------------------------- | | ------------------------------ |-----------------------------------------------------------------------------------------|
| Purpose | Accessing files and folders, conducting search | | Purpose | Accessing files and folders, conducting searches |
| Versioning | Identical with component release version | | Versioning | Identical to component release version |
| Authentication | Basic Auth or by passing a set of valid session cookies | | Authentication | Basic Auth or by passing a set of valid session cookies |
| In openDesk provided by | Nextcloud Server | | In openDesk provided by | Nextcloud Server |
| Transport protocol | HTTP(S) | | Transport protocol | HTTP(S) |
| Usage within component | none | | Usage within component | none |
| Usage within openDesk | Used by OX AppSuite to put/retrieve files (attachments) | | Usage within openDesk | Used by OX AppSuite to get/put files (attachments) |
| Usage for external integration | none | | Usage for external integration | none |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | Requests in JSON, responses in JSON or XML | | Message protocol | Requests in JSON, responses in JSON or XML |
@@ -472,7 +489,7 @@ CalDAV and CardDAV APIs are available in Nextcloud, but as openDesk uses OX AppS
# Weboffice - Collabora # Weboffice - Collabora
Following are APIs used by the Weboffice application: The following are the APIs used by the Weboffice application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| --------- | ------------------ | ----------------- | ------------------------------------------- | -------------- | | --------- | ------------------ | ----------------- | ------------------------------------------- | -------------- |
@@ -497,14 +514,14 @@ sequenceDiagram
## PostMessage API ## PostMessage API
| Name | PostMessage API | | Name | PostMessage API |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ |---------------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Interact with parent frame when Collabora browser part is enclosed in one, mostly based on WOPI specification with few extensions/modifications | | Purpose | Interact with parent frame when Collabora browser part is enclosed in one, mostly based on WOPI specification with few extensions/modifications |
| Versioning | N/A | | Versioning | N/A |
| Authentication | CSP rules protect unauthorized communication. In practice editor is embedded in an iframe and can communicate only with the iframe's parent. | | Authentication | CSP rules protect unauthorized communication. In practice, the editor is embedded in an iframe and can communicate only with the iframe's parent. |
| In openDesk provided by | Collabora | | In openDesk provided by | Collabora |
| Transport protocol | HTTP | | Transport protocol | HTTP |
| Usage within component | N/A | | Usage within component | N/A |
| Usage within openDesk | Query number of users in a document, query supported export formats, manage sessions, manage actions like save, insert image, print etc. | | Usage within openDesk | Query the number of users in a document, query supported export formats, manage sessions, manage actions like save, insert image, print etc. |
| Usage for external integration | In openDesk Collabora Online is integrated with Nextcloud but other integrations exist and are possible, see the documentation. | | Usage for external integration | In openDesk Collabora Online is integrated with Nextcloud but other integrations exist and are possible, see the documentation. |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | JSON | | Message protocol | JSON |
@@ -524,13 +541,13 @@ sequenceDiagram
| Usage within openDesk | To generate thumbnails in Nextcloud for supported document types. | | Usage within openDesk | To generate thumbnails in Nextcloud for supported document types. |
| Usage for external integration | It is possible to set up Collabora Online as a general document converter service. | | Usage for external integration | It is possible to set up Collabora Online as a general document converter service. |
| Parallel access | Allowed | | Parallel access | Allowed |
| Message protocol | text based, see the documentation | | Message protocol | Text based, see the documentation |
| Supported standards | N/A | | Supported standards | N/A |
| Documentation | https://sdk.collaboraonline.com/docs/conversion_api.html | | Documentation | https://sdk.collaboraonline.com/docs/conversion_api.html |
# Project management - OpenProject # Project management - OpenProject
Following are APIs used by the Project management application: The following are the APIs used by the Project management application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- | | --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
@@ -567,20 +584,20 @@ Following are APIs used by the Project management application:
*How does it work? (What do users need to know about architecture an internal components?)* *How does it work? (What do users need to know about architecture an internal components?)*
- HAL is a standard to define resources with embedding and links between them - HAL is a standard to define resources with embedding and links between them
- HAL contains action links depending on the users permissions, allows to derive allowed actions from object keys in json - HAL contains action links depending on the users permissions, allows permitted actions to be derived from object keys in json
*What knowledge prerequisites for the developer before using the API?* *What knowledge should the developer have before using the API?*
- Knowledge of REST - Knowledge of REST
- (Optional) Knowledge of HAL standard - (Optional) Knowledge of HAL standard
*Any extensions or APIs in development or in planning users should know about?* *Are there any extensions or APIs in (or planned for) development that users should know about?*
- Signaling to receive only selected attributes/nested resources from the API for performance improvements - Signaling to receive only selected attributes/nested resources from the API for performance improvements
## BCF API ## BCF API
| Name | BCF API | | Name | BCF API |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Implementation of subset of [BCF](https://en.wikipedia.org/wiki/BIM_Collaboration_Format) standard for [BIM](https://en.wikipedia.org/wiki/Building_information_modeling) projects | | Purpose | Implementation of a subset of [BCF](https://en.wikipedia.org/wiki/BIM_Collaboration_Format) standard for [BIM](https://en.wikipedia.org/wiki/Building_information_modeling) projects |
| Versioning | URL based versioning scheme, e.g. `/api/bcf/2.1` | | Versioning | URL based versioning scheme, e.g. `/api/bcf/2.1` |
| Authentication | OAuth2 | | Authentication | OAuth2 |
| In openDesk provided by | OpenProject | | In openDesk provided by | OpenProject |
@@ -598,8 +615,8 @@ Following are APIs used by the Project management application:
## IFrame API ## IFrame API
| Name | IFrame API | | Name | IFrame API |
| ------------------------------ | ---------------------------------------------------------------------- | | ------------------------------ |--------------------------------------------------------------------------|
| Purpose | Embed Jitsi video conferencing features into existing application/site | | Purpose | Embed Jitsi video conferencing features into existing applications/sites |
| Versioning | Identical to the Jitsi release version | | Versioning | Identical to the Jitsi release version |
| Authentication | Optional (JWT-based authentication in openDesk context) | | Authentication | Optional (JWT-based authentication in openDesk context) |
| In openDesk provided by | Jitsi-Web | | In openDesk provided by | Jitsi-Web |
@@ -704,7 +721,7 @@ classDiagram
JitsiVideoConference *-- JitsiMeetReactSdk JitsiVideoConference *-- JitsiMeetReactSdk
``` ```
Following are APIs used by the Chat application: The following are the APIs used by the Chat application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- | | --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
@@ -748,8 +765,8 @@ Following are APIs used by the Chat application:
## Matrix Server-Server API ## Matrix Server-Server API
| Name | Matrix Server-Server API | | Name | Matrix Server-Server API |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ |----------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Communication between Matrix server (also known as FederationAPIs) | | Purpose | Communication between Matrix servers (also known as FederationAPIs) |
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/federation/v2`) | | Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/federation/v2`) |
| Authentication | HTTP-Authorization header with Bearer token | | Authentication | HTTP-Authorization header with Bearer token |
| In openDesk provided by | Synapse | | In openDesk provided by | Synapse |
@@ -866,7 +883,7 @@ Following are APIs used by the Chat application:
# Knowledge management - XWiki # Knowledge management - XWiki
Following are APIs used by the Knowledge management application: The following are the APIs used by the Knowledge management application:
| Used by | Accessed component | Service | Purpose | Message format | | Used by | Accessed component | Service | Purpose | Message format |
| ------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- | | ------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
@@ -877,8 +894,8 @@ Following are APIs used by the Knowledge management application:
## REST API ## REST API
| Name | REST API | | Name | REST API |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Purpose | Perform low level action, e.g. interact with XWiki stored data | | Purpose | Perform low-level actions, e.g. interact with XWiki stored data |
| Versioning | | | Versioning | |
| Authentication | Anonymous or username/password on each request (stateless) | | Authentication | Anonymous or username/password on each request (stateless) |
| In openDesk provided by | XWiki | | In openDesk provided by | XWiki |
@@ -897,7 +914,7 @@ Following are APIs used by the Knowledge management application:
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Java API | | Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Java API |
| Versioning | | | Versioning | |
| Authentication | Executed in context of (authenticated) user or anonymous - permissions (scripting rights, programming rights) of that context apply | | Authentication | Performed in the context of an (authenticated) user or anonymously - permissions (scripting rights, programming rights) of that context apply |
| In openDesk provided by | XWiki | | In openDesk provided by | XWiki |
| Transport protocol | | | Transport protocol | |
| Usage within component | | | Usage within component | |
@@ -914,7 +931,7 @@ Following are APIs used by the Knowledge management application:
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Scripting API | | Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Scripting API |
| Versioning | | | Versioning | |
| Authentication | Executed in context of (authenticated) user or anonymous - but without the permission check (in opposite to the Scripting API) | | Authentication | Performed in the context of an (authenticated) user or anonymously - but without the permission check (in contrast to the Scripting API) |
| In openDesk provided by | XWiki | | In openDesk provided by | XWiki |
| Transport protocol | | | Transport protocol | |
| Usage within component | | | Usage within component | |
@@ -931,7 +948,7 @@ Following are APIs used by the Knowledge management application:
| ------------------------------ | -------------------------------------------------------------------------------------------- | | ------------------------------ | -------------------------------------------------------------------------------------------- |
| Purpose | Include dynamic components in XWiki/web pages | | Purpose | Include dynamic components in XWiki/web pages |
| Versioning | | | Versioning | |
| Authentication | Executed in context of (authenticated) user or anonymous | | Authentication | Performed in the context of an (authenticated) user or anonymously |
| In openDesk provided by | Jitsi | | In openDesk provided by | Jitsi |
| Transport protocol | | | Transport protocol | |
| Usage within component | | | Usage within component | |

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 189 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 411 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 186 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 143 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 118 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 80 KiB

View File

@@ -0,0 +1,276 @@
<!--
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0
-->
<h1>Baseline Requirements</h1>
* [Preamble / Scope](#preamble--scope)
* [Software bill of materials (SBOMs)](#software-bill-of-materials-sboms)
* [Artifact SBOMs](#artifact-sboms)
* [Source code SBOMs](#source-code-sboms)
* [License compliance](#license-compliance)
* [Software supply chain security](#software-supply-chain-security)
* [Container architectural basics](#container-architectural-basics)
* [Security](#security)
* [IT-Grundschutz](#it-grundschutz)
* [Accessibility](#accessibility)
* [Data protection](#data-protection)
* [Functionality and features](#functionality-and-features)
* [Non-overlapping](#non-overlapping)
* [User lifecycle](#user-lifecycle)
* [Pull: LDAP](#pull-ldap)
* [Push: Provisioning](#push-provisioning)
* [Authentication](#authentication)
* [Top bar](#top-bar)
* [Look and feel](#look-and-feel)
* [Central navigation](#central-navigation)
* [Functional administration](#functional-administration)
* [Theming](#theming)
* [Central user profile](#central-user-profile)
* [Footnotes](#footnotes)
# Preamble / Scope
This document lays out the requirements for open-source products that should become part of openDesk.
As this is a comprehensive set of requirements most new components will not adhere to all of them.
This document can be used to assess the status and possible gaps for a component which might itself be the basis for a decision if a component should be integrated into openDesk by working on closing the identified gaps.
> **Note**<br>
> Even an already integrated application might not adhere to all aspects of the documented requirements yet.
> Closing the gaps for existing applications therefore is an openDesk priority.
# Software bill of materials (SBOMs)
openDesk is looking into options for in-depth SBOM creation first for container images and later for source code. It is still expected by the suppliers to provide artifact and source code SBOMs in a standardized manner, ideally in the openCode preferred [SPDX 2.2.1](https://spdx.org/rdf/ontology/spdx-2-2-1/) format.
**Reference:** https://gitlab.opencode.de/bmi/opendesk/deployment/SBOM/-/tree/main/sboms/0.5.74
## Artifact SBOMs
There are various free tools like [syft](https://github.com/anchore/syft) available to generate SBOMs for container images. It is expected that this kind of artifact SBOMs is provided (and signed) for all containers delivered to be integrated into openDesk.
**Reference:** As part of [openDesk's standard CI](https://gitlab.opencode.de/bmi/opendesk/tooling/gitlab-config) a container image SBOM is derived from the container's content and gets signed. Both artifacts (SBOM and signature) are placed next to the image in the related registry ([e.g.](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/semantic-release/container_registry/827)).
## Source code SBOMs
Today's software development platforms like GitLab or GitHub provide dependency list/graph features that are the basis for your source code SBOMs. These features are usually based on analysis of language-specific package manager dependency definition files. As part of a supplier's software development process, it is expected that source code SBOMs are at least created on the level of the already defined software dependencies within the source code tree of the component.
**Reference:** Currently we do not have source code SBOMs in place.
# License compliance
All parts of openDesk Community Edition must be open source with source code (also) published or at least publishable on openCode.
openCode provides some boundaries when it comes to open source license compliance openDesk has to adhere to:
- The components must be published under a license listed in the [openCode license allow list](https://opencode.de/de/wissen/rechtssichere-nutzung/open-source-lizenzen).
- Delivered artifacts (container images) must contain only components licensed under the aforementioned allow list. A container must not contain any artifact using a license from the [openCode license block list](https://opencode.de/de/wissen/rechtssichere-nutzung/open-source-lizenzen#3.-Negativliste-aller-nicht-freigegebenen-Lizenzen).
Deviations from the above requirements must be documented in the openDesk license deviation report.
**Reference:** https://gitlab.opencode.de/bmi/opendesk/deployment/SBOM/-/blob/main/sboms/openDesk%20Deviation%20Report-0.5.74.md
# Software supply chain security
ZenDiS plans to provide secured key storage as a service on openCode.
openDesk is going to implement [SLSA v1.0](https://slsa.dev/spec/v1.0/).
The minimum requirement for all of openDesk's functional components is that all component artifacts (i.e. container images, Helm charts) are signed and their signature can be verified based on the ZenDiS-provided secure key store.
**Reference:** The [openDesk standard CI](https://gitlab.opencode.de/bmi/opendesk/tooling/gitlab-config) ensures that each container image being built and each Helm chart being released is signed. In the case of container images, the related SBOMs are signed as well.
# Container architectural basics
Note: openDesk is operated as a Kubernetes (K8s) workload.
openDesk applications should adhere to best practices for K8s application/container design. While there are dozens of documents about these best practices please use them as references:
- https://cloud.google.com/architecture/best-practices-for-building-containers
- https://cloud.google.com/architecture/best-practices-for-operating-containers
As some applications were initially created years before K8s was introduced they naturally might take different approaches.
You will find below some of the most common best practice requirements, some of which are auto-tested as part of the openDesk deployment automation:
- Containers come with readiness and liveness probes.
- Containers are stateless and immutable (read-only root file system), state should be placed into a database (or similar).
- Allow horizontal scaling (auto-scaling is of course nice to have).
- Provide resource requests and limits (we do not want to limit CPU though).
- Provide application-specific monitoring endpoints and expose the health of the application.
- Write your logs to STDOUT/STDERR and ideally provide JSON-based logs.
- Use one service per container (microservice pattern).
- Minimize the footprint of your container e.g. removing unnecessary tools, ideally providing a distroless container.
- Allow restrictive setting of the security contexts (see [security-context.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/docs/security-context.md) for reference).
- Support for external secrets.
- Support for externally provided/self-signed certificates.
**Reference:** Some of these requirements are tested and/or documented within the deployment automation:
- CI executed Kyverno tests: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/tree/main/.kyverno/policies
- Generated documentation regarding security contexts: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/docs/security-context.md
# Security
openDesk should be compliant with the "Deutsche Verwaltungscloud Strategie" (DVS). While this is a moving target it references some already established standards like the BSI's [IT-Grundschutz](https://www.bsi.bund.de/DE/Themen/Unternehmen-und-Organisationen/Standards-und-Zertifizierung/IT-Grundschutz/IT-Grundschutz-Kompendium/it-grundschutz-kompendium_node.html) and [C5](https://www.bsi.bund.de/DE/Themen/Unternehmen-und-Organisationen/Informationen-und-Empfehlungen/Empfehlungen-nach-Angriffszielen/Cloud-Computing/Kriterienkatalog-C5/C5_AktuelleVersion/C5_AktuelleVersion_node.html). These standards address hundreds of requirements which are published at the given links. So here's just a summary to understand the approach of the broadest requirements from IT-Grundschutz.
**Reference:** [Deutsche Verwaltungscloud-Strategie Rahmenwerk der Zielarchitektur](https://www.cio.bund.de/SharedDocs/downloads/Webs/CIO/DE/cio-bund/steuerung-it-bund/beschluesse_cio-board/2023_11_Beschluss_CIO_Board_DVS_Rahmenwerk_Anlage.pdf)
## IT-Grundschutz
The IT-Grundschutz catalog knowns a lot of modules ("Bausteine"), but not all of them apply to all components, as there are some related to hardware or some just relevant for the operator while openDesk is "just" the software platform. The first step for an IT-Grundschutz evaluation of a component (or the platform as a whole) requires defining which modules are applicable. Other modules apply to all components e.g. [APP.4.4 Kubernetes](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Grundschutz/IT-GS-Kompendium_Einzel_PDFs_2023/06_APP_Anwendungen/APP_4_4_Kubernetes_Edition_2023.pdf), [SYS.1.6 Containerisierung](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Grundschutz/IT-GS-Kompendium_Einzel_PDFs_2023/07_SYS_IT_Systeme/SYS_1_6_Containerisierung_Edition_2023.pdf) and [CON.2 Datenschutz](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Grundschutz/IT-GS-Kompendium_Einzel_PDFs_2023/03_CON_Konzepte_und_Vorgehensweisen/CON_2_Datenschutz_Edition_2023.pdf).
Within each module are multiple requirements ("Anforderungen") that are usually composed of multiple partial requirements ("Teilanforderungen"). Each requirement has a given category:
- B for basic ("Basis") - the requirement must be fulfilled.
- S for standard ("Standard") - the requirement should also be fulfilled, if not there must be a good reason why it is not the case that does not tamper the security of the overall system. There is only a defined amount of deviations allowed for standard requirements.
- H for high ("Hoch") - in certain scenarios you have extended security requirements, in that case, the high requirements must be fulfilled. openDesk is working towards making that possible.
Different requirements address different roles in IT-Grundschutz.
- Supplier: processes & product (component -> e.g. Open-Xchange, OpenProject)
- Provider: processes & product (platform -> openDesk)
- Operator: processes & product (service)
- Customer: processes.
As a supplier of an openDesk component, you will focus on the "Supplier" requirements, while the outcome (your product) must enable the Provider to fulfill the requirements that lay with its responsibility for the openDesk platform. Operators use openDesk to provide a service, therefore the openDesk platform must enable an Operator to fulfill the related requirements. Finally, the service must enable the customer to align with the scope of the IT-Grundschutz catalog. So it will happen that a requirement from e.g. the customer level needs a specific capability by the product (Supplier's responsibility), a defined core configuration from the platform (Provider's responsibility), or a certain service setup from the Operator.
We are aware that IT-Grundschutz is a complex topic and are working towards a streamlined process to reduce overhead as much as possible and ensure to maximize the use of synergies.
**Reference:** https://gitlab.opencode.de/bmi/opendesk/documentation/it-grundschutz
# Accessibility
Accessibility is a key requirement for software that is being used in the public sector. Therefore the products of the suppliers are expected to adhere to the relevant standards.
Please find more context about the topic on the [website of the German CIO](https://www.cio.bund.de/Webs/CIO/DE/digitaler-wandel/it-barrierefreiheit/vorgaben-und-richtlinien/vorgaben-und-richtlinien-node.html) followed by a more detailed look at the actual accessibility standard [WCAG 2.1](https://www.barrierefreiheit-dienstekonsolidierung.bund.de/Webs/PB/DE/gesetze-und-richtlinien/wcag/wcag-artikel.html).
Each vendor must provide a certificate that their product - or the parts of the product relevant for openDesk - complies with at least WCAG 2.1 AA or [BITV 2.0](https://www.bundesfachstelle-barrierefreiheit.de/DE/Fachwissen/Informationstechnik/EU-Webseitenrichtlinie/BGG-und-BITV-2-0/Die-neue-BITV-2-0/die-neue-bitv-2-0_node.html). As the certification and related product improvements are time-consuming the focus of openDesk is that a supplier provides a plan and certification partner (contract) that shows the supplier is working towards the certification. While the aforementioned standard states the priority is the "A" level requirements, the "AA" level must be met at the end of the process.
> **Note**<br>
> Please keep in mind that WCAG 2.2 and 3.0 are work in progress. If you already work on accessibility improvements you might want to take these standards already into consideration.
**Reference:** In the past the [accessibility evaluations](https://gitlab.opencode.de/bmi/opendesk/info/-/tree/main/24.03/Barrierefreiheit) have been executed by Dataport. But they do not do certifications.
# Data protection
Each component must be able to operate according to the [EU's General Data Protection Regulation (GDPR)](https://gdpr.eu/). This requires some key messages to be answered when it comes to personal data[^1]:
- Who are the affected data subjects?
- What personal data (attributes) from the subjects is being processed?
- Who is the controller and processor of the subject's data?
- Which processing activities involve which data attributes?
- How can the data be deleted?
- Are personal data-related activities traceable?
- How can data be provided uniformly to affected people?
- What does a data privacy-friendly configuration look like?
While this can be answered by each component that will be in the spotlight for the suppliers, we also need an aligned overall picture for openDesk that at least has the platform-specific user lifecycle and cross-application interfaces in focus.
Note: The topics of availability, integrity, and confidentiality of personal data are also being addressed by the IT-Grundschutz module "CON.2". It has to be ensured that it is not in contradiction to what is being done in the general area of data protection.
**Reference:** https://gitlab.opencode.de/bmi/opendesk/documentation/datenschutz
# Functionality and features
## Non-overlapping
To avoid having functionality twice in openDesk it might be required to disable certain functionality within a component. There needs to be an assessment for each new component if it has overlapping functionality and how to deal with that.
**Reference:** The contact management from Nextcloud is done in OX, so Nextcloud has its internal contact management disabled, as well as most of the Nextcloud Talk functionality, due to the presence of Element and Jitsi.
## User lifecycle
With a central Identity- and Access Management (IAM) also the user lifecycle (ULC) that addresses account create-update-delete actions with support for "inactive" accounts must be harmonized within the platform.
The focus is to have all the account information in all applications including the account's state, profile picture ([reference](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues/27)) and - where required - the user's group memberships. This cannot be done purely by pushing that data through OIDC claims when a user logs in to an application therefore two ways of managing an account are applicable and described in the following subchapters.
> **Note**<br>
> Allowing ad hoc updates of account data through OIDC claims during login is still encouraged.
### Pull: LDAP
Applications can access the IAM's LDAP to access all data necessary for managing their part of the ULC.
**Reference:** Most applications use LDAP access as per https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/docs/components.md?ref_type=heads#identity-data-flows
> **Note**<br>
> The direct access to LDAP is going to be deprecated for most use cases. openDesk is looking into active provisioning of the user/group data into the applications using [SCIM](https://scim.cloud/).
### Push: Provisioning
Some applications require active provisioning of the centrally maintained IAM data. As the actual provisioning is part of the openDesk provisioning framework it is necessary to define the ULC flow regarding its different states to get a matching provisioning connector implemented. This is done collaboratively between the supplier and openDesk product management.
**Reference:** New applications will make use of the [provisioning framework](https://gitlab.opencode.de/bmi/opendesk/component-code/crossfunctional/univention/ums-provisioning-api). At the moment to only active (push) provisioned component is OX AppSuite fed by the [OX-connector](https://github.com/univention/ox-connector/tree/ucs5.0).
## Authentication
The central IdP ensures the single sign-on and logout workflows. As standard openDesk uses [Open ID Connect](https://openid.net/). It can be configured to provide additional user information from the IAM when required by a component.
Minimum requirements regarding the OIDC support in an application besides the actual login flow:
- Back-channel logout: [OIDC Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html) must be supported by the components unless there is a significant reason why it technically cannot be supported, in that case [OIDC Front-Channel Logout](https://openid.net/specs/openid-connect-frontchannel-1_0.html) is the alternative.
- IdP Session Refresh: Ensure that your application regularly checks the IdP session for its validity and invalidates the local session when there is no longer an IdP session.
**Reference:** Most applications are directly connected to the IdP and are using OIDC: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/docs/architecture.md#identity-data-flows
## Top bar
The top bar of all applications should provide a common UX.
### Look and feel
The current status is subject to review, but the basics will most likely stay the same. Ensure that the top bar can be customized (or adheres to a given openDesk standard) in various settings:
- Size (height) of the bar.
- Foreground and -background colors, including hover/active.
- Size and color of the bar's bottom line.
- Logo position, size, and link including the link's target.
- Icon position and size of the central navigation.
- Ideally have the user's menu on the right-hand side of the top bar using the user's profile picture.
- Have the search option/bar as the leftmost option in the right content section of the top bar or even allow the search bar to be rendered in the center of the top bar.
**Reference:** This is available in current deployments, see e.g. Nextcloud, Open-Xchange, and XWiki.
### Central navigation
From the top bar, the user can access the central navigation. A menu that gets its contents from the portal, rending the categories and (sub-)applications available to the logged-in user.
When implementing the central navigation into an application there are two options to access the user's data from the portal:
- Frontend-based: Issuing an IFrame-based silent login against the intercom service (ICS) to get a session with the ICS, followed by a request for the JSON containing the user's central navigation contents through the ICS.
- Backend-based: Requesting the JSON using a backend call to the portal providing the user's name and a shared secret.
**Reference:** This is available in current deployments in all applications except for Jitsi, Collabora, and CryptPad.
## Functional administration
While applications usually support technical and functional administration the technical part should be in the responsibility of the operator and is usually done at (re)deployment time. Therefore the administrative tasks within an application should be limited to functional administration.
Example for "technical administration":
- Configuring the SMTP relay for an application to send out emails.
Example of "functional administration":
- Creating and maintaining users and groups.
**Reference:** OpenProject took the approach that all settings pre-defined in the deployment are still rendered in the admin section of OpenProject, but can not be changed.
## Theming
Theming should be controlled with the deployment and affect all components that support branding options.
**Reference:** https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues/27
## Central user profile
The user profile is maintained centrally, therefore the applications should make use of that central data and not allow local editing of the data within the application except for data that is required by the application and cannot be provided by the central IAM.
The data can still be rendered but must not be tampered with in any way within an openDesk application outside of the IAM, as it would either cause inconsistent data within the platform or the changed data being overwritten, which is at least unexpected by the user.
The user's preferred language and theme (light/dark) are also selected in the IAM's portal and the setting should be respected in all applications.
**Reference:** No reference yet.
# Footnotes
^1: For definitions see [GDPR Article 4](https://gdpr.eu/article-4-definitions/).

View File

@@ -18,7 +18,7 @@ following subsection.
The provided diagram shows all relevant openDesk applications on the left and The provided diagram shows all relevant openDesk applications on the left and
their utilized data storages on the right. For more detailed information about each their utilized data storages on the right. For more detailed information about each
application refer to the table show in Section [Details](#details) application refer to the table in [Details](#details).
```mermaid ```mermaid
--- ---
@@ -40,7 +40,7 @@ Intercom-Service,Redis,1
Jitsi,PersistentVolume,1 Jitsi,PersistentVolume,1
Nextcloud,MariaDB,1 Nextcloud,PostgreSQL,1
Nextcloud,S3,1 Nextcloud,S3,1
Nextcloud,Redis,1 Nextcloud,Redis,1
@@ -60,22 +60,24 @@ Open-Xchange,Redis,1
Postfix,PersistentVolume,1 Postfix,PersistentVolume,1
XWiki,MariaDB,1 XWiki,PostgreSQL,1
XWiki,PersistentVolume,1 XWiki,PersistentVolume,1
``` ```
# Details # Details
| Application | Data Storage | Backup | Content | Identifier | Details | | Application | Data Storage | Backup | Content | (Default) Identifier | Details |
| -------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------- | ----------------------------------------------------- | |----------------------|--------------|----------|-----------------------------------------------------------------------------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| **ClamAV** | PVC | No | ClamAV Database | `clamav-database-clamav-simple-0` | `/var/lib/clamav` | | **ClamAV** | PVC | No | ClamAV Database | `clamav-database-clamav-simple-0` | `/var/lib/clamav` |
| **Dovecot** | PVC | Yes | User mail directories (openDesk CE only, openDesk EE uses Dovecot Pro with Object Storage) | `dovecot` | `/srv/mail` | | **Dovecot** | PVC | Yes | openDesk CE only: User mail directories | `dovecot` | `/srv/mail` |
| | S3 | Yes | openDesk EE only: User mail | `dovecot` | `dovecot` |
| | Cassandra | Yes | openDesk EE only: Metadata and ACLs | `dovecot_dictmap`, `dovecot_acl` |
| **Element/Synapse** | PostgreSQL | Yes | Application's main database | `matrix` | | | **Element/Synapse** | PostgreSQL | Yes | Application's main database | `matrix` | |
| | PVC | Yes | Attachments | `media-opendesk-synapse-0` | `/media` | | | PVC | Yes | Attachments | `media-opendesk-synapse-0` | `/media` |
| | | Yes | Sync and state data | `matrix-neodatefix-bot` | `/app/storage` | | | | Yes | Sync and state data | `matrix-neodatefix-bot` | `/app/storage` |
| **Intercom-Service** | Redis | No | Shared session data | | | | **Intercom-Service** | Redis | No | Shared session data | | |
| **Jitsi** | PVC | Optional | Meeting recordings (feature not enabled in openDesk) | `prosody-data-jitsi-prosody-0` | `/config/data` | | **Jitsi** | PVC | Optional | Meeting recordings (feature not enabled in openDesk) | `prosody-data-jitsi-prosody-0` | `/config/data` |
| **Nextcloud** | MariaDB | Yes | Application's main database Meta-Data | `nextcloud` | | | **Nextcloud** | PostgreSQL | Yes | Application's main database Meta-Data | `nextcloud` | |
| | S3 | Yes | The Nextcloud managed user files | `nextcloud` | | | | S3 | Yes | The Nextcloud managed user files | `nextcloud` | |
| | Redis | No | Distributed caching, as well as transactional file locking | | | | | Redis | No | Distributed caching, as well as transactional file locking | | |
| **Nubus** | PostgreSQL | Yes | Main database for Nubus' IdP Keycloak | `keycloak` | | | **Nubus** | PostgreSQL | Yes | Main database for Nubus' IdP Keycloak | `keycloak` | |
@@ -88,7 +90,7 @@ XWiki,PersistentVolume,1
| | | Yes | openLDAP process data | `shared-run-ums-ldap-server-primary-0` | `/var/run/slapd` | | | | Yes | openLDAP process data | `shared-run-ums-ldap-server-primary-0` | `/var/run/slapd` |
| | | No | openLDAP database (secondary R/O Pods), secondaries can sync from the primary | `shared-data-ums-ldap-server-secondary-0` | `/var/lib/univention-ldap` | | | | No | openLDAP database (secondary R/O Pods), secondaries can sync from the primary | `shared-data-ums-ldap-server-secondary-0` | `/var/lib/univention-ldap` |
| | | No | openLDAP process data | `shared-run-ums-ldap-server-secondary-0` | `/var/run/slapd` | | | | No | openLDAP process data | `shared-run-ums-ldap-server-secondary-0` | `/var/run/slapd` |
| | | Yes | The state of the listener | `data-ums-provisioning-listener-0` | `/var/log/univention` and two others | | | | Yes | The state of the listener | `data-ums-provisioning-udm-listener-0` | `/var/log/univention`<br>`/var/lib/univention-ldap/schema/id`<br>`/var/lib/univention-directory-listener` |
| | | No | Cache | `group-membership-cache-ums-portal-consumer-0` | `/usr/share/univention-group-membership-cache/caches` | | | | No | Cache | `group-membership-cache-ums-portal-consumer-0` | `/usr/share/univention-group-membership-cache/caches` |
| | | Yes | Queued provisioning objects | `nats-data-ums-provisioning-nats-0` | `/data` | | | | Yes | Queued provisioning objects | `nats-data-ums-provisioning-nats-0` | `/data` |
| | Memcached | No | Cache for UMC Server | | | | | Memcached | No | Cache for UMC Server | | |
@@ -100,18 +102,22 @@ XWiki,PersistentVolume,1
| **Open-Xchange** | MariaDB | Yes | Application's control database to coordiate dynamically created ones | `configdb` | | | **Open-Xchange** | MariaDB | Yes | Application's control database to coordiate dynamically created ones | `configdb` | |
| | | Yes | Dynamically creates databases of schema `PRIMARYDB_n`containing multiple contexts | `PRIMARYDB_*` | | | | | Yes | Dynamically creates databases of schema `PRIMARYDB_n`containing multiple contexts | `PRIMARYDB_*` | |
| | | Yes | OX Guard related settings | `oxguard*` | | | | | Yes | OX Guard related settings | `oxguard*` | |
| | S3 | Yes | Attachments of meetings, contacts and tasks | `openxchange` | |
| | Redis | Optional | Cache, session related data, distributed maps | | | | | Redis | Optional | Cache, session related data, distributed maps | | |
| | PVC | Yes | OX-Connector: OXAPI access details | `ox-connector-appcenter-ox-connector-0` | `/var/lib/univention-appcenter/apps/ox-connector` | | | PVC | Yes | OX Connector: OXAPI access details | `ox-connector-appcenter-ox-connector-0` | `/var/lib/univention-appcenter/apps/ox-connector` |
| | | Yes | OX-Connector: Application's meta data | `ox-connector-ox-contexts-ox-connector-0` | `/etc/ox-secrets` | | | | Yes | OX Connector: Application's meta data | `ox-connector-ox-contexts-ox-connector-0` | `/etc/ox-secrets` |
| **Postfix** | PVC | Yes | Mail spool | `postfix` | `/var/spool/postfix` | | **Postfix** | PVC | Yes | Mail spool | `postfix` | `/var/spool/postfix` |
| **XWiki** | Database | Yes | Application's main database | `xwiki` | | | **XWiki** | PostgreSQL | Yes | Application's main database | `xwiki` | |
| | PVC | Yes | Attachments | `xwiki-data-xwiki-0` | `/usr/local/xwiki/data` | | | PVC | Yes | Attachments | `xwiki-data-xwiki-0` | `/usr/local/xwiki/data` |
Additionally, the following persistent volumes are mounted by pods that serve as a data storage for the applications mentioned above. Additionally, the following persistent volumes are mounted by Pods that serve as a data storage for the applications mentioned above.
| Service | Pod | Volume Name | PVC | MountPath | These services are not ment for production use, so you can ignore these as you surely backup your production services instead.
| ---------- | ---------------- | ------------ | --------------------------- | --------------------- |
| MariaDB | `mariadb-*` | `data` | `data-mariadb-0` | `/var/lib/mysql` | | Service | Pod | Volume Name | PVC | MountPath | Comment |
| MinIO | `minio-*-*` | `data` | `minio` | `/bitnami/minio/data` | |------------|------------------|--------------|-----------------------------|-----------------------|------------------|
| PostgreSQL | `postgresql-*` | `data` | `data-postgresql-0` | `/mnt/postgresql` | | MariaDB | `mariadb-*` | `data` | `data-mariadb-0` | `/var/lib/mysql` | |
| Redis | `redis-master-*` | `redis-data` | `redis-data-redis-master-0` | `/data` | | MinIO | `minio-*-*` | `data` | `minio` | `/bitnami/minio/data` | |
| PostgreSQL | `postgresql-*` | `data` | `data-postgresql-0` | `/mnt/postgresql` | |
| Redis | `redis-master-*` | `redis-data` | `redis-data-redis-master-0` | `/data` | |
| Cassandra | `cassandra-*` | `data` | `data-cassandra-*` | `/bitnami/cassandra` | openDesk EE only |

View File

@@ -24,7 +24,7 @@ SPDX-License-Identifier: Apache-2.0
# Disclaimer # Disclaimer
This document collects information on how to deal with debugging an openDesk deployment. This document collects information on how to go about debugging an openDesk deployment.
It will be extended over time as we deal with debugging cases. It will be extended over time as we deal with debugging cases.
@@ -38,7 +38,7 @@ environments, you should use them thoughtfully and carefully if needed.
# Enable debugging # Enable debugging
Check the openDesk [`debug.yaml.gotmpl`](../helmfile/environments/default/debug.yaml.gotmpl) and set for your deployment Check the openDesk [`debug.yaml.gotmpl`](../helmfile/environments/default/debug.yaml.gotmpl) and configure it for your deployment
``` ```
debug: debug:
enabled: true enabled: true
@@ -47,13 +47,13 @@ debug:
This will result in: This will result in:
- setting most component's log level to debug - setting most component's log level to debug
- making the Keycloak admin console available by default at `https://id.<your_domain>/admin/` - making the Keycloak admin console available by default at `https://id.<your_domain>/admin/`
- configured the ingress for `http://minio-console.<your_domain>` - ingress for `http://minio-console.<your_domain>` being configured
> **Note**<br> > **Note**<br>
> When enabling debug mode and updating your deployment, you must manually delete all jobs before updating. In debug mode, we keep the jobs, and some job fields are immutable, leading to a deployment failure. > When enabling debug mode and updating your deployment, you must manually delete all jobs before updating. In debug mode, we keep the jobs, and some job fields are immutable, leading to a deployment failure.
> **Note**<br> > **Note**<br>
> All containers should write their log output to STDOUT; if you find (valuable) logs inside a container, please let us know! > All containers should write their log output to STDOUT; if you find (valuable) logs inside a container which were not in STDOUT, please let us know!
# Adding containers to a pod for debugging purposes # Adding containers to a pod for debugging purposes
@@ -63,13 +63,13 @@ This can be a challenge the more security-hardened the container images are beca
Adding a container to a Pod can ease the pain. Adding a container to a Pod can ease the pain.
Below are some wrap-up notes on debugging openDesk by adding debug containers. Of course, there are many more detailed resources out there. Below are some brief notes on debugging openDesk by adding debug containers. Of course, there are many more detailed resources out there.
## Adding a container to a pod/deployment - Dev/Test only ## Adding a container to a pod/deployment - Dev/Test only
You can add a container by editing and updating an existing deployment, which is quite comfortable with tools like [Lens](https://k8slens.dev/). You can add a container by editing and updating an existing deployment, which is quite comfortable with tools like [Lens](https://k8slens.dev/).
- Select the container you want to make use of as a debugging container; in the example below, it is `registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest`. - Select the container you want to use as a debugging container; in the example below, it is `registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest`.
- Ensure the `shareProcessNamespace` option is enabled for the Pod. - Ensure the `shareProcessNamespace` option is enabled for the Pod.
- Reference the selected container within the `containers` array of the deployment. - Reference the selected container within the `containers` array of the deployment.
- If you want to access another container's filesystem, ensure both containers' user/group settings match. - If you want to access another container's filesystem, ensure both containers' user/group settings match.
@@ -98,29 +98,29 @@ The following example can be used to debug the `openDesk-Nextcloud-PHP` containe
``` ```
- After the deployment has been reloaded, open the shell of the debugging container. - After the deployment has been reloaded, open the shell of the debugging container.
- When you've succeeded, you will see the processes of both/all containers in the Pod when doing a `ps aux`. - When you've succeeded, you will see the processes of both/all containers in the Pod when executing `ps aux`.
- To access other containers' filesystems, select the PID of a process from the other container and do a `cd /proc/<selected_process_id>/root`. - To access other containers' filesystems, select the PID of a process from the other container and do a `cd /proc/<selected_process_id>/root`.
## Temporary/ephemeral containers ## Temporary/ephemeral containers
An interesting read we picked most of the details below from: https://iximiuz.com/en/posts/kubernetes-ephemeral-containers/ An interesting read from which we picked most of the details below from: https://iximiuz.com/en/posts/kubernetes-ephemeral-containers/
Sometimes, you do not want to add a container permanently to your existing deployment. In that case, you could use [ephemeral containers](https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/). Sometimes, you do not want to add a container permanently to your existing deployment. In that case, you could use [ephemeral containers](https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/).
For the commands further down this section, we set some environment variables first: For the commands further down this section, we need to set some environment variables first:
- `NAMESPACE`: The namespace in which the Pod you want to inspect is running. - `NAMESPACE`: The namespace in which the Pod you want to inspect is running.
- `DEPLOYMENT_NAME`: The deployment's name responsible for spawning the Pod you want to inspect within the pre-mentioned namespace. - `DEPLOYMENT_NAME`: The deployment's name responsible for spawning the Pod you want to inspect within the aforementioned namespace.
- `POD_NAME`: The name of the Pod you want to inspect within the pre-mentioned namespace. - `POD_NAME`: The name of the Pod you want to inspect within the aforementioned namespace.
- `EPH_CONTAINER_NAME`: Choose the name for the container, and "debugging" seems obvious. - `EPH_CONTAINER_NAME`: The name of your debugging container, "debugging" seems obvious.
- `DEBUG_IMAGE`: The image you want to use for debugging purposes. - `DEBUG_IMAGE`: The image you want to use for debugging purposes.
e.g. e.g.
```shell ```shell
export EPH_CONTAINER_NAME=debugging
export NAMESPACE=my_test_deployment export NAMESPACE=my_test_deployment
export DEPLOYMENT_NAME=opendesk-nextcloud-php export DEPLOYMENT_NAME=opendesk-nextcloud-php
export POD_NAME=opendesk-nextcloud-php-6686d47cfb-7642f export POD_NAME=opendesk-nextcloud-php-6686d47cfb-7642f
export EPH_CONTAINER_NAME=debugging
export DEBUG_IMAGE=registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest export DEBUG_IMAGE=registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest
``` ```
@@ -147,7 +147,7 @@ kubectl -n ${NAMESPACE} attach -it -c ${EPH_CONTAINER_NAME} ${POD_NAME}
## Helmfile ## Helmfile
When refactoring the Helmfile structure you want to ensure that there are not unintended mistakes by e.g. `diff` When refactoring the Helmfile structure, you want to ensure that there are no unintended edits by executing e.g. `diff` and
comparing the output of Helmfile from before and after the change by calling: comparing the output of Helmfile from before and after the change by calling:
```shell ```shell
@@ -156,9 +156,9 @@ helmfile template -e dev >output_to_compare.yaml
## MariaDB ## MariaDB
When using the openDesk bundled MariaDB, you can explore the database(s) using the MariaDB interactive terminal from the Pod's command line: `mariadb -u root -p`. On the password prompt, provide the value for `MARIADB_ROOT_PASSWORD` found in the Pod's environment. When using the openDesk bundled MariaDB, you can explore the database(s) using the MariaDB interactive terminal from the Pod's command line: `mariadb -u root -p`. On the password prompt, provide the value for `MARIADB_ROOT_PASSWORD` which can be found in the Pod's environment.
While you will find all the details for the CLI tool in [the online documentation](https://mariadb.com/kb/en/mariadb-command-line-client/), some quick commands are: While you will find all the details for the CLI tool in the [MariaDB documentation](https://mariadb.com/kb/en/mariadb-command-line-client/), some commonly used commands are:
- `help`: Get help on the psql command set - `help`: Get help on the psql command set
- `show databases`: Lists all databases - `show databases`: Lists all databases
@@ -190,7 +190,7 @@ end
Using the openDesk bundled PostgreSQL, you can explore database(s) using the PostgreSQL interactive terminal from the Pod's command line: `psql -U postgres`. Using the openDesk bundled PostgreSQL, you can explore database(s) using the PostgreSQL interactive terminal from the Pod's command line: `psql -U postgres`.
While you will find all details in the [psql subsection](https://www.postgresql.org/docs/current/app-psql.html)) of the PostgreSQL documentation, some quick commands are: While you will find all details about the cli tool `psql` in the [PostgreSQL documentation](https://www.postgresql.org/docs/current/app-psql.html)), some commonly used commands are:
- `\?`: Get help on the psql command set - `\?`: Get help on the psql command set
- `\l`: Lists all databases - `\l`: Lists all databases
@@ -202,10 +202,9 @@ While you will find all details in the [psql subsection](https://www.postgresql.
### Setting the log level ### Setting the log level
Keycloak is the gateway to integrate other authentication management systems or applications. It can be desired to Keycloak is the gateway to integrate other authentication management systems or applications. It is undesirable to enable debug mode for the whole platform if you just need to look into Keycloak.
avoid enabling debug mode for the whole platform when you just need to look into Keycloak.
That can easily be achieved in two steps: Enabling debugging mode for Keycloak can easily be achieved in two steps:
1. Updating the value for `KC_LOG_LEVEL` in the related configmap `ums-keycloak`. 1. Updating the value for `KC_LOG_LEVEL` in the related configmap `ums-keycloak`.
```shell ```shell
@@ -217,7 +216,7 @@ kubectl patch -n ${NAMESPACE} configmap ${CONFIGMAP_NAME} --type merge -p '{"dat
2. Restart the Keycloak Pod(s). 2. Restart the Keycloak Pod(s).
> **Note**<br> > **Note**<br>
> As the `ums-keycloak-extensions-handler` is performing frequent (one per second) requests to Keycloak for retrieval of the Keycloak event history, you might want to stop/remove the deployment while debugging/analysing Keycloak to not get your debug output spammed by these requests. > Because the `ums-keycloak-extensions-handler` is sending frequent requests (one per second) to Keycloak for retrieval of the Keycloak event history, you might want to stop/remove the deployment while debugging/analysing Keycloak to not get your debug output spammed by these requests.
### Accessing the Keycloak admin console ### Accessing the Keycloak admin console

View File

@@ -16,7 +16,7 @@ This page covers openDesk deployment automation via Gitlab CI.
The project includes a `.gitlab-ci.yml` that allows you to execute the deployment from a GitLab instance of your choice. The project includes a `.gitlab-ci.yml` that allows you to execute the deployment from a GitLab instance of your choice.
When starting the pipeline through the GitLab UI, you will be queried for some variables plus the following ones: When starting the pipeline through the GitLab UI, you will be queried for some variables, including the following:
- `DOMAIN`: The primary domain for your deployment, making the openDesk services available, e.g., as `https://portal.DOMAIN`. - `DOMAIN`: The primary domain for your deployment, making the openDesk services available, e.g., as `https://portal.DOMAIN`.
- `MAIL_DOMAIN` (optional): The domain for the users' email addresses; it defaults to `DOMAIN`. - `MAIL_DOMAIN` (optional): The domain for the users' email addresses; it defaults to `DOMAIN`.
@@ -24,7 +24,7 @@ When starting the pipeline through the GitLab UI, you will be queried for some v
- `NAMESPACE`: Namespace of your K8s cluster openDesk will be installed. - `NAMESPACE`: Namespace of your K8s cluster openDesk will be installed.
- `MASTER_PASSWORD_WEB_VAR`: Overwrites value of `MASTER_PASSWORD`. - `MASTER_PASSWORD_WEB_VAR`: Overwrites value of `MASTER_PASSWORD`.
You might want to set credential variables in the GitLab project at `Settings` > `CI/CD` > `Variables`. You might want to set credential variables in the GitLab project at `Settings` > `CI/CD` > `Variables`, the values of which can then be hidden from output logs.
# Tests # Tests
@@ -32,8 +32,8 @@ The GitLab CI pipeline contains a job named `run-tests` that can trigger a test
For the trigger to work, the variable `TESTS_PROJECT_URL` has to be set on this GitLab project's CI variables, For the trigger to work, the variable `TESTS_PROJECT_URL` has to be set on this GitLab project's CI variables,
which can be found at `Settings` -> `CI/CD` -> `Variables`. The variable should have this format: which can be found at `Settings` -> `CI/CD` -> `Variables`. The variable should have this format:
`<domain of gitlab>/api/v4/projects/<id>`. `<domain of gitlab>/api/v4/projects/<id>`.
To select the current test set, use the variable `TESTS_TESTSET`. Default: `Smoke`. To select the current test suite, use the variable `TESTS_TESTSET`. Default: `Smoke`.
If the branch of the test pipeline is not `main`, this can be set with the `.gitlab-ci.yml` variable If the branch of the test pipeline is not `main`, this can be set with the `.gitlab-ci.yml` variable
`TESTS_BRANCH` while creating a new pipeline. `TESTS_BRANCH` while creating a new pipeline.
The variable `testprofile` within the job is set to `Namespace`, which tells the e2e tests to use environment-specific settings that will be read from the cluster and namespace-specific file to be found in the project internal `opendesk-env` repository. The variable `testprofile` within the job is set to `Namespace`, which tells the e2e tests to use environment-specific settings that will be read from the cluster and namespace-specific file which is found in the project internal `opendesk-env` repository.

View File

@@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0
<h1>Developing openDesk deployment automation</h1> <h1>Developing openDesk deployment automation</h1>
Active development on the deployment is currently only available for project members. Active development on the deployment is currently only available to project members.
However, contributions are possible using the [CLA](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md?ref_type=heads) process. However, contributions are possible using the [CLA](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md?ref_type=heads) process.
<!-- TOC --> <!-- TOC -->
@@ -30,7 +30,7 @@ developing the openDesk platform.
```mermaid ```mermaid
flowchart TD flowchart TD
J[helmfile.yaml.gotmpl\nor a helmfile outside of this repository]-->A J[helmfile.yaml.gotmpl\nor a helmfile outside of this repository]-->A
J-->K[./helmfile/environemnts/*your_environment*/values.yaml.gotmpl\nor any an environment values file] J-->K[./helmfile/environemnts/*your_environment*/values.yaml.gotmpl\nor another environment values file]
A[./helmfile_generic.yaml.gotmpl]-->B[./helmfile/apps/*all_configured_apps*/helmfile.yaml.gotmpl\nReferences the relevant app Helm\ncharts using details from 'charts.yaml.gotmpl'] A[./helmfile_generic.yaml.gotmpl]-->B[./helmfile/apps/*all_configured_apps*/helmfile.yaml.gotmpl\nReferences the relevant app Helm\ncharts using details from 'charts.yaml.gotmpl']
B-->C[./values-*all_configured_components*.yaml.gotmpl\nValues to template the charts\nwith references to the `images.yaml.gotmpl`] B-->C[./values-*all_configured_components*.yaml.gotmpl\nValues to template the charts\nwith references to the `images.yaml.gotmpl`]
A-->D[./helmfile/environments/default/*\nwith just some examples below] A-->D[./helmfile/environments/default/*\nwith just some examples below]
@@ -57,37 +57,32 @@ Before you investigate any app-specific configuration, it is recommended that yo
# Default branch, `develop` and other branches # Default branch, `develop` and other branches
The `main` branch is configured to be the default branch, as visitors of the project on Open CoDE should see that The `main` branch is configured to be the default branch, as visitors to the project on openCode should see that
branch by default. branch by default.
Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./workflow.md) Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./docs/developer/workflow.md)
for more details on naming conventions. for more details on naming conventions.
There is a CI bot that automatically creates a merge request once you initially push your branch to Open CoDE.
Of course, the merge request will target the `develop` branch, be in status `draft`, and you are set as the assignee.
If you do not plan to merge from the branch you have pushed, please close the auto-created MR.
# External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl` # External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`
The `charts.yaml.gotmpl` and `images.yaml.gotmpl` files are the central place to reference external artifacts used for the deployment. The `charts.yaml.gotmpl` and `images.yaml.gotmpl` files are the central place to reference any external artifacts used for the deployment.
Besides the deployment automation itself, some tools work with the contents of the files: Besides the deployment automation itself, some tools work with the contents of the files:
- **Linting**: Ensures consistency of the file contents for the other tools. - **Linting**: Ensures consistency of the file contents for the other tools.
- **Renovate**: Automatically create MRs that update the components to their latest version. - **Renovate**: Automatically create MRs that update the components to their latest version.
- **Mirror**: Mirror artifacts to Open CoDE. - **Mirror**: Mirror artifacts to openCode.
Please find details on these tools below. Please find details on these tools below.
## Linting ## Linting
In the project's CI, there is a step dedicated to lint the two yaml files, as we want them to be in In the project's CI, there is a step dedicated to lint the two yaml files, as we want them to be in
- alphabetical order regarding the components and - alphabetical order regarding the components
- in a logical order regarding the non-commented lines (registry > repository > tag). - logical order regarding the non-commented lines (registry > repository > tag).
In the linting step, the [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli) is used to apply the In the linting step, the [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli) is used to apply the
just mentioned sorting, and the result is compared with the unsorted version. If there is a delta, the linting fails, and you can fix it by running the CLI tool locally, verifying and applying the result to your branch. aforementioned sorting, and the result is compared with the unsorted version. If there is a delta, the linting fails, and you can fix it by running the CLI tool locally, verifying and applying the result to your branch.
> **Note**<br> > **Note**<br>
> Please ensure that in component blocks, you use comments only at the beginning of the block or at its end. Ideally, you stick > Please ensure that in component blocks, you use comments only at the beginning of the block or at its end. Ideally, you stick
@@ -134,17 +129,17 @@ Checks for newer versions of the given artifact and creates an MR containing the
> **Note:**<br> > **Note:**<br>
> The mirror is scheduled to run every hour at 42 minutes past the hour. > The mirror is scheduled to run every hour at 42 minutes past the hour.
openDesk strives to make all relevant artifacts available on Open CoDE so there is a mirroring process openDesk strives to make all relevant artifacts available on openCode so there is a mirroring process
configured to pull artifacts that do not originate from Open CoDE into projects called `*-Mirror` within the configured to pull artifacts that do not originate from openCode into projects called `*-Mirror` within the
[openDesk Components section](https://gitlab.opencode.de/bmi/opendesk/components). [openDesk Components section](https://gitlab.opencode.de/bmi/opendesk/components).
The mirror script takes the information on what artifacts to mirror from the annotation inside the two yaml files: The mirror script takes the information on what artifacts to mirror from the annotation inside the two yaml files:
- `# upstreamRegistry` *required*: To identify the source registry - `# upstreamRegistry` *required*: To identify the source registry
- `# upstreamRegistryCredentialId`: *optional*: In case the source registry is not public, the access credentials have to be specified as ENV variables containing the value of this key in their name, so you want to specify that key all uppercase: - `# upstreamRegistryCredentialId`: *optional*: In case the source registry is not public, the access credentials have to be specified as environment variables and contain the value of this key in their name, so you want to specify the key in uppercase:
  - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_USERNAME` - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_USERNAME`
  - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_PASSWORD` - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_PASSWORD`
- `# upstreamRepository` *required*: To identify the source repository - `# upstreamRepository` *required*: To identify the source repository
- `# upstreamMirrorTagFilterRegEx` *required*: If this annotation is set, the mirror for the component will be activated. Only tags that match the given regular expression are being mirrored. **Note:** You must use single quotes for this attribute's value if you use backslash leading regex notation like `\d`. - `# upstreamMirrorTagFilterRegEx` *required*: If this annotation is set, the mirror for the component will be activated. Only tags that match the given regular expression will be mirrored. **Note:** You must use single quotes for this attribute's value if you use backslash leading regex notation like `\d`.
- `# upstreamMirrorStartFrom` *optional*: Array of numeric values in case you want to mirror only artifacts beginning with a specific version. You must use capturing group - `# upstreamMirrorStartFrom` *optional*: Array of numeric values in case you want to mirror only artifacts beginning with a specific version. You must use capturing group
in `# upstreamMirrorTagFilterRegEx` to identify the single numeric elements of the version within the tag and use per capturing group (left to right) one numeric array in `# upstreamMirrorTagFilterRegEx` to identify the single numeric elements of the version within the tag and use per capturing group (left to right) one numeric array
element here to define the version the mirror should start with. element here to define the version the mirror should start with.
@@ -163,4 +158,4 @@ for Helm charts.
You may also want to make use of our [standard CI](https://gitlab.opencode.de/bmi/opendesk/tooling/gitlab-config) to You may also want to make use of our [standard CI](https://gitlab.opencode.de/bmi/opendesk/tooling/gitlab-config) to
quickly get Helm charts and container images that are signed, linted, scanned, and released. quickly get Helm charts and container images that are signed, linted, scanned, and released.
Check out the `.gitlab-ci.yaml` files in the project's [Charts](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts) or [Images](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images) to get an idea how little you need to do yourself. Check out the `.gitlab-ci.yaml` files in the project's [Charts](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts) or [Images](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images) to get an idea just how little you need to do by yourself.

View File

@@ -34,29 +34,29 @@ SPDX-License-Identifier: Apache-2.0
# Scope # Scope
This document covers the development of a technical release, thereby addressing This document covers the development of a technical release, thereby addressing:
- the development and branching concept for the openDesk deployment automation, - the development and branching concept for the openDesk deployment automation
- the related quality gates and - the related quality gates
- how technical releases are being created. - the creation of technical releases
It does not cover additional artifacts that might be related to a functional release. It does not cover additional artifacts that might be related to a functional release.
# Roles and responsibilities # Roles and responsibilities
The following section should provide a high-level view of the involved parties in the openDesk context and their responsibilities: The following section provides a high-level view of the involved parties in the openDesk context and their responsibilities:
- **Open source product suppliers** - **Open source product suppliers**
- Focus areas - Focus areas
- Development of upstream products - Development of upstream products
- Development of integrative functionality relevant to openDesk and others - Development of integrative functionality relevant to openDesk and others
- Providing source code and the artifacts required to install openDesk to Open CoDE - Providing source code and the artifacts required to install openDesk to openCode
- Hand over to _openDesk platform development_ - Hand over to _openDesk platform development_
- Helm charts - Helm charts
- Container images - Container images
- Documentation - Documentation
- **openDesk platform development** - **openDesk platform development**
- Focus areas - Focus areas
- Integration of the supplier's artifacts addressing basic operational needs - Integration of the supplier's artifacts, addressing basic operational needs
- Implementation of services required (e.g. persistence layer) to develop and test openDesk - Implementation of services required (e.g. persistence layer) to develop and test openDesk
- Implementation of the required quality gates (QG) - Implementation of the required quality gates (QG)
- Ensuring the quality gates are passed - Ensuring the quality gates are passed
@@ -64,26 +64,26 @@ The following section should provide a high-level view of the involved parties i
- Deployment automation - Deployment automation
- **Operator** - **Operator**
- Focus areas - Focus areas
- Providing production-grade required services (e.g. persistence layer) to operate openDesk - Provide production-grade services (e.g. persistence layer) to operate openDesk
- Rollout, operate and support openDesk - Rollout, operate, and support openDesk
- Further develop the deployment automation to meet extended operational requirements, ideally providing these developments upstream to openDesk platform development to adopt them into the standard - Further develop the deployment automation to meet extended operational requirements, ideally providing these developments upstream to the openDesk platform development in order to have them included as standard in the future.
- The operator can either use a self-operated Kubernetes cluster to deploy openDesk or make use of managed Kubernetes offerings of a **Cloud Provider**. - The operator can either use a self-operated Kubernetes cluster to deploy openDesk or make use of a managed Kubernetes offering from a **Cloud Provider**
# Deployment automation # Deployment automation
The openDesk deployment automation is the core outcome of the platform development process. The openDesk deployment automation is the core outcome of the platform development process.
The openDesk platform development team created and maintains the deployment automation to allow interested parties to deploy openDesk into their cloud infrastructure with a low entry barrier. The core technology for the automation is [Helm](https://helm.sh/), which is orchestrated using [Helmfile](https://github.com/helmfile/helmfile). Of course, this deployment is also used by the suppliers and the platform team in everyday work. The openDesk platform development team created and maintains the deployment automation, which allows interested parties to deploy openDesk onto their cloud infrastructure with a low barrier to entry. The core technology for the automation is [Helm](https://helm.sh/), which is orchestrated using [Helmfile](https://github.com/helmfile/helmfile). Of course, this deployment is also used by the suppliers and the platform team in everyday work.
Please find the deployment automation, including its documentation, in the following project: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk Please find the deployment automation, including its documentation, in the following project: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk
The automation supports Gitlab CI/CD and local execution, triggering the Helmfile deployment for the whole platform or single applications. The automation supports Gitlab CI/CD, local execution, and triggering the Helmfile deployment for the whole platform or single applications.
## openDesk technical component classes ## openDesk technical component classes
The below rendering in class diagram notation shows the three component classes openDesk consists of. In each of these: The below rendering in [class diagram](https://en.wikipedia.org/wiki/Class_diagram) notation shows the three component classes openDesk consists of. In each of these:
- the first section below the name of the class shows the required **characteristics** of each component of the given class and - the first section below the name of the class shows the required **characteristics** of each component of the given class
- the second section shows the **methods** like linting that must be applied to that class's artifacts. - the second section shows the **methods** like linting that must be applied to that class's artifacts
> **Note**<br> > **Note**<br>
> The methods prefixed with '-' are not yet available in `gitlab-config`. You will learn about them later. > The methods prefixed with '-' are not yet available in `gitlab-config`. You will learn about them later.
@@ -119,9 +119,9 @@ classDiagram
## Functional vs. service components ## Functional vs. service components
The focus of openDesk is to provide an integrated functional productivity platform based on the involved suppliers' functional components (products). These functional components usually rely on specific service components, e.g. database services for persistence. When running openDesk in production, the operator is responsible for providing these services in production-grade. For evaluation and development purposes, the openDesk deployment automation includes these services. The focus of openDesk is to provide an integrated and functional productivity platform based on the involved suppliers' functional components (products). These functional components usually rely on specific service components, e.g. database services for persistence. When running openDesk in production, the operator is responsible for providing these production-grade services. For evaluation and development purposes, the openDesk deployment automation includes these services.
Find the list of functional and service components in the [deployment automation's components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/blob/main/docs/components.md). Find the list of functional and service components in the [archictecture documentation](./docs/architecture.md).
## Origins ## Origins
@@ -129,7 +129,7 @@ The openDesk platform consolidates the technical components from various origins
1) *Supplier* for functional components: Provide their upstream product, sometimes including openDesk-specific builds or extensions and product deployment (Helm charts). 1) *Supplier* for functional components: Provide their upstream product, sometimes including openDesk-specific builds or extensions and product deployment (Helm charts).
2) *Third-party upstream* for service components: The platform development team tries to use as many community upstream components as possible for the services they have to provide within openDesk. 2) *Third-party upstream* for service components: The platform development team tries to use as many community upstream components as possible for the services they have to provide within openDesk.
3) Platform development* filling the gap: Some suppliers might not provide Helm charts or images for their products that fit the needs of openDesk, and some third-party upstream components are not built to fit into openDesk. In these cases, the platform development team creates its own Helm charts and images. 3) *Platform development* filling the gap: Some suppliers might not provide Helm charts or images for their products that fit the needs of openDesk, and some third-party upstream components are not built to fit into openDesk. In such cases, the platform development team creates its own Helm charts and images.
## Reference CI for creating Images and Helm charts (gitlab-config) ## Reference CI for creating Images and Helm charts (gitlab-config)
@@ -139,28 +139,28 @@ For that purpose openDesk provides a [GitLab CI-based reference implementation](
## Licensing ## Licensing
As a standard, the openDesk platform development team uses [reuse.software](https://reuse.software/) wherever possible to annotate license and copyright. As a standard, the openDesk platform development team uses [reuse.software](https://reuse.software/) wherever possible to annotate license and copyright information.
openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this: openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this:
``` ```
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
``` ```
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace). The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk).
> **Note**<br> > **Note**<br>
> If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with an past year (e.g. 2024), please update this copyright header line to cover (up to and including) the current year, e.g. `2024-2025`. > If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with a past year (e.g. 2024), please update this copyright header line to cover (up to and including) the current year, e.g. `2024-2025`.
> **Note**<br> > **Note**<br>
> If line(s) with `SPDX-FileCopyrightText` containing a different copyright owner exist in the file you are working on, do not replace existing one(s) but add an additional header above these. > If line(s) with `SPDX-FileCopyrightText` containing a different copyright owner exist in the file you are working on, do not replace existing one(s), but rather add another header above these.
## Development workflow ## Development workflow
### Disclaimer ### Disclaimer
openDesk consists only of community products, so there is no SLA to receive service updates or backport of critical security fixes. This has two consequences: openDesk consists only of community products, so there is no SLA related to service updates or backport of critical security fixes. This has two consequences:
- In production scenarios, you should replace the community versions of the functional components with supported, SLA-backed paid versions. - In production scenarios, you should replace the community versions of the functional components with supported, SLA-backed paid versions.
- openDesk aims to update the community components' latest available releases continually; therefore, we have rolling technical releases. - openDesk aims to update to the community components' latest available releases continually; therefore, we have rolling technical releases.
### Workflow ### Workflow
@@ -171,18 +171,18 @@ This chapter describes the deployment automation's development workflow. The sup
The picture below uses Gitflow notation to give an overview of the different types of development flows. The picture below uses Gitflow notation to give an overview of the different types of development flows.
The basic facts for the flow are: The basic facts for the flow are:
- When the `develop` branch is merged into `main` a technical release is created (except when the merge commit(s) are of type `chore` or `docs`) - When the `develop` branch is merged into `main`, a technical release is created (except when the merge commit(s) are of type `chore` or `docs`).
- Changes that will be applied to openDesk have to branch off from `develop`; we call these branches *feature* branches. - Changes that will be applied to openDesk have to branch off from `develop`; we call these branches *feature* branches.
- Developers can create sub-branches from their feature branch(es) as needed. - Developers can create sub-branches from their feature branch(es) as needed.
- When a *feature* branch gets pushed a Merge Request in `Draft` state is automatically created. - When a *feature* branch gets pushed a Merge Request in `Draft` state is automatically created.
- We know three types of *feature* branches: - We know three types of *feature* branches:
- `docs`: Doing just documentation changes - `docs`: Includes only documentation changes.
- `fix`: Maintenance of the openDesk software components and minor configurational changes - `fix`: Maintenance of the openDesk software components and minor configurational changes.
- `feat`: All changes that do not fall into the two categories above, especially - `feat`: All changes that do not fall into the two categories above, especially:
- supplier deliverables and - supplier deliverables
- configurational changes that have a significant impact on openDesk users or require migrations[^1] - configuration changes that have a significant impact on openDesk users or require migrations
- The *QG* entries in the workflow refer to quality gates that are explained in more detail later - The *QG* entries in the workflow refer to quality gates that are explained in more detail later.
- All merges into `develop` or `main` require two approvals from the platform development team[^2]. The approvers must ensure that the defined quality gates have been passed successfully. - All merges into `develop` or `main` require two approvals from the platform development team[^1]. Those approving must ensure that the defined quality gates have been successfully passed.
```mermaid ```mermaid
gitGraph gitGraph
@@ -238,25 +238,25 @@ The Standard Quality Gate addresses quality assurance steps that should be execu
1. Linting 1. Linting
- Blocking - Blocking
- Licensing: [reuse](https://github.com/fsfe/reuse-tool) - Licensing: [reuse](https://github.com/fsfe/reuse-tool)
- openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./development.md). - openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./docs/developer/development.md).
- Non-Blocking - Non-Blocking
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements - Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
- Formal: Yaml - Formal: Yaml
1. Deploy the full openDesk stack from scratch: 2. Deploy the full openDesk stack from scratch:
- All deployment steps must be successful (green) - All deployment steps must be successful (green)
- All tests from the end-to-end test set must be successful - All tests from the end-to-end test set must be successful
1. Update deployment[^3] of the full openDesk stack and apply the quality measures from the step #1: 3. Update deployment of the full openDesk stack and apply the quality measures from the step #1:
- Deploy the current merge target baseline (`develop` or `main`) - Deploy the current merge target baseline (`develop` or `main`)
- Update deploy from your QA branch into the instance from the previous step - Update deploy from your QA branch into the instance from the previous step
1. No showstopper found regarding 4. No showstopper found regarding:
- SBOM compliance[^4] - SBOM compliance[^2]
- Malware check - Malware check
- CVE check[^5] - CVE check[^3]
- Kubescape scan[^5] - Kubescape scan[^3]
Steps #1 to #3 from above are executed as GitLab CI and documented within GitLab. Steps #1 to #3 from above are executed as GitLab CI and documented within GitLab.
Step #4 is focused on security and has not been fully implemented yet. Its main objective is to check for regressions. That step is just the second step of a security check and monitoring chain, as shown below. While some checks can be executed against static artifacts (e.g., container images), others might require an up-and-running instance. These are especially located in the third step below, which has not yet been implemented. Step #4 is focused on security and has not been fully implemented yet. Its main objective is to check for regressions. That step is just the second step of a security check and monitoring chain, as shown below. While some checks can be executed against static artifacts (e.g., container images), others might require an up-and-running instance. These are specifically located in the third step below, which has not yet been implemented.
```mermaid ```mermaid
flowchart TD flowchart TD
@@ -278,7 +278,7 @@ flowchart TD
#### Branch workflows #### Branch workflows
This section will explain the workflow for each branch (type) based on the Gitflow picture from above. This section will explain the workflow for each branch type based on the Gitflow picture from above.
##### `main` ##### `main`
@@ -298,7 +298,7 @@ Merge points: We are using the [Semantic Release convention](https://github.com/
- That the SQG was successfully executed upon the to-be merged state - it could be done explicitly or based on a `QA 'nightly develop'` - That the SQG was successfully executed upon the to-be merged state - it could be done explicitly or based on a `QA 'nightly develop'`
- In case of `fix` changes that usually have no test automation, Changes have been verified by a member of the platform development team. - In case of `fix` changes that usually have no test automation, Changes have been verified by a member of the platform development team.
- That the changes have been reviewed by at least two members of the platform development team, giving their approval on the Merge Request. - That the changes have been reviewed by at least two members of the platform development team, giving their approval on the Merge Request.
- Merge points (from `docs`, `fix`, and `feat` branches): No additional activity on these merge points as the QA is ensured before the merge in the just-named branch types. - Merge points (from `docs`, `fix`, and `feat` branches): No additional activity on these merge points as the QA is ensured before the merge in the aforementioned branch types.
##### `docs` ##### `docs`
@@ -355,12 +355,15 @@ Example: `tmueller/fix_jitsi_theming`.
Commit messages must adhere to the [Conventional Commit standard](https://www.conventionalcommits.org/en/v1.0.0/#summary). Commits that do not adhere to the standard get rejected by either [Gitlab push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html) or the CI. Commit messages must adhere to the [Conventional Commit standard](https://www.conventionalcommits.org/en/v1.0.0/#summary). Commits that do not adhere to the standard get rejected by either [Gitlab push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html) or the CI.
> **Note**<br>
> The first letter after the `: ` must be uppercase.
```text ```text
<type>(<scope>): [path/to/issue#1] <short summary>. <type>(<scope>): <Short summary> [path/to/issue#1]
│ │ │ │ │ │ │ │
│ │ | └─> Summary in present tense, sentence case, with no period at the end │ │ | └─> Issue reference (optional)
│ │ | │ │ |
│ │ └─> Issue reference (optional) │ │ └─> Summary in present tense, sentence case, with no period at the end
│ │ │ │
│ └─> Commit Scope: helmfile, docs, collabora, nextcloud, open-xchange, etc. │ └─> Commit Scope: helmfile, docs, collabora, nextcloud, open-xchange, etc.
@@ -370,23 +373,19 @@ Commit messages must adhere to the [Conventional Commit standard](https://www.co
Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.` Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.`
> **Note**<br> > **Note**<br>
> The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) as the release's notes are generated from the messages. > The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/releases) as the release notes are generated from these messages.
#### Verified commits #### Verified commits
We only allow verified commits; please read on about the options you have to make your commits verified: We only allow verified commits; please read on about the options you have to make your commits verified:
- https://docs.gitlab.com/ee/user/project/repository/ssh_signed_commits/ - https://docs.gitlab.com/user/project/repository/signed_commits/ssh/
- https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/ - https://docs.gitlab.com/user/project/repository/signed_commits/gpg/
- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/ - https://docs.gitlab.com/user/project/repository/signed_commits/x509/
# Footnotes # Footnotes
[^1]: Migrations are in general not supported before openDesk hits [technical release](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) v1.0.0 [^1]: These approval rules are not available in the GitLab Free Tier, which is one of the main reasons why deployment automation is not developed on openCode.
[2]: These approval rules are not available in the Gitlab Free Tier, which is one of the main reasons why deployment automation is not developed on Open CoDE. [^2]: The SBOM process is executed asynchronously with the development process and tests the most current technical release from the `main` branch. The process still needs to be fully automated.
[^3]: As long as migrations/upgrade paths are not provided - see also footnote #1 - this step is optional. [^3]: The quality gate needs to be implemented primarily when identifying regressions.
[^4]: The SBOM process is executed asynchronously with the development process and tests the most current technical release from the `main` branch. The process still needs to be fully automated.
[^5]: The quality gate needs to be implemented primarily when identifying regressions.

View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
# Overview # Overview
The following enhanced configuration use cases are described in separate documents. The following enhanced configuration use cases are described in their respective documents:
- [Separate mail & Matrix domain](./enhanced-configuration/separate-mail-matrix-domain.md) - [Separate mail & Matrix domain](./enhanced-configuration/separate-mail-matrix-domain.md)
- [Federation with external identity provider](./enhanced-configuration/idp-federation.md) - [Federation with external identity provider](./enhanced-configuration/idp-federation.md)

View File

@@ -25,7 +25,7 @@ This documentation will use Argo CD to explain how to deploy openDesk GitOps-sty
# ArgoCD # ArgoCD
We are continuously improving our Argo CD support, please share you experience with Argo CD deployments e.g. by [creating We are continuously improving our Argo CD support, please share you experience with Argo CD deployments e.g. by [creating
at ticket](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues). a ticket](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/issues).
There are two options to deploy openDesk via Argo CD described in the following sections. There are two options to deploy openDesk via Argo CD described in the following sections.
@@ -42,19 +42,19 @@ References:
- [Helmfile CLI documentation](https://helmfile.readthedocs.io/en/latest/#cli-reference) - [Helmfile CLI documentation](https://helmfile.readthedocs.io/en/latest/#cli-reference)
- [Generate K8s YAML Manifests for openDesk](https://gitlab.opencode.de/bmi/opendesk/deployment/options/generate-k8s-yaml-manifests) - [Generate K8s YAML Manifests for openDesk](https://gitlab.opencode.de/bmi/opendesk/deployment/options/generate-k8s-yaml-manifests)
Afterwards, you can use the resulting manifests within an standard Argo CD workflow. Afterwards, you can use the resulting manifests within a standard Argo CD workflow.
> **Note**<br> > **Note**<br>
> When creating the Argo CD application based on the resulting manifests you must not use the `Automated Sync Policy` > When creating the Argo CD application based on the resulting manifests, you must not use the `Automated Sync Policy`
> offered by Argo CD, as you have to manually ensure the applications are updated in the required sequence. > offered by Argo CD, as you have to manually ensure the applications are updated in the required sequence.
## Option 2: Helmfile plugin ## Option 2: Helmfile plugin
It is possible to deploy openDesk via Argo CD with community developed It is possible to deploy openDesk via Argo CD with the community developed
[Helmfile plugin](https://github.com/travisghansen/argo-cd-helmfile). [Helmfile plugin](https://github.com/travisghansen/argo-cd-helmfile).
You can find an example for this approach in the You can find an example for this approach in the
[Argo CD Deployments](https://gitlab.opencode.de/bmi/opendesk/deployment/options/argocd-deploy) repository. [Argo CD Deployments](https://gitlab.opencode.de/bmi/opendesk/deployment/options/argocd-deploy) repository.
It contains an example Helm chart (`opendesk-parent`) to create Argo CD Applications via a Helm chart (`opendesk`) It contains an example Helm chart (`opendesk-parent`) to create Argo CD Applications via a Helm chart (`opendesk`)
according to `app of apps pattern` and is using sync waves to ensure to required deployment and update sequence according to `app of apps pattern`. It uses sync waves to ensure the deployment matches requirements and the update sequence
for openDesk is met. for openDesk is satisfied.

View File

@@ -17,15 +17,17 @@ SPDX-License-Identifier: Apache-2.0
* [Add multiple user accounts via CSV file](#add-multiple-user-accounts-via-csv-file) * [Add multiple user accounts via CSV file](#add-multiple-user-accounts-via-csv-file)
* [Start the migration](#start-the-migration) * [Start the migration](#start-the-migration)
* [Monitor migration status](#monitor-migration-status) * [Monitor migration status](#monitor-migration-status)
* [Appendix](#appendix)
* [Validating master authentication](#validating-master-authentication)
<!-- TOC --> <!-- TOC -->
Most organizations already have email accounts on various platforms that need to be migrated to openDesk. This document describes the migration from M365 accounts to openDesk using the [audriga Migration Service](https://www.audriga.com) in combination with the master authentication option in openDesk. Other source platforms are also supported, and their migrations work in a similar manner. Most organizations already have email accounts on various platforms that need to be migrated to openDesk. This document describes the migration from M365 accounts to openDesk using the [audriga Migration Service](https://www.audriga.com) in combination with the master authentication option in openDesk. Other source platforms are also supported, and their migrations work in a similar manner.
The migration can be configured on audriga's self-service website, accessed with most common web browsers (e.g. IE, Firefox, Safari or Chrome). No software needs to be installed on your machine. The service connects to your mailbox similarly to what your email client does. Emails, attachments, folders, and, depending on the source systems, contacts, tasks, notes, and calendar data are being copied to your destination account. See [M365 to OX Migration Guide](https://audriga.com/fileadmin/guides/en/MS365-OX.pdf) for the scope and limitations of the process. The migration can be configured on audriga's self-service website, accessed with most common web browsers (e.g. IE, Firefox, Safari or Chrome). No software needs to be installed on your machine. The service connects to your mailbox similarly to what your email client does. Emails, attachments, folders, and, depending on the source systems, contacts, tasks, notes, and calendar data are copied to your destination account. See [M365 to OX Migration Guide](https://audriga.com/fileadmin/guides/en/MS365-OX.pdf) for the scope and limitations of the process.
The data in the source mailbox will not be deleted or altered. To configure a migration, only three simple steps in audriga's self-service portal have to be completed. After the migration has started, its status can be continuously monitored on the website. The data in the source mailbox will not be deleted or altered. To configure a migration, only three simple steps in audriga's self-service portal have to be completed. After the migration has started, its status can be continuously monitored on the website.
It may not be possible to complete especially large or complex migrations with only this guide. If you identify issues related to I/O, bandwidth, timeline constraints, or anything else that makes the migration more complicated than you feel comfortable handling on your own using the self-service, please get in touch with contact [audriga's support](mailto:support@audriga.com). It may not be possible to complete especially large or complex migrations with only this guide. If you identify issues related to I/O, bandwidth, time constraints, or anything else that makes the migration more complicated than you are comfortable handling on your own using the self-service, please contact [audriga's support](mailto:support@audriga.com).
# Prerequisites # Prerequisites
@@ -33,13 +35,13 @@ It may not be possible to complete especially large or complex migrations with o
The following instructions provide information on how to authenticate Microsoft 365 / Exchange Online accounts in the audriga migration service with "modern authentication" using a service account without the need to provide a username and password for each mailbox that will be migrated. The following instructions provide information on how to authenticate Microsoft 365 / Exchange Online accounts in the audriga migration service with "modern authentication" using a service account without the need to provide a username and password for each mailbox that will be migrated.
You will have to select an existing user account that will be used as a service account for the migration. You have to register the audriga application and create an M365 email group known only to you as described in the following steps: You will have to select an existing user account that will be used as a service account for the migration. You have to register the audriga application and create an M365 email group known only to you, as described in the following steps:
***1. Select one account to serve as a service account*** ***1. Select one account to serve as a service account***
Please note that the account that shall serve as the service account requires a Microsoft 365/Exchange online license (mailbox). Please note that the account that shall serve as the service account requires a Microsoft 365/Exchange online license (mailbox).
> **Notes**<br> > **Note**<br>
> If you want to designate your admin account as a service account, you have to provide the admin with a license. > If you want to designate your admin account as a service account, you have to provide the admin with a license.
***2. Register the audriga app in your tenant*** ***2. Register the audriga app in your tenant***
@@ -49,7 +51,7 @@ To register the audriga app in your tenant, log into your admin account and acce
https://login.microsoftonline.com/organizations/v2.0/adminconsent?client_id=3cd27a72-a19e-4945-9715-fc24d940428f&redirect_uri=https://umzug.audriga.com/SMESwitchWebApp/oauth_complete.jsp&scope=https://outlook.office.com/.default https://login.microsoftonline.com/organizations/v2.0/adminconsent?client_id=3cd27a72-a19e-4945-9715-fc24d940428f&redirect_uri=https://umzug.audriga.com/SMESwitchWebApp/oauth_complete.jsp&scope=https://outlook.office.com/.default
- Accept the App "audriga CloudMovr migration" - Accept the App "audriga CloudMovr migration"
- You will be redirected to an audriga page, which you can close without requiring additional interaction. - You will be redirected to an audriga page, which you can close - it does not require additional interaction.
> **Note**<br> > **Note**<br>
> The audriga application is created under the "Enterprise application" tab in the AzureAD console. > The audriga application is created under the "Enterprise application" tab in the AzureAD console.
@@ -70,25 +72,27 @@ In openDesk, you have to have all user accounts with mailboxes pre-defined befor
## Deploy openDesk with master authentication ## Deploy openDesk with master authentication
With openDesk 1.0 Enterprise, you can set openDesk's email components (OX AppSuite and OX Dovecot) into master authentication mode to run the migration as described in this document using the following two settings for your deployment: With openDesk 1.0 Enterprise, you can set openDesk's email components (OX AppSuite and OX Dovecot) to master authentication mode to run the migration as described in this document using the following two settings for your deployment. This is NOT available in openDesk Community deployments:
``` ```
secrets: secrets:
oxAppSuite: oxAppSuite:
adminPassword: "your_temporary_master_password" migrationsMasterPassword: "your_temporary_master_password"
functional: functional:
migration: migration:
oxAppSuite: oxAppSuite:
enabled: true enabled: true
``` ```
1. You must specify the master password referenced in the document's following sections. 1. You must specify a master password, it will be referenced later in this document.
2. You need to enable the actual master authentication mode. 2. You need to enable the actual master authentication mode.
Updating your deployment with these settings will allow you to continue with the migration scenario. Once the migration is completed, you can remove `secrets.oxAppSuite.adminPassword` and need to turn off the migration mode by setting `functional.migration.oxAppSuite.enabled` to `false` or removing that setting, as `false` is the default before you update your deployment once again. To validate the master authentication mode please read the appendix section at the end of the document.
Updating your deployment with these settings will allow you to continue with the migration scenario. Once the migration is completed, you can remove `secrets.oxAppSuite.migrationsMasterPassword` and need to turn off the migration mode by setting `functional.migration.oxAppSuite.enabled` to `false` or removing that setting, as `false` is the default before you update your deployment once again.
> **Note**<br> > **Note**<br>
> For the changes to take effect, it is sufficient to deploy the `open-xchange` component. > For the changes to take effect, it is sufficient to re-deploy the `open-xchange` component alone. But you have to restart the Dovecot Pod(s) manually when switching to/from the master authentication mode for the changes to take effect.
> **Note**<br> > **Note**<br>
> While in master authentication mode, regular users cannot log in to the webmail module of openDesk or access the mail using IMAP, as it is not recommended that users interact with the target mail infrastructure during the migration scenario described in this document. > While in master authentication mode, regular users cannot log in to the webmail module of openDesk or access the mail using IMAP, as it is not recommended that users interact with the target mail infrastructure during the migration scenario described in this document.
@@ -110,12 +114,12 @@ Configure openDesk as your destination server:
- Select "Configure provider or server" in the provider selection box of the migration application. - Select "Configure provider or server" in the provider selection box of the migration application.
- In the following dialog, select "Open-Xchange" as protocol. - In the following dialog, select "Open-Xchange" as protocol.
- On the tab "IMAP" - On the tab "IMAP"
  - For "Mailserver (host name or IP address)" enter your IMAP host, e.g. "webmail.your-opendesk-domain.tld". - For "Mailserver (host name or IP address)" enter your IMAP host, e.g. "webmail.your-opendesk-domain.tld".
  - If your IMAP server is not running on default port 993, enter your nonstandard IMAP port under Details -> Port. - If your IMAP server is not running on default port 993, enter your nonstandard IMAP port under Details -> Port.
  - Press check. - Press check.
- On the tab "Open-Xchange" - On the tab "Open-Xchange"
  - Set the hostname of your OX AppSuite installation, e.g. "webmail.your-opendesk-domain.tld". - Set the hostname of your OX AppSuite installation, e.g. "webmail.your-opendesk-domain.tld".
  - Press check. - Press check.
- If you receive a green checkmark on both tabs, click "Save". Otherwise, check your settings until you get the green checkmark. - If you receive a green checkmark on both tabs, click "Save". Otherwise, check your settings until you get the green checkmark.
## Adding accounts ## Adding accounts
@@ -142,7 +146,7 @@ Click on check to verify the credentials. If the data is correct, a green checkm
After checking and confirming, you can use the same procedure to add further mailboxes. After checking and confirming, you can use the same procedure to add further mailboxes.
Alternatively, you can add multiple accounts via CSV upload. Find information in the following. Alternatively, you can add multiple accounts via CSV upload. More info on that below.
### Add multiple user accounts via CSV file ### Add multiple user accounts via CSV file
@@ -182,3 +186,39 @@ Click on "Details" to get further information about the migration.
You can access a detailed log for each account by clicking "Protocol" on the right-hand side. Here, you can see detected duplicates or encountered errors (e.g., if emails cannot be transferred due to your provider's size limitations). You can access a detailed log for each account by clicking "Protocol" on the right-hand side. Here, you can see detected duplicates or encountered errors (e.g., if emails cannot be transferred due to your provider's size limitations).
You will receive status emails for the migration job's submission and start, as well as when the migration job is finished. The emails are sent to the email address you have entered during the configuration. Those emails include a link to the status website so you can easily track and monitor your migration. Once the migration has been started, you can safely close the status website and shut down your computer; the migration will continue. You can re-open the status website anytime. You will receive status emails for the migration job's submission and start, as well as when the migration job is finished. The emails are sent to the email address you have entered during the configuration. Those emails include a link to the status website so you can easily track and monitor your migration. Once the migration has been started, you can safely close the status website and shut down your computer; the migration will continue. You can re-open the status website anytime.
# Appendix
## Validating master authentication
Below are details in case you want to verify master authentication for Dovecot and OX AppSuite.
Set a few variables first:
```shell
export MIG_DOMAIN=your-opendesk-domain.tld
export MIG_WEBMAIL_HOST=webmail
export MIG_USERNAME=eva
export MIG_MASTER_PASSWORD=YourMasterPassword
export MIG_IMAP_PORT=31123
```
Ensure that you have defined a (your) default context for the migration where the account (in this example `eva`) can be found. The following should be executed in OX App Suite's `open-xchange-core-mw-default-0` container, in the example we set the default context to `1`:
```shell
/opt/open-xchange/sbin/changecontext -c 1 -L defaultcontext -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW
```
With the preparation from above you should be able to successfully authenticate to both components:
**OX App Suite**
```shell
curl -X POST -d "name=${MIG_USERNAME}&password=${MIG_MASTER_PASSWORD}" "https://${MIG_WEBMAIL_HOST}.${MIG_DOMAIN}/appsuite/api/login?action=login"
```
**Dovecot**
```shell
echo "a001 LOGIN ${MIG_USERNAME} ${MIG_MASTER_PASSWORD}" | openssl s_client -ign_eof -connect ${MIG_DOMAIN}:${MIG_IMAP_PORT}
```

View File

@@ -20,19 +20,21 @@ SPDX-License-Identifier: Apache-2.0
* [openDesk IdP](#opendesk-idp) * [openDesk IdP](#opendesk-idp)
<!-- TOC --> <!-- TOC -->
Most organizations already have an Identity and Access Management (IAM) system with an identity provider (IdP) for single sign-on to internal or external web applications. Most organizations already have an Identity and Access Management (IAM) system with an identity provider (IdP) for single sign-on (SSO) to internal or external web applications.
This document shows how to configure your organization's IdP and the openDesk IdP to support account federation with openDesk single sign-on based on your organization's login. This document helps in setting up your organization's IdP and openDesk to enable IdP federation.
# References # References
We would like to list successful IdP federation scenarios, so we are also happy about input from the community: We would like to list successful IdP federation scenarios:
| External IdP | openDesk versions tested | | External IdP | openDesk versions tested |
|---------------------------------------------------------------------|--------------------------| |---------------------------------------------------------------------|--------------------------|
| [EU Login](https://webgate.ec.europa.eu/cas/userdata/myAccount.cgi) | v0.9.0, v1.2.0 | | [EU Login](https://webgate.ec.europa.eu/cas/userdata/myAccount.cgi) | v0.9.0, v1.2.0 |
| [ProConnect](https://www.proconnect.gouv.fr/) | v0.9.0 | | [ProConnect](https://www.proconnect.gouv.fr/) | v0.9.0 |
> If you have successfully federated using another External IdP, please let us know so we can update the list above.
# Prerequisites # Prerequisites
## User accounts ## User accounts
@@ -58,7 +60,7 @@ In addition to the configuration, it is required that user accounts with the sam
- This feature is currently unavailable in openDesk's Keycloak, but Univention plans to make it available in the future. - This feature is currently unavailable in openDesk's Keycloak, but Univention plans to make it available in the future.
- Ad-hoc provisioning creates a user account on the fly during a user's first login. - Ad-hoc provisioning creates a user account on the fly during a user's first login.
- While ad-hoc provisioning is an excellent approach for a quick start with openDesk, it has various downsides: - While ad-hoc provisioning is an excellent approach for a quick start with openDesk, it has various downsides:
- Users are created after their first login, so you cannot find your colleagues in the openDesk apps unless they have already logged in. - Users are created after their first login, so you cannot find your colleagues in the openDesk apps unless they have already logged in once.
- A user account would never be deactivated or deleted in openDesk. - A user account would never be deactivated or deleted in openDesk.
- Group memberships are not transferred. - Group memberships are not transferred.
@@ -68,9 +70,26 @@ This document focuses on the OIDC federation between an external IdP and the ope
# Example configuration # Example configuration
The following section explains how to configure the IdP federation manually in an example upstream IdP and in openDesk.
With openDesk 1.4.0 IdP federation has to be enabled as part of the deployment using the `functional.authentication.ssoFederation` section, see [`functional.yaml.gotmpl`](../../helmfile/environments/default/functional.yaml.gotmpl) for reference.
You can use the description below to configure and test the federation that can be exported and used as part of the deployment afterwards, e.g. with the following commands from within the Keycloak Pod:
```shell
# Set the variables according to your deployment first, below are just example values.
export FEDERATION_IDP_ALIAS=sso-federation-idp
export NAMESPACE=example_namespace
export CLUSTER_NETWORKING_DOMAIN=svc.cluster.local
# Authenticate with Keycloak
/opt/keycloak/bin/kcadm.sh config credentials --server http://ums-keycloak.${NAMESPACE}.${CLUSTER_NETWORKING_DOMAIN}:8080 --realm master --user ${KEYCLOAK_ADMIN} --password ${KEYCLOAK_ADMIN_PASSWORD}
# Request details of IdP configuration
/opt/keycloak/bin/kcadm.sh get identity-provider/instances/${FEDERATION_IDP_ALIAS} -r opendesk
```
## Versions ## Versions
The example was tested with openDesk v0.7.0 using its integrated Keycloak v24.0.3. As external IdP, we also used an openDesk deployment of the same version but created a separate realm for proper configuration separation. The example was tested with openDesk v0.7.0 using its integrated Keycloak v24.0.3. As external IdP, we also used an openDesk deployment of the same version, but created a separate realm for proper configuration separation.
## Example values ## Example values
@@ -80,12 +99,12 @@ The following values are used in this example documentation. Please ensure when
- `id.opendesk.tld`: hostname for the openDesk IdP, so openDesk is deployed at `opendesk.tld`. - `id.opendesk.tld`: hostname for the openDesk IdP, so openDesk is deployed at `opendesk.tld`.
- `fed-test-idp-realm`: realm name for your organization's IdP. - `fed-test-idp-realm`: realm name for your organization's IdP.
- `opendesk-federation-client`: OIDC client for the openDesk federation defined in your organization's IdP. - `opendesk-federation-client`: OIDC client for the openDesk federation defined in your organization's IdP.
- `auto-federate-idp`: Identifier of your organization IdP's configuration within the openDesk Keycloak. - `sso-federation-idp`: Identifier of your organization IdP's configuration within the openDesk Keycloak.
- `auto-federate-flow`: Identifier of the required additional login flow to be created and referenced in the openDesk Keycloak. - `sso-federation-flow`: Identifier of the required additional login flow to be created and referenced in the openDesk Keycloak.
## Keycloak admin console access ## Keycloak admin console access
To access Keycloak's admin console in an openDesk deployment, you must add a route for `/admin` to the Keycloak's ingress. This is done automatically if you deploy openDesk with `debug.enabled: true`, but beware that this will also cause a lot of log output across all openDesk pods. To access the Keycloak admin console in an openDesk deployment, you must add a route for `/admin` to the Keycloak ingress. This is done automatically if you deploy openDesk with `debug.enabled: true`, but beware that this will also cause a lot of log output across all openDesk pods.
The admin console will be available at: The admin console will be available at:
- Organization's IdP: https://idp.organization.tld/admin/master/console/ - Organization's IdP: https://idp.organization.tld/admin/master/console/
@@ -97,7 +116,7 @@ For the following configuration steps, log in with user `kcadmin` and grab the p
In this example, we use the Keycloak of another openDesk instance to simulate your organization's IdP. However, URL paths differ if you use another product. In this example, we use the Keycloak of another openDesk instance to simulate your organization's IdP. However, URL paths differ if you use another product.
Please let us know about your experiences or differences you came across. Please let us know about your experiences or any differences you encountered.
### Separate realm ### Separate realm
@@ -115,7 +134,7 @@ If you just created the `fed-test-idp-realm`, you are already in the admin scree
- Client create wizard page 1: - Client create wizard page 1:
- *Client type*: `OpenID Connect` - *Client type*: `OpenID Connect`
- *Client-ID*: `opendesk-federation-client` - *Client-ID*: `opendesk-federation-client`
- *Name*: `openDesk @ your organization` (is the descriptive text of the client that might show up in your IdP's UI and therefore should explain what the client is used for) - *Name*: `openDesk @ your organization` (this is the descriptive text of the client that might show up in your IdP's UI and therefore should explain what the client is used for)
- Client create wizard page 2: - Client create wizard page 2:
- *Client authentication*: `On` - *Client authentication*: `On`
- *Authorization*: `Off` (default) - *Authorization*: `Off` (default)
@@ -123,8 +142,8 @@ If you just created the `fed-test-idp-realm`, you are already in the admin scree
- `Standard flow` - `Standard flow`
- `Direct access grants` - `Direct access grants`
- Client create wizard page 3: - Client create wizard page 3:
- *Valid Redirect URLs*: `https://id.opendesk.tld/realms/opendesk/broker/auto-federate-idp/endpoint` - *Valid Redirect URLs*: `https://id.opendesk.tld/realms/opendesk/broker/sso-federation-idp/endpoint`
- When completed with *Save*, you get to the detailed client configured that also needs some updates: - When completed with *Save*, you get to the detailed client configuration that also needs some updates:
- Tab *Settings* > Section *Logout settings* - Tab *Settings* > Section *Logout settings*
- *Front channel logout*: `Off` - *Front channel logout*: `Off`
- *Back channel logout URL*: `https://id.opendesk.tld/realms/opendesk/protocol/openid-connect/logout/backchannel-logout` - *Back channel logout URL*: `https://id.opendesk.tld/realms/opendesk/protocol/openid-connect/logout/backchannel-logout`
@@ -133,17 +152,21 @@ If you just created the `fed-test-idp-realm`, you are already in the admin scree
## openDesk IdP ## openDesk IdP
> **Note**
> While manual configuration is possible, an SSO federation can also be configured as part of the deployment.
> Check `functional.authentication.ssoFederation` section from the `functional.yaml.gotmpl` for details.
The following configuration is taking place in the Keycloak realm `opendesk`. The following configuration is taking place in the Keycloak realm `opendesk`.
- *Authentication* > *Create flow* - *Authentication* > *Create flow*
- *Name*: `auto-federate-flow` - *Name*: `sso-federation-flow`
- *Flow type*: `Basic flow` - *Flow type*: `Basic flow`
- *Create* - *Create*
- *Add execution*: Add `Detect existing broker user` and set it to `Required` - *Add execution*: Add `Detect existing broker user` and set it to `Required`
- *Add step*: `Automatically set existing user` and set it to `Required` - *Add step*: `Automatically set existing user` and set it to `Required`
- *Identity providers* > *User-defined* > *OpenID Connect 1.0* - *Identity providers* > *User-defined* > *OpenID Connect 1.0*
- *Alias*: `auto-federate-idp` (used in our example) - *Alias*: `sso-federation-idp` (used in our example)
- *Display Name*: A descriptive Name, in case you do not forcefully redirect the user to the IdP, that name is shown on the login screen for manual selection. - *Display Name*: A descriptive Name, in case you do not forcefully redirect the user to the IdP, that name is shown on the login screen for manual selection.
- *Use discovery endpoint*: `On` (default) - *Use discovery endpoint*: `On` (default)
- *Discovery endpoint*: `https://idp.organization.tld/realms/fed-test-idp-realm/.well-known/openid-configuration` - this URL may look different if you do not use Keycloak or a different Keycloak version as IdP in your organization - *Discovery endpoint*: `https://idp.organization.tld/realms/fed-test-idp-realm/.well-known/openid-configuration` - this URL may look different if you do not use Keycloak or a different Keycloak version as IdP in your organization
@@ -152,12 +175,12 @@ The following configuration is taking place in the Keycloak realm `opendesk`.
- *Client authentication*: `Client secret sent as post` (default) - *Client authentication*: `Client secret sent as post` (default)
- *Client ID*: Use the client ID you took from your organization's IdP config (`opendesk-federation-client` in this example) - *Client ID*: Use the client ID you took from your organization's IdP config (`opendesk-federation-client` in this example)
- *Client Secret*: Use the secret you took from your organization's IdP config - *Client Secret*: Use the secret you took from your organization's IdP config
- When completed with *Add*, you get to the detailed IdP configuration that at least needs some the following update: - When completed with *Add*, you get to the detailed IdP configuration which at least needs the following update:
- *First login flow override*: `auto-federate-flow` - *First login flow override*: `sso-federation-flow`
- Depending on your organizations IdP and process preferences additional setting may be required - Depending on your organizations IdP and process preferences, additional configuration may be required
- In case you want to forcefully redirect all users to your organization's IdP (disabling login with local openDesk accounts): - In case you want to forcefully redirect all users to your organization's IdP (disabling login with local openDesk accounts):
- *Authentication* > `2fa-browser` - *Authentication* > `2fa-browser`
- Click on the cogwheel next to the *Identity Provider Re-director* - Click on the cogwheel next to the *Identity Provider Re-director*
- *Alias*: `auto-federate-idp` - *Alias*: `sso-federation-idp`
- *Default Identity Provider*: `auto-federate-idp` - *Default Identity Provider*: `sso-federation-idp`

View File

@@ -12,7 +12,7 @@ SPDX-License-Identifier: Apache-2.0
<!-- TOC --> <!-- TOC -->
The Element chat application and its server component Synapse are based on the Matrix protocol, The Element chat application and its server component Synapse are based on the Matrix protocol,
that supports federation with other Matrix servers to communicate with the users with accounts on these servers. which supports federation with other Matrix servers, allowing communication with the users with accounts on these servers.
By default, you can chat with users who have an account within your openDesk installation and federate with other By default, you can chat with users who have an account within your openDesk installation and federate with other
matrix-based servers. matrix-based servers.
@@ -35,15 +35,15 @@ The following setting can turn off federation:
```yaml ```yaml
functional: functional:
  externalServices: externalServices:
    matrix: matrix:
      federation: federation:
        enabled: false enabled: false
``` ```
## Separate Matrix domain ## Separate Matrix domain
If you want to federate with other Matrix instances and use a separate Matrix domain, you need to provide a JSON file on If you want to federate with other Matrix instances and use a separate Matrix domain, you need to provide a JSON file for
the Matrix domain to use delegation. It is not part of your openDesk deployment. the Matrix domain to use delegation. It is not part of your openDesk deployment.
Domain path: `https://my_organization.tld/.well-known/matrix/server` Domain path: `https://my_organization.tld/.well-known/matrix/server`
@@ -51,9 +51,9 @@ Domain path: `https://my_organization.tld/.well-known/matrix/server`
Content: Content:
```JSON ```JSON
{ {
    "m.server": "matrix-federation.opendesk.domain.tld:443" "m.server": "matrix-federation.opendesk.domain.tld:443"
} }
``` ```
More detailed information can be found in Matrix/Synapse documentation: More detailed information can be found in the Matrix/Synapse documentation:
[Matrix Delegation](https://element-hq.github.io/synapse/latest/delegate.html) [Matrix Delegation](https://element-hq.github.io/synapse/latest/delegate.html)

View File

@@ -3,25 +3,27 @@ SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlic
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
--> -->
<h1>Self-signed certificate and custom Certificate Authority (CA)</h1> <h1>Self-signed certificates and custom Certificate Authority (CA)</h1>
<!-- TOC --> <!-- TOC -->
* [Configuration](#configuration) * [Configuration](#configuration)
* [Option 1: Bring Your Own Certificate](#option-1-bring-your-own-certificate) * [Option 1: Bring Your Own Certificate](#option-1-bring-your-own-certificate)
* [Option 2a: Use cert-manager.io with auto-generated namespace based root-certificate](#option-2a-use-cert-managerio-with-auto-generated-namespace-based-root-certificate) * [Option 2a: Use cert-manager.io with auto-generated namespace based root-certificate](#option-2a-use-cert-managerio-with-auto-generated-namespace-based-root-certificate)
* [Option 2b: Use cert-manager.io with pre-defined/shared root-certificate](#option-2b-use-cert-managerio-with-pre-definedshared-root-certificate) * [Option 2b: Use cert-manager.io with a pre-defined or shared root-certificate](#option-2b-use-cert-managerio-with-a-pre-defined-or-shared-root-certificate)
<!-- TOC --> <!-- TOC -->
Deploying openDesk into an environment with custom public key infrastructure (PKI) that is usually not part of This document covers:
public certificate authority chains or deploying openDesk into a local cluster without ACME challenge. * Deploying openDesk into an environment with custom public key infrastructure (PKI) that is usually not part of
public certificate authority chains
* deploying openDesk into a local cluster without ACME challenge
# Configuration # Configuration
There are two options to address the use case. There are two options to address these use case:
## Option 1: Bring Your Own Certificate ## Option 1: Bring Your Own Certificate
This option is useful, when you have your own PKI in your environment which is trusted by all clients that should This option is useful when you have your own PKI in your environment which is also trusted by all clients that should
access openDesk. access openDesk.
1. Disable cert-manager.io certificate resource creation: 1. Disable cert-manager.io certificate resource creation:
@@ -31,26 +33,26 @@ access openDesk.
enabled: false enabled: false
``` ```
1. Enable mount of self-signed certificates: 2. Enable mount of self-signed certificates:
```yaml ```yaml
certificate: certificate:
selfSigned: true selfSigned: true
``` ```
1. Create a Kubernetes secret named `opendesk-certificates-tls` of type `kubernetes.io/tls` containing either a valid 3. Create a Kubernetes secret named `opendesk-certificates-tls` of type `kubernetes.io/tls` containing either a valid
wildcard certificate or a certificate with [all required subdomains](../../helmfile/environments/default/global.yaml.gotmpl) wildcard certificate or a certificate with [all required subdomains](../../helmfile/environments/default/global.yaml.gotmpl)
set as SANs (Subject Alternative Name). set as SANs (Subject Alternative Name).
1. Create a Kubernetes secret with name `opendesk-certificates-ca-tls` of type `kubernetes.io/tls` containing the custom 4. Create a Kubernetes secret with name `opendesk-certificates-ca-tls` of type `kubernetes.io/tls` containing the custom
CA certificate as X.509 encoded (`ca.crt`) and as jks trust store (`truststore.jks`). CA certificate as X.509 encoded (`ca.crt`) and as jks trust store (`truststore.jks`).
1. Create a Kubernetes secret with name `opendesk-certificates-keystore-jks` with key `password` and as value the jks 5. Create a Kubernetes secret with name `opendesk-certificates-keystore-jks` with key `password` and as value the jks
trust store password. trust store password.
## Option 2a: Use cert-manager.io with auto-generated namespace based root-certificate ## Option 2a: Use cert-manager.io with auto-generated namespace based root-certificate
This option is useful, when you do not have a trusted certificate available and can't fetch a certificate from This option is useful when you do not have a trusted certificate available and can't fetch a certificate from
Lets Encrypt. It will result in a cert-manager managed root certificate in the namespace you deploy openDesk into. Lets Encrypt. It will result in a cert-manager managed root certificate in the namespace you deploy openDesk into.
1. Create self-signed cert-manager.io Cluster Issuer: 1. Create self-signed cert-manager.io Cluster Issuer:
@@ -63,7 +65,7 @@ Lets Encrypt. It will result in a cert-manager managed root certificate in th
selfSigned: {} selfSigned: {}
``` ```
1. Enable mount and creation of self-signed certificates: 2. Enable mount and creation of self-signed certificates:
```yaml ```yaml
certificate: certificate:
issuerRef: issuerRef:
@@ -71,14 +73,14 @@ Lets Encrypt. It will result in a cert-manager managed root certificate in th
selfSigned: true selfSigned: true
``` ```
## Option 2b: Use cert-manager.io with pre-defined/shared root-certificate ## Option 2b: Use cert-manager.io with a pre-defined or shared root-certificate
Use this approach if you like to use a pre-created CA root certificate that can be "shared" (as copy) between Use this approach if you like to use a pre-created CA root certificate that can be "shared" (as copy) between
multiple namespaces in a cluster. multiple namespaces in a cluster.
1. Create self-signed cert-manager.io Cluster Issuer root certificate the same was as in *Option 2a*. 1. Create self-signed cert-manager.io Cluster Issuer root certificate the same way as in *Option 2a*.
1. Create the root certificate for the previously created CA, in the example it is placed into the namespace `cert-manager`. 2. Create the root certificate for the previously created CA, in the example it is placed into the namespace `cert-manager`.
```yaml ```yaml
apiVersion: cert-manager.io/v1 apiVersion: cert-manager.io/v1
kind: Certificate kind: Certificate
@@ -102,8 +104,8 @@ multiple namespaces in a cluster.
renewBefore: 87599h renewBefore: 87599h
``` ```
1. Copy this cert's secret into the/each namespace you want to make use of the cert. 3. Copy this certificates secret into all namespaces you want to make use of the certificate in.
1. Create issuer in the/each namespace you want to make use of the cert. 4. Create an issuer resource in all namespaces you want to make use of the certificate in.
The latter two steps are part of the `env-start:` section within [`.gitlab-ci.yml`](../../.gitlab-ci.yml). >The latter two steps are part of the `env-start:` section within [`.gitlab-ci.yml`](../../.gitlab-ci.yml).

View File

@@ -20,7 +20,7 @@ When deploying this suite to production, you need to configure the applications
service. service.
> **Note**<br> > **Note**<br>
> openDesk supports PostgreSQL as alternative database backend for Nextcloud and XWiki. PostgreSQL is likely become the preferred option/default in the future and MariaDB might be deprecated at a later point requiring migrations[^1] if you do not select PostgreSQL for new installations. > openDesk supports PostgreSQL as alternative database backend for Nextcloud and XWiki. PostgreSQL is likely to become the preferred option/default in the future should MariaDB become deprecated. This would cause migration[^1] to be necessary if you do not select PostgreSQL for new installations.
| Component | Name | Parameter | Key | Default | | Component | Name | Parameter | Key | Default |
| ------------------ | ------------------ | --------- | --------------------------------------------- | ---------------------------- | | ------------------ | ------------------ | --------- | --------------------------------------------- | ---------------------------- |
@@ -155,7 +155,7 @@ service.
# Footnotes # Footnotes
[^1] The upstream product provide some valuable information regarding database migrations: [^1] The upstream product documentation provides some valuable information regarding database migrations:
- Nextcloud: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/db_conversion.html - Nextcloud: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/db_conversion.html
- XWiki: - XWiki:
- https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature - https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature
@@ -165,4 +165,4 @@ service.
[^3] openDesk Enterprise only. [^3] openDesk Enterprise only.
[^4] XWiki requires root access when using MariaDB as sub-wikis are using separate databases that are managed by XWiki. When using PostgreSQL with XWiki no root user is required as the sub-wikis are managed within multiple schemes within a single database. [^4] XWiki requires root access when using MariaDB due to the fact that sub-wikis use separate databases that are managed by XWiki. When using PostgreSQL with XWiki no root user is required as the sub-wikis are managed within multiple schemas within a single database.

View File

@@ -26,6 +26,7 @@ The following categories are available. Each category contains a set of options
* Portal options (`functional.portal.*`): Options to customize the openDesk portal, e.g. if the login dialog should be enforced. * Portal options (`functional.portal.*`): Options to customize the openDesk portal, e.g. if the login dialog should be enforced.
* Chat options (`functional.chat.*`): Configuration options for the chat component of openDesk. * Chat options (`functional.chat.*`): Configuration options for the chat component of openDesk.
* Migration options (`functional.migration.*`): Helpful setting(s) for migration scenarios. * Migration options (`functional.migration.*`): Helpful setting(s) for migration scenarios.
* Groupware options (`functional.groupware.*`): Options to customize Open-Xchange and mail settings, e.g. mail quota.
## Customization of functional options ## Customization of functional options

View File

@@ -58,22 +58,26 @@ For the following guide, we will use `dev` as environment where variables can be
## DNS ## DNS
The deployment is designed to deploy each application/service under a dedicated subdomain. The deployment is designed to deploy each application/service under a dedicated subdomain.
For your convenience, we recommend creating a `*.domain.tld` A-Record to your cluster ingress controller; otherwise, you must create an A-Record for each subdomain. For your convenience, we recommend creating a `*.domain.tld` A-Record for your cluster Ingress Controller; otherwise, you must create an A-Record for each subdomain.
| Record name | Type | Value | Additional information | | Record name | Type | Value | Additional information |
| ----------------------------- | ---- | -------------------------------------------------- | ---------------------------------------------------------------- | |-------------------------------|------|----------------------------------------------------|-------------------------------------------------------------------|
| *.domain.tld | A | IPv4 address of your Ingress Controller | | | *.domain.tld | A | IPv4 address of your Ingress Controller | |
| *.domain.tld | AAAA | IPv6 address of your Ingress Controller | | | *.domain.tld | AAAA | IPv6 address of your Ingress Controller | |
| mail.domain.tld | A | IPv4 address of your postfix NodePort/LoadBalancer | Optional mail should directly be delivered to openDesk's Postfix | | mail.domain.tld | A | IPv4 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix |
| mail.domain.tld | AAAA | IPv6 address of your postfix NodePort/LoadBalancer | Optional mail should directly be delivered to openDesk's Postfix | | mail.domain.tld | AAAA | IPv6 address of your postfix NodePort/LoadBalancer | Optional, mail should directly be delivered to openDesk's Postfix |
| domain.tld | MX | `10 mail.domain.tld` | | | domain.tld | MX | `10 mail.domain.tld` | |
| domain.tld | TXT | `v=spf1 +a +mx +a:mail.domain.tld ~all` | Optional, use proper MTA record if present | | domain.tld | TXT | `v=spf1 +a +mx +a:mail.domain.tld ~all` | Optional, use proper MTA record if present |
| _dmarc.domain.tld | TXT | `v=DMARC1; p=quarantine` | Optional | | _dmarc.domain.tld | TXT | `v=DMARC1; p=quarantine` | Optional |
| default._domainkey.domain.tld | TXT | `v=DKIM1; k=rsa; h=sha256; ...` | Optional DKIM settings | | default._domainkey.domain.tld | TXT | `v=DKIM1; k=rsa; h=sha256; ...` | Optional, DKIM settings |
| _caldavs._tcp.domain.tld | SRV | 10 1 443 dav.domain.tld. | Optional, CalDav auto discovery |
| _caldav._tcp.domain.tld | SRV | 10 1 80 dav.domain.tld. | Optional, CalDav auto discovery |
| _carddavs._tcp.domain.tld | SRV | 10 1 443 dav.domain.tld. | Optional, CardDav auto discovery |
| _carddav._tcp.domain.tld | SRV | 10 1 80 dav.domain.tld. | Optional, CardDav auto discovery |
## Domain ## Domain
A list of all subdomains can be found in `helmfile/environments/default/global.gotmpl`. A list of all subdomains can be found in `helmfile/environments/default/global.yaml.gotmpl`.
All subdomains can be customized. For example, _Nextcloud_ can be changed to `files.domain.tld` in `dev` environment: All subdomains can be customized. For example, _Nextcloud_ can be changed to `files.domain.tld` in `dev` environment:
@@ -83,14 +87,14 @@ global:
nextcloud: "files" nextcloud: "files"
``` ```
The domain has to be set either via `dev` environment The domain has to be set either via `dev` environment:
```yaml ```yaml
global: global:
domain: "domain.tld" domain: "domain.tld"
``` ```
or via environment variable or alternatively via environment variable:
```shell ```shell
export DOMAIN=domain.tld export DOMAIN=domain.tld
@@ -98,7 +102,8 @@ export DOMAIN=domain.tld
### Apps ### Apps
All available apps and their default value are in `helmfile/environments/default/opendesk_main.gotmpl`. Depending on your ideal openDesk deployment, you may wish to disable or enable certain apps.
All available apps and their default values are located in `helmfile/environments/default/opendesk_main.yaml.gotmpl`.
| Component | Name | Default | Description | | Component | Name | Default | Description |
| -------------------- | --------------------------- | ------- | ------------------------------ | | -------------------- | --------------------------- | ------- | ------------------------------ |
@@ -124,7 +129,7 @@ All available apps and their default value are in `helmfile/environments/default
| Redis | `apps.redis.enabled` | `true` | Cache Database | | Redis | `apps.redis.enabled` | `true` | Cache Database |
| XWiki | `apps.xwiki.enabled` | `true` | Knowledge management | | XWiki | `apps.xwiki.enabled` | `true` | Knowledge management |
Exemplary, Jitsi can be disabled like: For example, Jitsi can be disabled like this:
```yaml ```yaml
apps: apps:
@@ -135,14 +140,14 @@ apps:
## Private registries ## Private registries
By default, Helm charts and container images are fetched from OCI registries. These registries can be found in most cases By default, Helm charts and container images are fetched from OCI registries. These registries can be found in most cases
in the [openDesk/component section on Open CoDE](https://gitlab.opencode.de/bmi/opendesk/components). in the [openDesk/component section on openCode](https://gitlab.opencode.de/bmi/opendesk/components).
For untouched upstream artifacts that do not belong to a functional component's core, we use upstream registries For untouched upstream artifacts that do not belong to a functional component's core, we use upstream registries
like Docker Hub. like Docker Hub.
Doing a test deployment will be fine with this setup. In case you want to deploy multiple times a day Doing a test deployment will be fine with this setup. In case you want to deploy multiple times a day
and fetch from the same IP address, you might run into rate limits at Docker Hub. In that case and in cases you and fetch from the same IP address, you might run into rate limits at Docker Hub. In that case, and in case you
prefer the use of a private image registry, you can configure such for prefer the use of a private image registry, you can configure these in
[your target environment](../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting [your target environment](../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting
- `global.imageRegistry` for a private image registry and - `global.imageRegistry` for a private image registry and
- `global.helmRegistry` for a private Helm chart registry. - `global.helmRegistry` for a private Helm chart registry.
@@ -158,7 +163,7 @@ alternatively, you can use an environment variable:
export PRIVATE_IMAGE_REGISTRY_URL=my_private_registry.domain.tld export PRIVATE_IMAGE_REGISTRY_URL=my_private_registry.domain.tld
``` ```
or control repository override fine-granular per registry: or for more granular control over repository overrides per registry (rewrites):
```yaml ```yaml
repositories: repositories:
@@ -179,9 +184,9 @@ global:
### Service ### Service
Some apps, like Jitsi or Dovecot, require HTTP and external TCP connections. Some apps, like Jitsi and Dovecot, require HTTP and external TCP connections.
These apps create a Kubernetes service object. These apps create a Kubernetes service object.
You can configure whether `NodePort` (for on-premise), `LoadBalancer` (for cloud), or `ClusterIP` (to disable) should be You can configure whether `NodePort` (for on-premises), `LoadBalancer` (for cloud), or `ClusterIP` (to disable) should be
used: used:
```yaml ```yaml
@@ -192,7 +197,7 @@ cluster:
### Networking ### Networking
If your cluster has not the default `cluster.local` domain configured, you need to provide the domain via: If your cluster does not have the default `cluster.local` domain configured, you need to provide the domain via:
```yaml ```yaml
cluster: cluster:
@@ -200,7 +205,7 @@ cluster:
domain: "acme.internal" domain: "acme.internal"
``` ```
If your cluster has not the default `10.0.0.0/8` CIDR configured, you need to provide the CIDR via the following: If your cluster does not have the default `10.0.0.0/8` CIDR configured, you need to provide the CIDR via the following:
```yaml ```yaml
cluster: cluster:
@@ -209,8 +214,8 @@ cluster:
- "127.0.0.0/8" - "127.0.0.0/8"
``` ```
If your load balancer / reverse proxy IPs are not already covered by the above `cidr` you need to If your load balancer / reverse proxy IPs are not already included in the above `cidr` you need to
explicitly configure the related IPs or IP ranges: explicitly configure their related IPs or IP ranges:
```yaml ```yaml
cluster: cluster:
@@ -221,19 +226,24 @@ cluster:
### Ingress ### Ingress
By default, the `ingressClassName` is empty to select your default ingress controller. You may want to customize it by The default value for the `ingressClassName` in openDesk is set to `nginx`. This prevents fallback to the
setting the following attribute to the name of the currently only supported ingress controller `ingress-nginx` (see clusters default ingress class, since the Helm charts used by openDesk components are not consistently aligned in
[requirements.md](requirements.md)) for reference) within your deployment if that is not the cluster's default ingress. how they handle a missing or empty `ingressClassName`. In case you are using a non-standard `ingressClassName` for
your `ingress-nginx` controller you have to configure it as follows:
```yaml ```yaml
ingress: ingress:
ingressClassName: "name-of-my-nginx-ingress" ingressClassName: "nginx"
``` ```
> **Note**<br>
> Currently, the only supported ingress controller is `ingress-nginx`
> (see [requirements.md](./docs/requirements.md) for reference).
### Container runtime ### Container runtime
Some apps require specific configurations for the container runtime. You can set your container runtime like `cri-o`, Some apps require specific configurations for the container runtime. You can set your container runtime like `cri-o`,
`containerd` or `docker` by: `containerd` or `docker` by using the following attribute:
```yaml ```yaml
cluster: cluster:
@@ -242,7 +252,7 @@ cluster:
``` ```
### Volumes ### Volumes
The **StorageClass** must be set by: The StorageClass must be set using the following attribute:
```yaml ```yaml
persistence: persistence:
@@ -252,8 +262,8 @@ persistence:
``` ```
`RWX` is optional and requires that your cluster has a `ReadWriteMany` volume provisioner. If you can make use `RWX` is optional and requires that your cluster has a `ReadWriteMany` volume provisioner. If you can make use
of it it benefits the distribution or scaling of apps. By default, only `ReadWriteOnce` is enabled. of it, it largely benefits the distribution and scaling of apps. By default, only `ReadWriteOnce` is enabled.
To enable `ReadWriteMany` you have to set: To enable `ReadWriteMany` you can use the following attribute:
```yaml ```yaml
cluster: cluster:
@@ -263,13 +273,14 @@ cluster:
## Customize deployment ## Customize deployment
While openDesk configures the applications with meaningful defaults, you can check [functional.md](functional.md) if you want to change these defaults to better match your use case. While openDesk configures the applications with meaningful defaults, you can check [functional.md](./docs/functional.md) if you want to change these defaults to better match your use case.
## Connectivity ## Connectivity
### Ports ### Ports
**Note:** If you use `NodePort` for service exposure, you must check your deployment for the actual ports. > **Note**<br>
> If you use `NodePort` for service exposure, you must check your deployment for the actual ports and ensure they are opened where necessary.
#### Web-based user interface #### Web-based user interface
@@ -283,7 +294,7 @@ To use the openDesk functionality with its web-based user interface, you need to
#### Mail clients #### Mail clients
To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need public exposure: To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need to be publicly exposed:
| Component | Description | Port | Type | | Component | Description | Port | Type |
| ------------------ | ----------------------- | ----: | ---: | | ------------------ | ----------------------- | ----: | ---: |
@@ -295,7 +306,7 @@ To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), t
### Mail/SMTP configuration ### Mail/SMTP configuration
To use the full potential of the openDesk, you need to set up an SMTP relay that allows sending emails from To use the full potential of the openDesk, you need to set up an SMTP relay that allows sending emails from
the whole subdomain. the whole subdomain. The following attribute can be set:
```yaml ```yaml
smtp: smtp:
@@ -305,7 +316,7 @@ smtp:
``` ```
Enabling DKIM signing of emails helps to reduce spam and increases trust. Enabling DKIM signing of emails helps to reduce spam and increases trust.
openDesk ships dkimpy-milter as Postfix milter for signing emails. openDesk ships dkimpy-milter as Postfix milter for signing emails. The following attributes can be set:
```yaml ```yaml
apps: apps:
@@ -338,9 +349,9 @@ turn:
### Certificate issuer ### Certificate issuer
As mentioned in [requirements](requirements.md#certificate-management), you can provide your own valid certificate. A TLS As mentioned in [requirements](requirements.md#certificate-management), you can provide your own valid certificate. A TLS type
secret named `opendesk-certificates-tls` must be present in the application namespace. For deployment, you can secret named `opendesk-certificates-tls` must be present in the application namespace. For deployment, you can
turn off `Certificate` resource creation by: turn off `Certificate` resource creation with:
```yaml ```yaml
apps: apps:
@@ -348,7 +359,7 @@ apps:
enabled: false enabled: false
``` ```
If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the If you want to leverage `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the
configured cluster issuer: configured cluster issuer:
```yaml ```yaml
@@ -357,7 +368,7 @@ certificate:
name: "letsencrypt-prod" name: "letsencrypt-prod"
``` ```
Additionally, it is possible to request wildcard certificates by: Additionally, it is possible to request wildcard certificates with:
```yaml ```yaml
certificate: certificate:
@@ -373,6 +384,18 @@ To prevent others from using your openDesk instance, you must set your individua
export MASTER_PASSWORD="your_individual_master_password" export MASTER_PASSWORD="your_individual_master_password"
``` ```
> **Note**<br>
> Currently a [documented](https://docs.software-univention.de/nubus-kubernetes-operation/1.x/en/configuration/nats.html#configure-the-secrets) upstream [bug](https://forge.univention.org/bugzilla/show_bug.cgi?id=58357) causes a failure when passwords/secrets beginning with certain numbers are using for the Nubus subcomponent NATS.
> With openDesk 1.6.0 an update-aware workaround was implemented that prefixes the affected secrets in the openDesk included `secrets.yaml.gotmpl` that derives all secrets from the previously mentioned `MASTER_PASSWORD`.
> If you are using externally provided passwords/secrets make sure that none of the ones listed below are starting with a number:
>
> - `secrets.nubus.provisioning.api.natsPassword`
> - `secrets.nubus.provisioning.dispatcherNatsPassword`
> - `secrets.nubus.provisioning.prefillNatsPassword`
> - `secrets.nubus.provisioning.udmListenerNatsPassword`
> - `secrets.nubus.provisioning.udmTransformerNatsPassword`
> - `secrets.nats.natsAdminPassword`
## Install ## Install
After setting your environment-specific values in `dev` environment, you can start deployment by: After setting your environment-specific values in `dev` environment, you can start deployment by:
@@ -390,13 +413,13 @@ helmfile apply -e dev -n <NAMESPACE> [-l <label>] [--suppress-diff]
## Install single app ## Install single app
You can also install or upgrade only a single app like Collabora, either by label selector: You can also install or upgrade only a single app like Collabora, either by using a label selector:
```shell ```shell
helmfile apply -e dev -n <NAMESPACE> -l component=collabora helmfile apply -e dev -n <NAMESPACE> -l component=collabora
``` ```
or by switching into the apps' directory (faster): or by switching to the apps' directory (faster) and install or upgrade from there directly:
```shell ```shell
cd helmfile/apps/collabora cd helmfile/apps/collabora
@@ -405,7 +428,7 @@ helmfile apply -e dev -n <NAMESPACE>
## Install single release/chart ## Install single release/chart
Instead of iteration through all services, you can also deploy a single release like `mariadb` by: Instead of iterating through all services, you can also deploy a single release like `mariadb` by executing the following:
```shell ```shell
helmfile apply -e dev -n <NAMESPACE> -l name=mariadb helmfile apply -e dev -n <NAMESPACE> -l name=mariadb
@@ -413,17 +436,17 @@ helmfile apply -e dev -n <NAMESPACE> -l name=mariadb
# Access deployment # Access deployment
When all apps are successfully deployed, and their Pod's status is `Running` or `Succeeded`, you can navigate to When all apps are successfully deployed, and their Pod status is `Running` or `Succeeded`, you can navigate to
```text ```text
https://portal.domain.tld https://portal.domain.tld
``` ```
If you change the subdomain of `nubus`, you must replace `portal` with the specified subdomain. If you change the subdomain of `nubus`, you must replace the subdomain of `portal` with the same subdomain.
**Credentials:** **Credentials:**
openDesk deploys with the standard user account `Administrator`, which password you get retrieved as follows: openDesk deploys with the standard user account `Administrator`, the password for which can be retrieved as follows:
```shell ```shell
# Set your namespace # Set your namespace
@@ -437,8 +460,8 @@ Using the aforementioned account, you can either create new accounts manually or
[openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import/) [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import/)
script or container. script or container.
For example you get a `default` and `default-admin` account by running the following snippet, after settings the In the following snippet, after defining the values of the first three lines and executing the command,
appropriate values in the first three lines. you get two accounts, `default` and `default-admin`:
```shell ```shell
ADMINISTRATOR_PASSWORD=<your_administrator_password_see_above> ADMINISTRATOR_PASSWORD=<your_administrator_password_see_above>
@@ -467,7 +490,7 @@ configuration values are:
# Uninstall # Uninstall
You can uninstall the deployment by: You can uninstall the deployment by executing the following:
```shell ```shell
helmfile destroy -n <NAMESPACE> helmfile destroy -n <NAMESPACE>
@@ -493,4 +516,4 @@ kubectl delete configmaps --all --namespace ${NAMESPACE};
``` ```
> **Warning**<br> > **Warning**<br>
> Without specifying or empty `--namespace` flag, cluster-wide components get deleted! > Without specifying a `--namespace` flag, or by leaving it empty, cluster-wide components will get deleted!

View File

@@ -1,5 +1,5 @@
<!-- <!--
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
--> -->
@@ -7,33 +7,53 @@ SPDX-License-Identifier: Apache-2.0
<!-- TOC --> <!-- TOC -->
* [Disclaimer](#disclaimer) * [Disclaimer](#disclaimer)
* [Deprecation warnings](#deprecation-warnings)
* [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path) * [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path)
* [Manual checks/actions](#manual-checksactions) * [Manual checks/actions](#manual-checksactions)
* [From v1.1.2](#from-v112) * [v1.7.0+](#v170)
* [Pre-upgrade to v1.7.0+](#pre-upgrade-to-v170)
* [Helmfile fix: Ensure enterprise overrides apply when deploying from project root](#helmfile-fix-ensure-enterprise-overrides-apply-when-deploying-from-project-root)
* [Replace Helm chart: New Notes Helm chart with support for self-signed deployments](#replace-helm-chart-new-notes-helm-chart-with-support-for-self-signed-deployments)
* [Post-upgrade to v1.7.0+](#post-upgrade-to-v170)
* [Upstream fix: Provisioning of functional mailboxes](#upstream-fix-provisioning-of-functional-mailboxes)
* [v1.6.0+](#v160)
* [Pre-upgrade to v1.6.0+](#pre-upgrade-to-v160)
* [Upstream constraint: Nubus' external secrets](#upstream-constraint-nubus-external-secrets)
* [Helmfile new secret: `secrets.minio.openxchangeUser`](#helmfile-new-secret-secretsminioopenxchangeuser)
* [Helmfile new object storage: `objectstores.openxchange.*`](#helmfile-new-object-storage-objectstoresopenxchange)
* [OX App Suite fix-up: Using S3 as storage for non mail attachments (pre-upgrade)](#ox-app-suite-fix-up-using-s3-as-storage-for-non-mail-attachments-pre-upgrade)
* [Post-upgrade to v1.6.0+](#post-upgrade-to-v160)
* [OX App Suite fix-up: Using S3 as storage for non mail attachments (post-upgrade)](#ox-app-suite-fix-up-using-s3-as-storage-for-non-mail-attachments-post-upgrade)
* [v1.4.0+](#v140)
* [Pre-upgrade to v1.4.0+](#pre-upgrade-to-v140)
* [Helmfile new feature: `functional.authentication.ssoFederation`](#helmfile-new-feature-functionalauthenticationssofederation)
* [Helmfile cleanup: `global.additionalMailDomains` as list](#helmfile-cleanup-globaladditionalmaildomains-as-list)
* [v1.2.0+](#v120)
* [Pre-upgrade to v1.2.0+](#pre-upgrade-to-v120)
* [Helmfile cleanup: Do not configure OX provisioning when no OX installed](#helmfile-cleanup-do-not-configure-ox-provisioning-when-no-ox-installed) * [Helmfile cleanup: Do not configure OX provisioning when no OX installed](#helmfile-cleanup-do-not-configure-ox-provisioning-when-no-ox-installed)
* [Helmfile new default: PostgreSQL for XWiki and Nextcloud](#helmfile-new-default-postgresql-for-xwiki-and-nextcloud) * [Helmfile new default: PostgreSQL for XWiki and Nextcloud](#helmfile-new-default-postgresql-for-xwiki-and-nextcloud)
* [From v1.1.1](#from-v111) * [v1.1.2+](#v112)
* [Pre-upgrade from v1.1.1](#pre-upgrade-from-v111) * [Pre-upgrade to v1.1.2+](#pre-upgrade-to-v112)
* [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element) * [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element)
* [From v1.1.0](#from-v110) * [v1.1.1+](#v111)
* [Pre-upgrade from v1.1.0](#pre-upgrade-from-v110) * [Pre-upgrade to v1.1.1](#pre-upgrade-to-v111)
* [Helmfile feature update: Component specific `storageClassName`](#helmfile-feature-update-component-specific-storageclassname) * [Helmfile feature update: Component specific `storageClassName`](#helmfile-feature-update-component-specific-storageclassname)
* [Helmfile new secret: `secrets.nubus.masterpassword`](#helmfile-new-secret-secretsnubusmasterpassword) * [Helmfile new secret: `secrets.nubus.masterpassword`](#helmfile-new-secret-secretsnubusmasterpassword)
* [From v1.0.0](#from-v100) * [v1.1.0+](#v110)
* [Pre-upgrade from v1.0.0](#pre-upgrade-from-v100) * [Pre-upgrade to v1.1.0](#pre-upgrade-to-v110)
* [Helmfile cleanup: Restructured `/helmfile/files/theme` folder](#helmfile-cleanup-restructured-helmfilefilestheme-folder) * [Helmfile cleanup: Restructured `/helmfile/files/theme` folder](#helmfile-cleanup-restructured-helmfilefilestheme-folder)
* [Helmfile cleanup: Consistent use of `*.yaml.gotmpl`](#helmfile-cleanup-consistent-use-of-yamlgotmpl) * [Helmfile cleanup: Consistent use of `*.yaml.gotmpl`](#helmfile-cleanup-consistent-use-of-yamlgotmpl)
* [Helmfile cleanup: Prefixing certain app directories with `opendesk-`](#helmfile-cleanup-prefixing-certain-app-directories-with-opendesk-) * [Helmfile cleanup: Prefixing certain app directories with `opendesk-`](#helmfile-cleanup-prefixing-certain-app-directories-with-opendesk-)
* [Helmfile cleanup: Helmfile cleanup: Splitting external vs. openDesk services](#helmfile-cleanup-helmfile-cleanup-splitting-external-vs-opendesk-services) * [Helmfile cleanup: Splitting external services and openDesk services](#helmfile-cleanup-splitting-external-services-and-opendesk-services)
* [Helmfile cleanup: Streamlining `openxchange` and `oxAppSuite` attribute names](#helmfile-cleanup-streamlining-openxchange-and-oxappsuite-attribute-names) * [Helmfile cleanup: Streamlining `openxchange` and `oxAppSuite` attribute names](#helmfile-cleanup-streamlining-openxchange-and-oxappsuite-attribute-names)
* [Helmfile feature update: Dicts to define `customization.release`](#helmfile-feature-update-dicts-to-define-customizationrelease) * [Helmfile feature update: Dicts to define `customization.release`](#helmfile-feature-update-dicts-to-define-customizationrelease)
* [openDesk defaults (new): Enforce login](#opendesk-defaults-new-enforce-login) * [openDesk defaults (new): Enforce login](#opendesk-defaults-new-enforce-login)
* [openDesk defaults (changed): Jitsi room history enabled](#opendesk-defaults-changed-jitsi-room-history-enabled) * [openDesk defaults (changed): Jitsi room history enabled](#opendesk-defaults-changed-jitsi-room-history-enabled)
* [External requirements: Redis 7.4](#external-requirements-redis-74) * [External requirements: Redis 7.4](#external-requirements-redis-74)
* [Post-upgrade from v1.0.0](#post-upgrade-from-v100) * [Post-upgrade to v1.1.0+](#post-upgrade-to-v110)
* [XWiki fix-ups](#xwiki-fix-ups) * [XWiki fix-ups](#xwiki-fix-ups)
* [From v0.9.0](#from-v090) * [v1.1.0](#v110-1)
* [Pre-upgrade from v0.9.0](#pre-upgrade-from-v090) * [Pre-upgrade to v1.1.0](#pre-upgrade-to-v110-1)
* [Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus](#configuration-cleanup-removal-of-unnecessary-ox-profiles-in-nubus) * [Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus](#configuration-cleanup-removal-of-unnecessary-ox-profiles-in-nubus)
* [Configuration Cleanup: Updated `global.imagePullSecrets`](#configuration-cleanup-updated-globalimagepullsecrets) * [Configuration Cleanup: Updated `global.imagePullSecrets`](#configuration-cleanup-updated-globalimagepullsecrets)
* [Changed openDesk defaults: Matrix presence status disabled](#changed-opendesk-defaults-matrix-presence-status-disabled) * [Changed openDesk defaults: Matrix presence status disabled](#changed-opendesk-defaults-matrix-presence-status-disabled)
@@ -41,20 +61,17 @@ SPDX-License-Identifier: Apache-2.0
* [Changed openDesk defaults: File-share configurability](#changed-opendesk-defaults-file-share-configurability) * [Changed openDesk defaults: File-share configurability](#changed-opendesk-defaults-file-share-configurability)
* [Changed openDesk defaults: Updated default subdomains in `global.hosts`](#changed-opendesk-defaults-updated-default-subdomains-in-globalhosts) * [Changed openDesk defaults: Updated default subdomains in `global.hosts`](#changed-opendesk-defaults-updated-default-subdomains-in-globalhosts)
* [Changed openDesk defaults: Dedicated group for access to the UDM REST API](#changed-opendesk-defaults-dedicated-group-for-access-to-the-udm-rest-api) * [Changed openDesk defaults: Dedicated group for access to the UDM REST API](#changed-opendesk-defaults-dedicated-group-for-access-to-the-udm-rest-api)
* [Post-upgrade from v0.9.0](#post-upgrade-from-v090) * [Post-upgrade to v1.0.0+](#post-upgrade-to-v100)
* [Configuration Improvement: Separate user permission for using Video Conference component](#configuration-improvement-separate-user-permission-for-using-video-conference-component) * [Configuration Improvement: Separate user permission for using Video Conference component](#configuration-improvement-separate-user-permission-for-using-video-conference-component)
* [Optional Cleanup](#optional-cleanup) * [Optional Cleanup](#optional-cleanup)
* [From v0.8.1](#from-v081)
* [Pre-upgrade from v0.8.1](#pre-upgrade-from-v081)
* [Updated `cluster.networking.cidr`](#updated-clusternetworkingcidr)
* [Updated customizable template attributes](#updated-customizable-template-attributes)
* [`migrations` S3 bucket](#migrations-s3-bucket)
* [Automated migrations - Details](#automated-migrations---details) * [Automated migrations - Details](#automated-migrations---details)
* [From v1.1.2 (automated)](#from-v112-automated) * [v1.6.0+ (automated)](#v160-automated)
* [migrations-pre](#migrations-pre) * [v1.6.0+ migrations-post](#v160-migrations-post)
* [migrations-post](#migrations-post) * [v1.2.0+ (automated)](#v120-automated)
* [From v1.0.0 (automated)](#from-v100-automated) * [v1.2.0+ migrations-pre](#v120-migrations-pre)
* [From v0.9.0 (automated)](#from-v090-automated) * [v1.2.0+ migrations-post](#v120-migrations-post)
* [v1.1.0+ (automated)](#v110-automated)
* [v1.0.0+ (automated)](#v100-automated)
* [Related components and artifacts](#related-components-and-artifacts) * [Related components and artifacts](#related-components-and-artifacts)
* [Development](#development) * [Development](#development)
<!-- TOC --> <!-- TOC -->
@@ -63,40 +80,242 @@ SPDX-License-Identifier: Apache-2.0
Starting with openDesk 1.0, we aim to offer hassle-free updates/upgrades. Starting with openDesk 1.0, we aim to offer hassle-free updates/upgrades.
Therefore openDesk contains automated migrations between versions to lower the requirements for manual interaction. These automated migrations can have limitations in the way that they need a certain openDesk version to be installed causing a mandatory upgrade path that is described in the section [Automated migrations](#automated-migrations). Therefore, openDesk contains automated migrations between versions which reduces the need for manual interaction.
These automated migrations have limitations in the sense that they require a certain openDesk version to be installed, effectively resulting in a forced upgrade path. This is highlighted in the section [Automated migrations](#automated-migrations).
Manual checks and possible activities are also required by openDesk updates, they are described in the section [Manual update steps](#manual-update-steps). Manual checks and possible activities are also required by openDesk updates, they are described in the section [Manual update steps](#manual-update-steps).
> **Note**<br> > **Note**<br>
> Please be sure you read / follow the requirements before you update / upgrade thoroughly. > Please be sure to _thoroughly_ read / follow the requirements before you update / upgrade.
> **Known limitations**<br> > **Known limitations**<br>
> We assume that the PV reclaim policy is set to `delete`, resulting in PVs getting deleted as soon as the related PVC was deleted; we will not address explicit deletion for PVs. > We assume that the PV reclaim policy is set to `delete`, resulting in PVs getting deleted as soon as the related PVC is deleted; we will not address explicit deletion for PVs.
# Deprecation warnings
We cannot hold back all migrations as some are required e.g. due to a change in a specific component that we want/need to update, we try to bundle others only with major releases.
This section provides an overview of potential changes to be part of the next major release (openDesk 2.0).
- `functional.portal.link*` (see `functional.yaml.gotmpl` for details) are going to be moved into the `theme.*` tree, we are also going to move the icons used for the links currently found under `theme.imagery.portalEntries` in this step.
- We will explicitly set the [database schema configuration](https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Configuration/#HConfigurethenamesofdatabaseschemas) for XWiki to avoid the use of the `public` schema.
- `persistance.storages.oxConnector.storageClassName` and `persistance.storages.nubusUdmListener.storageClassName` will be templated in Helmfile requiring you to template them explicitly if their current default values differs from the global value set in `persistence.storageClassNames.RWO`.
- The currently used Helm chart for Notes will be replaced requiring some config updates.
# Automated migrations - Overview and mandatory upgrade path # Automated migrations - Overview and mandatory upgrade path
The following table gives an overview of the mandatory upgrade path of openDesk for the automated migrations to work as expected. The following table gives an overview of the mandatory upgrade path of openDesk, required in order for the automated migrations to work as expected.
To upgrade existing deployments, you cannot skip any version mentioned in the column *Mandatory version*. When a version number is not fully defined (e.g. `v1.1.x`), you can install any version matching the given schema. To upgrade existing deployments, you cannot skip any version mentioned in the column *Mandatory version*. When a version number is not fully defined (e.g. `v1.1.x`), you can install any version matching that constraint.
| Mandatory version | | Mandatory version |
| ----------------- | | ----------------- |
| v1.2.x | | v1.5.0 |
| v1.1.x | | v1.1.x |
| v1.0.0 | | v1.0.0 |
| v0.9.0 | | v0.9.0 |
| v0.8.1 | | v0.8.1 |
<!-- | 1.x.x | add the entry to the table as soon as we get new migration requiring that the former migration was executed -->
> **Note**<br> > **Note**<br>
> Be sure you check out the table in the release version you are going to install, an not the one that is currently installed. > Be sure to check out the table in the release version you are going to install, and not the currently installed version.
When interested in more details about the automated migrations, please read section [Automated migrations - Details](#automated-migrations---details). If you would like more details about the automated migrations, please read section [Automated migrations - Details](#automated-migrations---details).
# Manual checks/actions # Manual checks/actions
Be sure you check all the sections for the releases your are going to update your current deployment from. ## v1.7.0+
## From v1.1.2 ### Pre-upgrade to v1.7.0+
### Helmfile fix: Ensure enterprise overrides apply when deploying from project root
**Target group:** All openDesk Enterprise deployments initiated from the project root using `helmfile_generic.yaml.gotmpl`
Previously, the default values referenced in `helmfile_generic.yaml.gotmpl` did not include the necessary Enterprise overrides from `helmfile/environment/default-ee-overrides/`.
As a result, when deploying openDesk Enterprise Edition from the project root, the correct Enterprise charts and images for Collabora, Nextcloud, OpenXchange, and Dovecot were not applied. This issue does not affect deployments started at the component level (e.g., `helmfile/apps/collabora`).
Please verify that your deployment uses the correct Enterprise charts and images. If not, migrate to the Enterprise versions before upgrading to openDesk EE v1.7.0.
#### Replace Helm chart: New Notes Helm chart with support for self-signed deployments
**Target group:** All deployments that set `app.notes.enabled: true` (default is `false`).
We replaced the Helm Chart used for the Notes (aka "Impress") deployment. If you have enabled Notes in your deployment, you must manually uninstall the old chart before upgrading to openDesk v1.7.0.
```shell
helm uninstall -n <your_namespace> impress
```
In case you are using `annotation.notes` they have to be moved into one of the remaining dicts, see [`annotations.yaml.gotmpl`](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/helmfile/environments/default/annotations.yaml.gotmpl) for details:
```yaml
annotation:
notesBackend: {}
notesFrontend: {}
notesYProvider: {}
```
### Post-upgrade to v1.7.0+
#### Upstream fix: Provisioning of functional mailboxes
**Target group:** Deployments with OX App Suite that make use of IAM maintained functional mailboxes.
The update of OX Connector included in openDesk 1.7.0 fixes an issue with the provisioning of IAM maintained functional mailboxes. If your deployment makes use of these mailboxes it is recommended to trigger a full sync of the OX App Suite provisioning by recreating the OX Connector's provisioning subscription using calls to the provisioning API that is temporary port-forwarded in the example below:
```shell
export NAMESPACE=<your_namespace>
export SUBSCRIPTION_NAME=ox-connector
export SUBSCRIPTION_SECRET_NAME=ums-provisioning-ox-credentials
export TEMPORARY_CONSUMER_JSON=$(mktemp)
export PROVISIONING_API_POD_NAME=$(kubectl -n ${NAMESPACE} get pods --no-headers -o custom-columns=":metadata.name" | grep ums-provisioning-api | tr -d '\n')
kubectl -n ${NAMESPACE} port-forward ${PROVISIONING_API_POD_NAME} 7777:7777 &
export PROVISIONING_PORT_FORWARD_PID=$!
sleep 10
kubectl -n ${NAMESPACE} get secret ${SUBSCRIPTION_SECRET_NAME} -o json | jq '.data | map_values(@base64d)' | jq -r '."ox-connector.json"' > ${TEMPORARY_CONSUMER_JSON}.json
export PROVISIONING_ADMIN_PASSWORD=$(kubectl -n ${NAMESPACE} get secret ums-provisioning-api-admin -o jsonpath='{.data.password}' | base64 --decode)
# Delete the current subscription
curl -o - -u "admin:${PROVISIONING_ADMIN_PASSWORD}" -X DELETE http://localhost:7777/v1/subscriptions/${SUBSCRIPTION_NAME}
# Recreate the subscription
curl -u "admin:${PROVISIONING_ADMIN_PASSWORD}" -H 'Content-Type: application/json' -d @${TEMPORARY_CONSUMER_JSON}.json http://localhost:7777/v1/subscriptions
kill ${PROVISIONING_PORT_FORWARD_PID}
rm ${TEMPORARY_CONSUMER_JSON}
```
## v1.6.0+
### Pre-upgrade to v1.6.0+
#### Upstream constraint: Nubus' external secrets
**Target group:** Operators that use external secrets for Nubus.
> **Note**<br>
> External Secrets are not yet a supported feature. We are working on making it available in 2025, though it is possible to make use of the support for external secrets within single applications using the openDesk [customization](../helmfile/environments/default/customization.yaml.gotmpl) options.
Please ensure you read the [Nubus 1.10.0 "Migration steps" section](https://docs.software-univention.de/nubus-kubernetes-release-notes/1.x/en/changelog.html#v1-10-0-migration-steps) with focus on the paragraph "Operators that make use of the following UDM Listener secrets variables" and act accordingly.
#### Helmfile new secret: `secrets.minio.openxchangeUser`
**Target group:** All existing deployments that have OX App Suite enabled and that use externally defined secrets in combination with openDesk provided MinIO object storage.
For OX App Suite to access the object storage a new secret has been introduced.
It is declared in [`secrets.yaml.gotmpl`](../helmfile/environments/default/secrets.yaml.gotmpl) by the key: `secrets.minio.openxchangeUser`. If you define your own secrets, please ensure that you provide a value for this secret as well, otherwise the aforementioned secret will be derived from the `MASTER_PASSWORD`.
#### Helmfile new object storage: `objectstores.openxchange.*`
**Target group:** All deployments that use an external object storage.
For OX App Suite's newly introduced filestore you have to configure a new object storage (bucket). When you are using
an external object storage you did this already for all the entries in
[`objectstores.yaml.gotmpl`](../helmfile/environments/default/objectstores.yaml.gotmpl). Where we now introduced
`objectstores.openxchange` section that you also need to provide you external configuration for.
#### OX App Suite fix-up: Using S3 as storage for non mail attachments (pre-upgrade)
**Target group:** All existing deployments that have OX App Suite enabled.
With openDesk 1.6.0 OX App Suite persists the attachments on contact, calendar or task objects in object storage.
To enable the use of this new filestore backend existing deployments must execute the following steps.
Preparation:
- Ensure your `kubeconfig` is pointing to the cluster that is running your deployment.
- Identify/create a e.g. local temporary directory that can keep the attachments while upgrading openDesk.
- Set some environment variables to prepare running the documented commands:
```shell
export ATTACHMENT_TEMP_DIR=<your_temporary_directory_for_the_attachments>
export NAMESPACE=<your_namespace>
```
1. Copy the existing attachments from all `open-xchange-core-mw-default-*` Pods to the identified directory, example for `open-xchange-core-mw-default-0`:
```shell
kubectl cp -n ${NAMESPACE} open-xchange-core-mw-default-0:/opt/open-xchange/ox-filestore ${ATTACHMENT_TEMP_DIR}
```
2. Run the upgrade.
3. Continue with the [related post-upgrade steps](#ox-app-suite-fix-up-using-s3-as-storage-for-non-mail-attachments-post-upgrade)
### Post-upgrade to v1.6.0+
#### OX App Suite fix-up: Using S3 as storage for non mail attachments (post-upgrade)
**Target group:** All existing deployments having OX App Suite enabled.
Continued from the [related pre-upgrade section](#ox-app-suite-fix-up-using-s3-as-storage-for-non-mail-attachments-pre-upgrade).
1. Copy the attachments back from your temporary directory into `open-xchange-core-mw-default-0`.
```shell
kubectl cp -n ${NAMESPACE} ${ATTACHMENT_TEMP_DIR}/* open-xchange-core-mw-default-0:/opt/open-xchange/ox-filestore
```
2. Ideally you verify the files have been copied as expected checking the target directory in the `open-xchange-core-mw-default-0` Pod. All the following commands are for execution within the aforementioned Pod.
3. Get the `id` of the new object storage based OX filestore, using the following command in the first line of the following block. In the shown example output the `id` for the new filestore would be `10` as the filestore can be identified by its path value `s3://ox-filestore-s3`, the `id` of the existing filestore would be `3` identified by the corresponding path `/opt/open-xchange/ox-filestore`:
```shell
/opt/open-xchange/sbin/listfilestore -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW
id path size reserved used max-entities cur-entities
3 /opt/open-xchange/ox-filestore 100000 200 5 5000 1
10 s3://ox-filestore-s3 100000 0 0 5000 0
```
4. Get the list of your OX contexts IDs (`cid` column in the output of the `listcontext` command), as the next step needs to be executed per OX context. Most installation will just have a single OX context (`1`).
```shell
/opt/open-xchange/sbin/listcontext -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW
cid fid fname enabled qmax qused name lmappings
1 3 1_ctx_store true 5 1 1,context1
```
5. For each of your OX contexts IDs run the final filestore migration command and you will get output like this: `context 1 to filestore 10 scheduled as job 1`:
```shell
/opt/open-xchange/sbin/movecontextfilestore -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW -f <your_s3_filestore_id_from_step_3> -c <your_context_id_from_step_4>
```
6. Depending on the size of your filestore, moving the contexts will take some time. You can check the status of a context's jobs with the command below. When the job status is `Done` you can also doublecheck that everything worked as expected by running the `listfilestore` command from step #3 and should see that the filestore is no longer used.
```shell
/opt/open-xchange/sbin/jobcontrol -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW -c <your_context_id_from_step_4> -l
ID Type of Job Status Further Information
1 movefilestore Done move context 1 to filestore 10
```
7. Finally you can unregister the old filestore:
```shell
/opt/open-xchange/sbin/unregisterfilestore -A $MASTER_ADMIN_USER -P $MASTER_ADMIN_PW -i <your_old_filestore_id_from_step_3>
```
## v1.4.0+
### Pre-upgrade to v1.4.0+
#### Helmfile new feature: `functional.authentication.ssoFederation`
**Target group:** Deployments that make use of IdP federation as described in [`idp-federation.md`](./enhanced-configuration/idp-federation.md).
Please ensure to configure your IdP federation config details as part of `functional.authentication.ssoFederation`. You can find more details in the "Example configuration" section of [`idp-federation.md`](./enhanced-configuration/idp-federation.md).
#### Helmfile cleanup: `global.additionalMailDomains` as list
**Target group:** Installations that have set `global.additionalMailDomains`.
The `additionalMailDomains` had to be defined as a comma separated string. That now needs to change into a list of domains.
For example the following config:
```yaml
global:
additionalMailDomains: "sub1.maildomain.de,sub2.maildomain.de"
```
Needs to change to:
```yaml
global:
additionalMailDomains:
- "sub1.maildomain.de"
- "sub2.maildomain.de"
```
## v1.2.0+
### Pre-upgrade to v1.2.0+
#### Helmfile cleanup: Do not configure OX provisioning when no OX installed #### Helmfile cleanup: Do not configure OX provisioning when no OX installed
@@ -106,7 +325,7 @@ With openDesk 1.2.0 the OX provisioning consumer will not be registered when the
We do not remove the consumer for existing installations, if you want to do that for your existing installation please perform the following steps: We do not remove the consumer for existing installations, if you want to do that for your existing installation please perform the following steps:
``` ```shell
export NAMESPACE=<your_namespace> export NAMESPACE=<your_namespace>
kubectl -n ${NAMESPACE} exec -it ums-provisioning-nats-0 -c nats-box -- sh -c 'nats consumer rm stream:ox-connector durable_name:ox-connector --user=admin --password=${NATS_PASSWORD} --force' kubectl -n ${NAMESPACE} exec -it ums-provisioning-nats-0 -c nats-box -- sh -c 'nats consumer rm stream:ox-connector durable_name:ox-connector --user=admin --password=${NATS_PASSWORD} --force'
kubectl -n ${NAMESPACE} exec -it ums-provisioning-nats-0 -c nats-box -- sh -c 'nats stream rm stream:ox-connector --user=admin --password=${NATS_PASSWORD} --force' kubectl -n ${NAMESPACE} exec -it ums-provisioning-nats-0 -c nats-box -- sh -c 'nats stream rm stream:ox-connector --user=admin --password=${NATS_PASSWORD} --force'
@@ -157,30 +376,30 @@ In case you are planning to migrate an existing instance from MariaDB to Postgre
- https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature - https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature
- https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/ImportExport - https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/ImportExport
## From v1.1.1 ## v1.1.2+
### Pre-upgrade from v1.1.1 ### Pre-upgrade to v1.1.2+
#### Helmfile feature update: App settings wrapped in `apps.` element #### Helmfile feature update: App settings wrapped in `apps.` element
We require now [Helmfile v1.0.0-rc.8](https://github.com/helmfile/helmfile/releases/tag/v1.0.0-rc.8) for the deployment. This enables openDesk to lay the foundation for some significant cleanups where the information for the different apps especially on their `enabled` state is needed. We now require [Helmfile v1.0.0-rc.8](https://github.com/helmfile/helmfile/releases/tag/v1.0.0-rc.8) for the deployment. This enables openDesk to lay the foundation for some significant cleanups where the information from the different apps, especially their `enabled` state, is needed.
Therefore it was required to introduce the `apps` level in [`opendesk_main.yaml.gotmpl`](../helmfile/environments/default/opendesk_main.yaml.gotmpl). Therefore, it was necessary to introduce the `apps` level in [`opendesk_main.yaml.gotmpl`](../helmfile/environments/default/opendesk_main.yaml.gotmpl).
If you have a deployment where you specify settings that can be found in the aforementioned file, usually to disable components or enable others, please ensure you insert the top-level attribute `apps` like shown in the following example: If you have a deployment where you specify settings found in the aforementioned file, specifically to disable or enable components, please ensure you insert the top-level attribute `apps` as shown in the following example.
So a setting of: The following configuration:
``` ```yaml
certificates: certificates:
enabled: false enabled: false
notes: notes:
enabled: true enabled: true
``` ```
needs to be changed to: Needs to be changed to:
``` ```yaml
apps: apps:
certificates: certificates:
enabled: false enabled: false
@@ -188,23 +407,23 @@ apps:
enabled: true enabled: true
``` ```
## From v1.1.0 ## v1.1.1+
### Pre-upgrade from v1.1.0 ### Pre-upgrade to v1.1.1
#### Helmfile feature update: Component specific `storageClassName` #### Helmfile feature update: Component specific `storageClassName`
With openDesk 1.1.1 we support component specific `storageClassName` definitions beside the global ones, but we had to adapt the structure that can be found in `persistence.yaml.gotmpl` to achieve this in a clean manner. With openDesk 1.1.1 we support component specific `storageClassName` definitions beside the global ones. For this, we had to adapt the structure found in `persistence.yaml.gotmpl` to achieve this in a clean manner.
If you have set custom `persistence.size.*`-values for your deployment, please continue reading as you need to adapt your `persistence` settings to the new structure. If you have set custom `persistence.size.*`-values for your deployment, please continue reading as you need to adapt your `persistence` settings to the new structure.
When comparing the [old 1.1.0 structure](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/v1.1.0/helmfile/environments/default/persistence.yaml.gotmpl) with the [new one](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/v1.1.1/helmfile/environments/default/persistence.yaml.gotmpl) you can spot the changes: When comparing the [old v1.1.0 structure](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/v1.1.0/helmfile/environments/default/persistence.yaml.gotmpl) with the [new one](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/v1.1.1/helmfile/environments/default/persistence.yaml.gotmpl), you will spot these changes:
- We replaced `persistence.size` with `persistence.storages`. - We replaced `persistence.size` with `persistence.storages`.
- Below each component you can define now the `size` and the optional component specific `storageClassName`. - Below each component you can define now the `size` and the optional component specific `storageClassName`.
- We streamlined all components to be on the same level, as Nubus had an additional level of nesting before. - We streamlined the structure of the components by placing them on the same level, as beforehand, Nubus had an additional level of nesting.
So a setting of: The following configuration:
```yaml ```yaml
persistence: persistence:
@@ -212,7 +431,7 @@ persistence:
synapse: "1Gi" synapse: "1Gi"
``` ```
needs to be changed to: Needs to be changed to:
```yaml ```yaml
persistence: persistence:
@@ -221,7 +440,7 @@ persistence:
size: "1Gi" size: "1Gi"
``` ```
or for the Nubus related entries, the following: Or for the Nubus related entries, the following:
```yaml ```yaml
persistence: persistence:
@@ -230,7 +449,7 @@ persistence:
ldapServerData: "1Gi" ldapServerData: "1Gi"
``` ```
needs to be changed to: Needs to be changed to:
```yaml ```yaml
persistence: persistence:
@@ -241,29 +460,29 @@ persistence:
#### Helmfile new secret: `secrets.nubus.masterpassword` #### Helmfile new secret: `secrets.nubus.masterpassword`
A not yet templated secret was discovered in the Nubus deployment that is now defined in [`secrets.yaml.gotmpl`](../helmfile/environments/default/theme.yaml.gotmpl) with the key `secrets.nubus.masterpassword`. If you define your own secrets, please be sure this new secret is set to the value of the `MASTER_PASSWORD` environment variable used in your deployment. A not yet templated secret was discovered in the Nubus deployment. It is now declared in [`secrets.yaml.gotmpl`](../helmfile/environments/default/secrets.yaml.gotmpl) and can be defined using: `secrets.nubus.masterpassword`. If you define your own secrets, please be sure this new secret is set to the same value as the `MASTER_PASSWORD` environment variable used in your deployment.
## From v1.0.0 ## v1.1.0+
### Pre-upgrade from v1.0.0 ### Pre-upgrade to v1.1.0
#### Helmfile cleanup: Restructured `/helmfile/files/theme` folder #### Helmfile cleanup: Restructured `/helmfile/files/theme` folder
If you make use of the [theme folder](../helmfile/files/theme/) or the [`theme.yaml.gotmpl`](../helmfile/environments/default/theme.yaml.gotmpl), e.g. to applying your own imagery, please ensure you adhere to the new structure of the folder and the yaml-file. If you make use of the [theme folder](../helmfile/files/theme/) or the [`theme.yaml.gotmpl`](../helmfile/environments/default/theme.yaml.gotmpl), e.g. to apply your own imagery, please ensure you adhere to the new structure of the folder and the yaml-file.
#### Helmfile cleanup: Consistent use of `*.yaml.gotmpl` #### Helmfile cleanup: Consistent use of `*.yaml.gotmpl`
In v1.0.0 the files in [`/helmfile/environments/default`](../helmfile/environments/default/) had mixed extensions, In v1.0.0 the files in [`/helmfile/environments/default`](../helmfile/environments/default/) had mixed file extensions.
we have streamlined them to consistently use `*.yaml.gotmpl`. Now we have streamlined this and consistently use the `*.yaml.gotmpl` file extension.
This change requires manual action likely in two situations: This change likely requires manual action in two situations:
1. You are referencing our upstream files from the aforementioned directory, e.g. in your Argo CD deployment. Please update your references to use the filenames with the new extension. 1. You are referencing our upstream files from the aforementioned directory, e.g. in your Argo CD deployment. If so, please update your references to use the filenames with the new extension.
2. You have custom files containing configuration information that are named just `*.yaml`: Please rename them to `*.yaml.gotmpl`. 2. You have custom files containing configuration information that are simply named `*.yaml`. If so, please rename them to `*.yaml.gotmpl`.
#### Helmfile cleanup: Prefixing certain app directories with `opendesk-` #### Helmfile cleanup: Prefixing certain app directories with `opendesk-`
To make it more obvious that some elements from below the [`apps`](../helmfile/apps/) directory are completely To make it more obvious that some elements from within the [`apps`](../helmfile/apps/) directory are solely
provided by openDesk, we have prefixed these app directories with `opendesk-`. provided by openDesk, we have prefixed these app directories with `opendesk-`.
Affected are the following directories, here listed directly with the new prefix: Affected are the following directories, here listed directly with the new prefix:
@@ -274,28 +493,28 @@ Affected are the following directories, here listed directly with the new prefix
The described changes most likely require manual action in the following situation: The described changes most likely require manual action in the following situation:
- You are referencing our upstream files e.g. in your Argo CD deployment, please update your references to use the new directory names. - You are referencing our upstream files e.g. in your Argo CD deployment. If so, please update your references to use the new directory names.
#### Helmfile cleanup: Helmfile cleanup: Splitting external vs. openDesk services #### Helmfile cleanup: Splitting external services and openDesk services
In v1.0.0 there was a directory `/helmfile/apps/services` that was intended to contain all the services an operator had to provide externally for production deployments. In v1.0.0 there was a directory `/helmfile/apps/services` that was intended to contain all the services an operator had to provide externally for production deployments.
As some services that are actually part of openDesk snuck in there, so we had to split the directory into two separate ones: As some services that are actually part of openDesk snuck in there, we had to split the directory into two separate ones:
- [`./helmfile/apps/opendesk-services`](../helmfile/apps/opendesk-services) - [`./helmfile/apps/opendesk-services`](../helmfile/apps/opendesk-services)
- [`./helmfile/apps/services-external`](../helmfile/apps/services-external) - [`./helmfile/apps/services-external`](../helmfile/apps/services-external)
The described changes most likely require manual action in the following situation: The described changes most likely require manual action in the following situation:
- You are referencing our upstream files e.g. in your Argo CD deployment, please update your references to use the new directory names. - You are referencing our upstream files e.g. in your Argo CD deployment. If so, please update your references to use the new directory names.
#### Helmfile cleanup: Streamlining `openxchange` and `oxAppSuite` attribute names #### Helmfile cleanup: Streamlining `openxchange` and `oxAppSuite` attribute names
We have updated some attribute names around Open-Xchange / OX App Suite to be consistent within our Helmfile We have updated some attribute names within the Open-Xchange / OX App Suite to be consistent within our Helmfile
deployment and to aligning with the actual brand names as well as with our rule of thumb for brand based deployment. This change also aligns us with the actual brand names, as well as our rule of thumb for brand based
attribute names[^1]. attribute names[^1].
In case you are using any of the customizations below (`WAS`), please update as shown (`NOW`): In case you are using any of the customizations below, the (`WAS`) values, please update to the (`NOW`) values:
``` ```
WAS: oxAppsuite: ... WAS: oxAppsuite: ...
@@ -354,7 +573,9 @@ NOW: secrets.oxAppSuite: ...
#### Helmfile feature update: Dicts to define `customization.release` #### Helmfile feature update: Dicts to define `customization.release`
If you make use of the `customization.release` option, you have to switch to a dictionary based definition of customization files e.g. from If you make use of the `customization.release` option, you have to switch to a dictionary based definition of customization files, for example:
The following:
```yaml ```yaml
customization: customization:
@@ -362,7 +583,7 @@ customization:
collaboraOnline: "./my_custom_templating.yaml.gotmpl" collaboraOnline: "./my_custom_templating.yaml.gotmpl"
``` ```
to Needs to be changed to:
```yaml ```yaml
customization: customization:
@@ -375,7 +596,7 @@ You can freely choose the `file1` dictionary key used in the example above, but
#### openDesk defaults (new): Enforce login #### openDesk defaults (new): Enforce login
Users accessing the openDesk portal are now automatically redirected to the login screen as a default. Users accessing the openDesk portal are now automatically redirected to the login screen per default.
In case you want to keep the previous behavior you need to set the following `functional` flag: In case you want to keep the previous behavior you need to set the following `functional` flag:
@@ -391,7 +612,7 @@ The default to store the Jitsi room history in the local storage of a user's bro
It is now enabled and therefore stored by default. It is now enabled and therefore stored by default.
To preserve the 1.0.0 behavior of not storing the room history you have to explicitly configure it: To preserve the v1.0.0 behavior of not storing the room history you have to explicitly configure it:
```yaml ```yaml
functional: functional:
@@ -402,45 +623,46 @@ functional:
#### External requirements: Redis 7.4 #### External requirements: Redis 7.4
The update from openDesk 1.0.0 contains Redis 7.4.1, like the other openDesk bundled services the bundled Redis is as well not meant to be used in production. The update from openDesk v1.0.0 contains Redis 7.4.1, like the other openDesk bundled services, the bundled Redis is not meant to be used in production.
Please ensure for the Redis you are using that it is updated to at least 7.4 to support the requirement of OX App Suite. Please ensure the Redis you are using is updated to at least version 7.4 to support the requirement of OX App Suite.
### Post-upgrade from v1.0.0 ### Post-upgrade to v1.1.0+
#### XWiki fix-ups #### XWiki fix-ups
Unfortunately XWiki does not upgrade itself as expected. A bug with the supplier has already been filed. The following additional steps are required: Unfortunately XWiki does not upgrade itself as expected. The bug has been reported and the supplier is aware. The following additional steps are required:
1. To enforce re-indexing of the now fixed full-text search access the XWiki Pod and run the following commands to delete two search related directories. To complete this you need to restart the XWiki Pod, but that is anyway part of the next step: 1. To enforce re-indexing of the now fixed full-text search, access the XWiki Pod and run the following commands to delete two search related directories:
``` ```
rm -rf /usr/local/xwiki/data/store/solr/search_9 rm -rf /usr/local/xwiki/data/store/solr/search_9
rm -rf /usr/local/xwiki/data/cache/solr/search_9 rm -rf /usr/local/xwiki/data/cache/solr/search_9
``` ```
> The pod will need to be restarted for the changes to take effect.
2. This is necessary if the openDesk single sign-on does not longer work and you get a standard XWiki login dialogue instead. 2. This is necessary if the openDesk single sign-on no longer works, and you get a standard XWiki login dialogue instead:
- Find the XWiki ConfigMap `xwiki-init-scripts` and find in its `entrypoint` key data the lines beginning with `xwiki_replace_or_add "/usr/local/xwiki/data/xwiki.cfg"` - Find the XWiki ConfigMap `xwiki-init-scripts` and locate in the `entrypoint` key the lines beginning with `xwiki_replace_or_add "/usr/local/xwiki/data/xwiki.cfg"`
- Before those lines add the following line, of course setting `<YOUR_TEMPORARY_SUPERADMIN_PASSWORD>` to a value you are happy with. - Before those lines, add the following line while setting `<YOUR_TEMPORARY_SUPERADMIN_PASSWORD>` to a value you are happy with:
``` ```
xwiki_replace_or_add "/usr/local/xwiki/data/xwiki.cfg" 'xwiki.superadminpassword' '<YOUR_TEMPORARY_SUPERADMIN_PASSWORD>' xwiki_replace_or_add "/usr/local/xwiki/data/xwiki.cfg" 'xwiki.superadminpassword' '<YOUR_TEMPORARY_SUPERADMIN_PASSWORD>'
``` ```
- Restart the XWiki Pod. - Restart the XWiki Pod.
- Access XWiki's web UI and login with `superadmin` and the above set password. - Access XWiki's web UI and login with `superadmin` and the password you set above.
- Once XWiki UI is fully rendered, remove the line with the temporary `superadmin` password from the aforementioned ConfigMap. - Once XWiki UI is fully rendered, remove the line with the temporary `superadmin` password from the aforementioned ConfigMap.
- Restart the XWiki Pod. - Restart the XWiki Pod.
You should have now a properly working XWiki instance with single sign-on and full-text search. You should have now a fully functional XWiki instance with single sign-on and full-text search.
## From v0.9.0 ## v1.1.0
### Pre-upgrade from v0.9.0 ### Pre-upgrade to v1.1.0
#### Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus #### Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus
> **Warning**<br> > **Warning**<br>
> The upgrade will fail if you do not address this section for your current deployment. > The upgrade will fail if you do not address this section in your current deployment.
The update will remove unnecessary OX-Profiles in Nubus, but it can not as long as these profiles are in use. The update will remove unnecessary OX-Profiles in Nubus, so long as these profiles are in use.
So please ensure that only the following two supported profiles are assigned to your users: So please ensure that only the following two supported profiles are assigned to your users:
- `opendesk_standard`: "opendesk Standard" - `opendesk_standard`: "opendesk Standard"
@@ -458,14 +680,14 @@ You can review and update other accounts as follows:
- Open the user. - Open the user.
- Go to section "OX App Suite". - Go to section "OX App Suite".
- Change the value in the dropdown "OX Access" to either: - Change the value in the dropdown "OX Access" to either:
- "openDesk Standard" if the user should be able to use the Groupware module or - "openDesk Standard" if the user should be able to use the Groupware module.
- "Login disabled" if the user should not use the Groupware module. - "Login disabled" if the user should not use the Groupware module.
- Update the user account with the green "SAVE" button at the top of the page. - Update the user account with the green "SAVE" button at the top of the page.
#### Configuration Cleanup: Updated `global.imagePullSecrets` #### Configuration Cleanup: Updated `global.imagePullSecrets`
Without using a custom registry, you can pull all the openDesk images without authentication. Without using a custom container image registry, you can pull all the openDesk images without authentication.
Thus defining not existing imagePullSecrets creates unnecessary errors, so we removed them. Thus defining non-existent imagePullSecrets creates unnecessary errors, so we removed them.
You can keep the current settings by setting the `external-registry` in your custom environment values: You can keep the current settings by setting the `external-registry` in your custom environment values:
@@ -479,7 +701,7 @@ global:
Show other user's Matrix presence status is now disabled by default to comply with data protection requirements. Show other user's Matrix presence status is now disabled by default to comply with data protection requirements.
To enable it or keep the v0.9.0 default please set: To enable it or keep the v0.9.0 default, please set:
```yaml ```yaml
functional: functional:
@@ -490,23 +712,22 @@ functional:
#### Changed openDesk defaults: Matrix ID #### Changed openDesk defaults: Matrix ID
Until 0.9.0 openDesk used the LDAP entryUUID of a user to generate the user's Matrix ID. Due to restrictions on the Until v0.9.0 openDesk used the LDAP entryUUID of a user to generate the user's Matrix ID. Due to restrictions of the
Matrix protocol, an update of a Matrix ID is not possible; therefore, it was technically convenient to use the UUID Matrix protocol, an update to a Matrix ID is not possible. Therefore, it was technically convenient to use the UUID
as it is immutable (see https://de.wikipedia.org/wiki/Universally_Unique_Identifier for more details on UUIDs.) as they are immutable (see https://en.wikipedia.org/wiki/Universally_unique_identifier for more details on UUIDs.)
From the user experience perspective, that was a flawed approach, so from openDesk 1.0 on, by default, the username which From the user experience perspective, that was a flawed approach, so from openDesk 1.0 onwards, by default, the openDesk login username is used to define the `localpart` of the Matrix ID.
is also used for logging into openDesk is used to define the localpart of the Matrix ID.
For existing installations: The changed setting only affects users who log in to Element for the first time. Existing For existing installations: The changed setting only affects users who log in to Element for the first time. Existing
user accounts will not be harmed. If you want existing users to get new Matrix IDs based on the new setting, you user accounts will not be harmed. If you want existing users to get new Matrix IDs based on the new setting, you
must update their external ID in Synapse and deactivate the old user afterward. The user will get a new must update their external ID in Synapse and deactivate the old user afterward. The user will get a completely new
Matrix account from scratch, losing the existing contacts, chats, and rooms. Matrix account, losing their existing contacts, chats, and rooms.
The following Admin API calls are helpful: The following Admin API calls are helpful:
- `GET /_synapse/admin/v2/users/@<entryuuid>:<matrixdomain>` to get the user's existing external_id (auth_provider: "oidc") - `GET /_synapse/admin/v2/users/@<entryuuid>:<matrixdomain>` get the user's existing external_id (auth_provider: "oidc")
- `PUT /_synapse/admin/v2/users/@<entryuuid>:<matrixdomain>` to update user's external_id with JSON payload: - `PUT /_synapse/admin/v2/users/@<entryuuid>:<matrixdomain>` update user's external_id with JSON payload:
`{ "external_ids": [ { "auth_provider": "oidc", "external_id": "<old_id>+deprecated" } ] }` `{ "external_ids": [ { "auth_provider": "oidc", "external_id": "<old_id>+deprecated" } ] }`
- `POST /_synapse/admin/v1/deactivate/@<entryuuid>:<matrixdomain>` to deactivate old user with JSON payload: - `POST /_synapse/admin/v1/deactivate/@<entryuuid>:<matrixdomain>` deactivate old user with JSON payload:
`{ "erase": true }` `{ "erase": true }`
For more details, check the Admin API documentation: For more details, check the Admin API documentation:
@@ -523,7 +744,7 @@ functional:
#### Changed openDesk defaults: File-share configurability #### Changed openDesk defaults: File-share configurability
Now, we provide some configurability regarding the sharing capabilities of the Nextcloud component. We now provide some configurability regarding the sharing capabilities of the Nextcloud component.
See the settings under `functional.filestore` in [functional.yaml](../helmfile/environments/default/functional.yaml). See the settings under `functional.filestore` in [functional.yaml](../helmfile/environments/default/functional.yaml).
@@ -554,7 +775,7 @@ This results in the following changes to the default subdomain naming:
- **nextcloud**: `fs` → `files` - **nextcloud**: `fs` → `files`
- **openproject**: `project` → `projects` - **openproject**: `project` → `projects`
Existing deployments should keep the old subdomains cause URL/link changes are not supported through all components. Existing deployments should keep the old subdomains because URL/link changes are not supported through all components.
If you have not already defined the entire `global.hosts` dictionary in your custom environments values, please set it If you have not already defined the entire `global.hosts` dictionary in your custom environments values, please set it
to the defaults that were used before the upgrade: to the defaults that were used before the upgrade:
@@ -584,22 +805,21 @@ global:
xwiki: "wiki" xwiki: "wiki"
``` ```
In case you would like to update an existing deployment to the new hostnames, please check the following list: In case you would like to update an existing deployment to use the new hostnames, you would be doing so at your own risk, so please consider the following:
- Do this at your own risk.
- Some of your user's bookmarks and links will stop working. - Some of your user's bookmarks and links will stop working.
- Portal links are getting updated automatically. - Portal links will get updated automatically.
- The update of the OpenProject <-> Nextcloud file integration needs to be updated manually as follows: - The update of the OpenProject <-> Nextcloud file integration needs to be updated manually as follows:
- Use an account with functional admin permissions on both components - Use an account with functional admin permissions for both Nextcloud and OpenProject
- In OpenProject: *Administration* > *Files* > *External file storages* > Select `Nextcloud at [your_domain]` - In Nextcloud: *Administration* > *Files* > *External file storages* > Select `Nextcloud at [your_domain]`
- Edit *Details* - *General Information* - *Storage provider* and update the *hostname* to `files.<your_domain>` - Edit *Details* - *General Information* - *Storage provider* and update the *hostname* to `files.<your_domain>`
- In Nextcloud: *Administration* > *OpenProject* > *OpenProject server* - In OpenProject: *Administration* > *OpenProject* > *OpenProject server*
- Update the *OpenProject host* to `projects.<your_domain>` - Update the *OpenProject host* to `projects.<your_domain>`
#### Changed openDesk defaults: Dedicated group for access to the UDM REST API #### Changed openDesk defaults: Dedicated group for access to the UDM REST API
Prerequisite: You allow the use of the [IAM's API](https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html) Prerequisite: You allow the use of the [IAM's API](https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html)
with the following settings: with the following setting:
```yaml ```yaml
functional: functional:
@@ -609,36 +829,36 @@ functional:
enabled: true enabled: true
``` ```
With 0.9.0, all members of the group "Domain Admins" could successfully authenticate with the API. With v0.9.0, all members of the group "Domain Admins" could successfully authenticate with the API.
With openDesk 1.0, we introduced a specific group for permission to use the API: `IAM API - Full Access`. With openDesk 1.0, we introduced a specific group for permission to use the API: `IAM API - Full Access`.
The IAMs admin account `Administrator` is a member of this group by default, but no other user is. The IAM admin account `Administrator` is the only member of this group by default.
If you need other accounts to use the API, please assign them to the aforementioned group. If you need other accounts to use the API, please assign them to the aforementioned group.
### Post-upgrade from v0.9.0 ### Post-upgrade to v1.0.0+
#### Configuration Improvement: Separate user permission for using Video Conference component #### Configuration Improvement: Separate user permission for using Video Conference component
With openDesk 1.0 the user permission for authenticated access to the Chat and Video Conference components was split into two separate permissions. With openDesk 1.0 the user permission for authenticated access to the Chat and Video Conference components was split into two separate permissions.
Therefore the newly added *Video Conference* permission has to be added to users that should have continued access to the component. Therefore, the newly added *Video Conference* permission has to be added to users that should have continued access to the component.
This can be done as IAM admin: This can be done as IAM admin:
- Open the *user* module. - Open the *user* module.
- Select all users that should get the permission for *Video Conference* using the select box left from the users entry. - Select all users that should get the permission for *Video Conference* using the checkbox left of the users' entry.
- In top bar of the user table click on *Edit*. - In top bar of the user table click on *Edit*.
- Select the *openDesk* section the the left-hand menu. - Select the *openDesk* section from the left-hand menu.
- Check the check box for *Video Conference* and the directly below check box for *Overwrite*. - Check the checkbox for *Video Conference* and the directly below check box for *Overwrite*.
- Click on the green *Save* button on top of the screen to apply the change. - Click on the green *Save* button at the top of the screen to apply the change.
> **Hint**<br> > **Hint**<br>
> If you have a lot of users andd want to update (almost) all them, you can select all users by clicking the check box in the user's table header and then de-selecting the users you do not want to update. > If you have a lot of users and want to update (almost) all them, you can select all users by clicking the checkbox in the user's table header and then de-selecting the users you do not want to update.
#### Optional Cleanup #### Optional Cleanup
We do not execute possible cleanup steps as part of the migrations POST stage. So you might want to remove the no longer used PVCs after a successful upgrade: We do not execute possible cleanup steps as part of the migrations POST stage. So you might want to remove the unclaimed PVCs after a successful upgrade:
```shell ```shell
NAMESPACE=<your_namespace> NAMESPACE=<your_namespace>
@@ -647,46 +867,35 @@ kubectl -n ${NAMESPACE} delete pvc shared-run-ums-ldap-server-0
kubectl -n ${NAMESPACE} delete pvc ox-connector-ox-contexts-ox-connector-0 kubectl -n ${NAMESPACE} delete pvc ox-connector-ox-contexts-ox-connector-0
``` ```
## From v0.8.1
### Pre-upgrade from v0.8.1
#### Updated `cluster.networking.cidr`
- Action: `cluster.networking.cidr` is now an array (was a string until 0.8.1); please update your setup accordingly if you explicitly set this value.
- Reference:[cluster.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/cluster.yaml)
#### Updated customizable template attributes
- Action: Please update your custom deployment values according to the updated default value structure.
- References:
- `functional.` prefix for `authentication.*`, `externalServices.*`, `admin.*` and `filestore.*`, see [functional.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/functional.yaml).
- `debug.` prefix for `cleanup.*`, see [debug.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/debug.yaml).
- `monitoring.` prefix for `prometheus.*` and `graphana.*`, see [monitoring.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/monitoring.yaml).
- `smtp.` prefix for `localpartNoReply`, see [smtp.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/smtp.yaml).
#### `migrations` S3 bucket
- Action: For self-managed/external S3/object storages, please ensure you add a bucket `migrations` to your S3.
- Reference: `objectstores.migrations` in [objectstores.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/objectstores.yaml)
# Automated migrations - Details # Automated migrations - Details
## From v1.1.2 (automated) ## v1.6.0+ (automated)
> **Note**<br>
> Details can be found in [run_5.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_5.py).
### v1.6.0+ migrations-post
Restarting the StatefulSets `ums-provisioning-nats` and `ox-connector` due to a workaround applied on the NATS secrets, see the "Notes" segment of the ["Password seed" heading in getting-started.md](./docs/getting-started.md#password-seed)
> **Note**<br>
> This change aims to prevent authentication failures with NATS in some Pods, which can lead to errors such as: `wait-for-nats Unavailable, waiting 2 seconds. Error: nats: 'Authorization Violation'`.
## v1.2.0+ (automated)
> **Note**<br> > **Note**<br>
> Details can be found in [run_4.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_4.py). > Details can be found in [run_4.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_4.py).
### migrations-pre ### v1.2.0+ migrations-pre
- Delete PVC `group-membership-cache-ums-portal-consumer-0`: With the upgrade the Nubus Portal Consumer no longer requires to be executed with root privileges. The PVC contains files that require root permission to access them, therefore the PVC gets deleted (and re-created) during the upgrade. - Delete PVC `group-membership-cache-ums-portal-consumer-0`: With the upgrade the Nubus Portal Consumer no longer requires to be executed with root privileges. The PVC contains files that require root permission to access them, therefore the PVC gets deleted (and re-created) during the upgrade.
- Delete StatefulSet `ums-portal-consumer`: A bug was fixed in the templating of the Portal Consumer's PVC causing the values in `persistence.storages.nubusPortalConsumer.*` to be ignored. As these values are immutable, we had to delete the whole StatefulSet. - Delete StatefulSet `ums-portal-consumer`: A bug was fixed in the templating of the Portal Consumer's PVC causing the values in `persistence.storages.nubusPortalConsumer.*` to be ignored. As these values are immutable, we had to delete the whole StatefulSet.
### migrations-post ### v1.2.0+ migrations-post
- Restarting Deployment `ums-provisioning-udm-transformer` and StatefulSet `ums-provisioning-udm-listener` as well as deleting the Nubus Provisioning consumer `durable_name:incoming` on stream `stream:incoming`: Due to a bug in Nubus 1.7.0 the `incoming` stream was blocked after the upgrade, the aforementioned measures unblock the stream. - Restarting Deployment `ums-provisioning-udm-transformer` and StatefulSet `ums-provisioning-udm-listener` as well as deleting the Nubus Provisioning consumer `durable_name:incoming` on stream `stream:incoming`: Due to a bug in Nubus 1.7.0 the `incoming` stream was blocked after the upgrade, the aforementioned measures unblock the stream.
## From v1.0.0 (automated) ## v1.1.0+ (automated)
With openDesk v1.1.0 the IAM stack supports HA LDAP primary as well as scalable LDAP secondary pods. With openDesk v1.1.0 the IAM stack supports HA LDAP primary as well as scalable LDAP secondary pods.
@@ -697,18 +906,18 @@ creating the config map with the mentioned label.
> **Note**<br> > **Note**<br>
> Details can be found in [run_3.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_3.py). > Details can be found in [run_3.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_3.py).
## From v0.9.0 (automated) ## v1.0.0+ (automated)
The `migrations-pre` and `migrations-post` jobs in the openDesk deployment address the automated migration tasks. The `migrations-pre` and `migrations-post` jobs in the openDesk deployment address the automated migration tasks.
The permissions required to execute the migrations can be found in the migration's Helm chart [`role.yaml'](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/v1.3.5/charts/opendesk-migrations/templates/role.yaml?ref_type=tags#L29) The permissions required to execute the migrations can be found in the migration's Helm chart [`role.yaml'](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/v1.3.5/charts/opendesk-migrations/templates/role.yaml?ref_type=tags#L29).
> **Note**<br> > **Note**<br>
> Details can be found in [run_2.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_3.py). > Details can be found in [run_2.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_3.py).
## Related components and artifacts ## Related components and artifacts
openDesk comes with two upgrade steps as part of the deployment; they can be found in the folder [/helmfile/apps](../helmfile/apps/) as all other components: openDesk comes with two upgrade steps as part of the deployment; they can be found in the folder [/helmfile/apps](../helmfile/apps/) along with all other components:
- `migrations-pre`: Is the very first app that gets deployed. - `migrations-pre`: Is the very first app that gets deployed.
- `migrations-post`: Is the last app that gets deployed. - `migrations-post`: Is the last app that gets deployed.

View File

@@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0
<h1>Monitoring</h1> <h1>Monitoring</h1>
This document will cover how you can enable observability with Prometheus-based monitoring and Grafana dashboards as This document will cover how you can enable observability with Prometheus-based monitoring and Grafana dashboards as
well as the overall status of monitoring integration. well as the overall status of the monitoring integration.
<!-- TOC --> <!-- TOC -->
* [Technology](#technology) * [Technology](#technology)
@@ -19,12 +19,11 @@ well as the overall status of monitoring integration.
# Technology # Technology
We provide integration into the Prometheus-based monitoring. openDesk includes integration with Prometheus-based monitoring.
Together with
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) you
easily leverage the full potential of the open-source cloud-native observability stack.
Before enabling the following options, you need to install the respective CRDs from the kube-prometheus-stack Together with [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack), you can easily leverage the full potential of the open-source cloud-native observability stack.
Before enabling the following options, you need to install the respective custom resource definitions (CRDs) from the kube-prometheus-stack
repository or Prometheus operator. repository or Prometheus operator.
# Defaults # Defaults
@@ -38,10 +37,10 @@ To deploy `podMonitor` and `serviceMonitor` custom resources, enable it by:
```yaml ```yaml
prometheus: prometheus:
  serviceMonitors: serviceMonitors:
    enabled: true enabled: true
  podMonitors: podMonitors:
    enabled: true enabled: true
``` ```
# Alerts # Alerts
@@ -53,25 +52,25 @@ All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev
```yaml ```yaml
prometheus: prometheus:
  prometheusRules: prometheusRules:
    enabled: true enabled: true
``` ```
# Dashboards for Grafana # Dashboards for Grafana
To deploy optional ConfigMaps with Grafana dashboards, enable it by: To deploy optional Grafana dashboards with ConfigMaps, enable the functionality with:
```yaml ```yaml
grafana: grafana:
  dashboards: dashboards:
    enabled: true enabled: true
``` ```
Please find the details in the [related Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-dashboards). Please find further details in the [related Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-dashboards).
# Component overview # Component overview
| Component | Metrics (pod- or serviceMonitor)  | Alerts (prometheusRule) | Dashboard (Grafana) | | Component | Metrics (pod- or serviceMonitor) | Alerts (prometheusRule) | Dashboard (Grafana) |
|:----------|-----------------------------------|-------------------------|---------------------| |:----------|----------------------------------|-------------------------|---------------------|
| Collabora | :white_check_mark:                | :white_check_mark:      | :white_check_mark:  | | Collabora | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Nextcloud | :white_check_mark:                | :x:                     | :x:                 | | Nextcloud | :white_check_mark: | :x: | :x: |

View File

@@ -20,7 +20,7 @@ openDesk uses role-based access control (RBAC) to manage permissions. This syste
* [Administrative access to applications](#administrative-access-to-applications) * [Administrative access to applications](#administrative-access-to-applications)
* [Custom groups](#custom-groups) * [Custom groups](#custom-groups)
* [Assigning roles/groups and permissions](#assigning-rolesgroups-and-permissions) * [Assigning roles/groups and permissions](#assigning-rolesgroups-and-permissions)
* [Predefined roles / user templates](#predefined-roles--user-templates) * [Predefined roles/user templates](#predefined-rolesuser-templates)
* [*openDesk User*](#opendesk-user) * [*openDesk User*](#opendesk-user)
* [*openDesk Administrator*](#opendesk-administrator) * [*openDesk Administrator*](#opendesk-administrator)
* [Managing permissions](#managing-permissions) * [Managing permissions](#managing-permissions)
@@ -30,36 +30,36 @@ openDesk uses role-based access control (RBAC) to manage permissions. This syste
* [Delegation](#delegation) * [Delegation](#delegation)
* [Regular review](#regular-review) * [Regular review](#regular-review)
* [Applications](#applications) * [Applications](#applications)
* [Roles/groups](#rolesgroups) * [Roles/Groups](#rolesgroups)
<!-- TOC --> <!-- TOC -->
# Identity and Access Management (IAM) # Identity and Access Management (IAM)
Within openDesk's Identity and Access Management component Nubus the openDesk user accounts are managed, as well as some core roles and permissions. Within openDesk's Identity and Access Management component, Nubus, openDesk user accounts are managed, as well as some core roles and permissions.
## Permissions ## Permissions
A permission represents a specific authorization that defines an action a user is allowed to perform on a resource. A permission represents a specific authorization that defines an action a user is allowed to perform on a resource.
As openDesk consists of multiple applications, each application may have different needs regarding its fine-grained internal permissions, usually these permissions are manged within each component. As openDesk consists of multiple applications, each application may have different needs regarding its fine-grained internal permissions. Usually these permissions are manged within each component.
The overall permissions to access the application as well as group membership of users is managed in the IAM. The high-level permissions required to access the application, as well as group membership of users is managed in the IAM.
## Roles ## Roles
Roles are defined sets of permissions that can be assigned to users. Each role corresponds to a specific set of tasks and responsibilities within the system. In openDesk's IAM, two roles are defined by default: Roles are defined sets of permissions that can be assigned to users. Each role corresponds to a specific set of tasks and responsibilities within the system. In openDesk's IAM, two roles are defined by default:
- **openDesk Administrator**: Manages openDesk-global settings, such as users and groups. - **openDesk Administrator**: Manages openDesk-global settings, such as users and groups.
- **openDesk User**: Can login to openDesk to make use of defined openDesk applications. - **openDesk User**: Can log in to openDesk to make use of defined openDesk applications.
> **Note**<br> > **Note**<br>
> It is strongly recommended that a user account is not granted both roles at the same time to address the segregation of duties, though it is not enforced by openDesk. > Although it is not enforced by openDesk, it is strongly recommended that a user account is not granted both roles at the same time. This is to maintain the separation of duties.
### Application usage ### Application usage
To access and use applications in openDesk and to address [the principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege), a user needs to have the necessary permissions set. openDesk defines the following permissions to access applications: To access and use applications in openDesk and to address [the principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege), a user needs to have the necessary permissions set. openDesk defines the following permissions to access applications:
- **Groupware**: Use email, calendar and address book applications. - **Groupware**: Use email, calendar, and address book applications.
- **Chat**: Use the chat application. - **Chat**: Use the chat application.
- **Knowledge Management**: Use the wiki application. - **Knowledge Management**: Use the wiki application.
- **Project Management**: Use the project management application. - **Project Management**: Use the project management application.
@@ -76,32 +76,32 @@ For applications that provide application-specific administrative settings, open
## Groups ## Groups
Groups help in clustering users with similar responsibilities and enable easier assignment of roles or permissions. It is often the case that a group maps directly to a role. Groups help with clustering users with similar responsibilities and make it easier to assign roles or permissions. It is often the case that a group maps directly to a role.
openDesk predefines the following groups. openDesk includes predefined groups. Please see below.
### Global groups ### Global groups
- **Domain Users**: Members of this group are *openDesk Users*. - **Domain Users**: Members of this group are *openDesk Users*.
- **Domain Admins**: Members of this group are *openDesk IAM Administrators*. By default this group is also enable for two-factor authentication (2FA). - **Domain Admins**: Members of this group are *openDesk IAM Administrators*. By default, this group has two-factor authentication (2FA) enabled.
- **2fa-users**: Members of this group that are forced to use two-factor authentication (2FA). - **2fa-users**: Members of this group that are forced to use two-factor authentication (2FA).
- **IAM API - Full Access**: Members of this group have full (read and write) access to the IAM's REST API. - **IAM API - Full Access**: Members of this group have full (read and write) access to the IAM's REST API.
### Application groups ### Application groups
When editing a user in the IAM you can select if a user can access or get elevated admin permission for a specific application within the "openDesk" tab. The selection is stored as an attribute on the user object, but for other applications it is helpful to also expose the information as a group membership. Therefore openDesk comes with the following [groups](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/63-groups.yaml). When editing a user in the IAM, you can select if a user can access or get elevated admin permission for a specific application within the "openDesk" tab. The selection is stored as an attribute on the user object, but in other applications, it is helpful to also expose this information as a group membership. Therefore, openDesk comes with the following [groups](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/63-groups.yaml).
To easily identify these groups all of them are prefixed with `managed-by-Attribute-`. To easily identify these groups, all of them are prefixed with `managed-by-Attribute-`.
> **Note**<br> > **Note**<br>
> The membership of these groups is automatically managed, based on the user's attributes from the "openDesk" tab. So any changes directly to the groups will be overwritten, please always use the "openDesk" of the respective user. The IAM supports to edit user attributes in multiple accounts at once. > The membership of these groups is automatically managed based on the user's attributes from the "openDesk" tab. Any changes directly to the groups will be overwritten, so please always use the "openDesk" tab of the respective user. The IAM supports editing user attributes across multiple accounts simultaneously.
#### Standard access to applications #### Standard access to applications
Unless a user is member of a group the respective application is not shown in the portal. Unless a user is a member of a group, the respective application is not shown in the portal.
> **Note**<br> > **Note**<br>
> In openDesk's identity provider the required OIDC claims to access an application are only granted when the respective group membership is available. So even if a user who is not a member of an application group, knows the link to the application and calls it directly, the single sign-on will not be successful. > In openDesk's identity provider, the required OIDC claims to access an application are only granted when the respective group membership is available. This means that even if a user who is not a member of an application group knows the link to the application and calls it directly, the single sign-on will be unsuccessful.
- **managed-by-Attribute-Groupware**: Members of this group have access to the groupware applications. - **managed-by-Attribute-Groupware**: Members of this group have access to the groupware applications.
- **managed-by-Attribute-Fileshare**: Members of this group have access to the file sharing application. - **managed-by-Attribute-Fileshare**: Members of this group have access to the file sharing application.
@@ -126,11 +126,11 @@ While openDesk ships with predefined groups, additional groups can be [created](
Users get roles assigned based on their responsibilities and the tasks they need to perform. This assignment can be done by an admin through the [administration portal](https://docs.opendesk.eu/administration/). Users get roles assigned based on their responsibilities and the tasks they need to perform. This assignment can be done by an admin through the [administration portal](https://docs.opendesk.eu/administration/).
## Predefined roles / user templates ## Predefined roles/user templates
openDesk defines [templates](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/65-usertemplate.yaml) for the *User* and *Administrator* roles. The templates can be used to create users with these roles by an *openDesk Administrator* using the [administration portal](https://docs.opendesk.eu/administration/). openDesk defines [templates](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/65-usertemplate.yaml) for the *User* and *Administrator* roles. The templates can be used by an *openDesk Administrator* to create users with these roles using the [administration portal](https://docs.opendesk.eu/administration/).
> **Notes**<br> > **Note**<br>
> Additional/custom templates can be created using the UDM REST API. > Additional/custom templates can be created using the UDM REST API.
### *openDesk User* ### *openDesk User*
@@ -169,34 +169,34 @@ By using roles and permissions, openDesk ensures that users have the appropriate
## Hierarchies and delegation ## Hierarchies and delegation
The IAM allows the nesting of groups, in that case a group has no or not only users as members but other groups. The IAM allows for the nesting of groups, for example, a group can be both assigned to members and other groups, or just groups.
## Audit/Logging ## Audit/Logging
Univention is about to provide an audit logging which brings the idea of the [UCS based directory logger](https://docs.software-univention.de/manual/5.0/en/domain-ldap/ldap-directory.html#audit-proof-logging-of-ldap-changes) to Nubus. openDesk will offer this feature as soon as it is made available in Nubus. Univention is about to provide audit logging which brings the idea of the [UCS based directory logger](https://docs.software-univention.de/manual/5.0/en/domain-ldap/ldap-directory.html#audit-proof-logging-of-ldap-changes) to Nubus. openDesk will offer this feature as soon as it is made available in Nubus.
## Reporting ## Reporting
The IAM webinterface supports the export of reports for users and groups, which are the essential objects when it comes to permissions. These data exports can be subject to custom data analysis. The IAM webinterface supports the export of reports on users and groups, which are the essential objects when it comes to permissions. These data exports can be subjected to custom data analysis.
## Delegation ## Delegation
Currently the temporary assignment of roles is not supported. Role membership must be managed at the time of granting / revoking the membership. Currently, the temporary assignment of roles is not supported. Role membership must be managed at the time of granting / revoking the membership.
## Regular review ## Regular review
While the overall role and permission setup must be checked by the customer including the respective custom roles, the openDesk team is challenging and improving the role and permission management on a regular basis, e.g. to address the need for a distinct "support" role. While the overall role and permission setup must be checked by the customer, including the respective custom roles, the openDesk team constantly challenges and improves role and permission management, for example, addressing the need for a distinct "support" role.
# Applications # Applications
As managing all the application permissions within the IAM would require a superset of permissions to be available in the IAM causing a high level of administrative complexity, the permissions are usually managed within an application itself and mapped to roles/groups that are managed in the IAM. Managing all application permissions within the IAM would require a superset of permissions to be available in the IAM. This would lead to a high level of administrative complexity. Instead, the application specific permissions are usually managed within an application itself and mapped to roles/groups that are managed in the IAM.
## Roles/groups ## Roles/Groups
For each IAM group it can be configured for which openDesk application the group should be visible. Like with users this is done in the "openDesk" tab of the [group administration](https://docs.opendesk.eu/administration/gruppen/). Within IAM groups, the visibility of openDesk applications can be configured. Like with users, this is done in the "openDesk" tab of the [group administration](https://docs.opendesk.eu/administration/gruppen/).
> **Note**<br> > **Note**<br>
> Currently the openDesk applications do not support nested groups. As a result only direct group memberships of users are processed in the application.<br> > Currently the openDesk applications do not support nested groups. As a result only direct group memberships of users are processed in the application.<br>
> The plan is to enable the openDesk applications to either support nested groups or to actively provision users into an application while resolving the nested group memberships for the application. > The plan is to enable the openDesk applications to either support nested groups or to actively provision users into an application while resolving the nested group memberships for the application.
Within an application each available group can get a set of application specific permissions assigned. Within an application, each available group can have a set of application specific permissions assigned.

122
docs/releases.md Normal file
View File

@@ -0,0 +1,122 @@
<!--
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0
-->
<h1>Release management</h1>
This document outlines the release and patch management strategy for **openDesk**, ensuring that all updates, patches, and new releases are systematically **planned, tested, documented**, and **reliably deployed** into production. The process is designed to align with operational planning requirements and maintain system stability and security.
<!-- TOC -->
* [Release cycle](#release-cycle)
* [Release types](#release-types)
* [Release schedule](#release-schedule)
* [Upgrades](#upgrades)
* [Patch management process](#patch-management-process)
* [Patch identification \& prioritization](#patch-identification--prioritization)
* [Patch workflow](#patch-workflow)
* [Communication plan](#communication-plan)
* [Announcement channels](#announcement-channels)
* [Timing of communications](#timing-of-communications)
* [Documentation requirements](#documentation-requirements)
* [Compliance \& review](#compliance--review)
<!-- TOC -->
# Release cycle
openDesk follows a structured release cycle to ensure predictability and reliability:
## Release types
| Type | Frequency | Content |
|----------------|---------------|---------------------------------------------------------------|
| **Major** | Annually (Q3) | Large feature sets, architecture changes, breaking changes |
| **Minor** | Monthly | New features, enhancements, may contain breaking changes or refactors (clearly flagged in the notes) |
| **Patch** | On demand | Bug fixes, security updates, minor improvements, no intended breaking changes |
> **Note:** openDesk does **not** guarantee that minor releases are 100% backwardcompatible. When a breaking change is unavoidable it is announced in the release notes under a dedicated header **“Breaking Changes”** and a migration guide is provided.
## Release schedule
- **Major releases** are scheduled for **Q3 each year**, with planning beginning in Q1.
- **Minor releases** occur **monthly on Mondays**, typically **around 10:00 AM** local time.
- Each minor release follows a **4-week cycle**.
- **Week 13**: Active development of new features and improvements.
- **End of Week 3**: **Feature freeze** is enforced to allow stabilization and testing.
- **Week 4**: Final testing, approvals, and preparation for release.
- At the **end of Week 4**, a new minor version is released, and a new cycle begins.
- **Patch releases** are created **on demand**, based on criticality and urgency.
## Upgrades
- openDesk does not guarantee an inplace upgrade between two major versions. Always consult the release notes and plan appropriate migration efforts.
- Even within the same major line, skipping multiple monthly minor versions is not guaranteed to work without intermediate upgrade steps.
- All breaking changes, including those in monthly minor releases, are highlighted in the release notes under Breaking Changes.
- Additional, nonbinding migration hints are collected in `migrations.md`
# Patch management process
A standardized process ensures patches are developed, prioritized, and deployed efficiently.
## Patch identification & prioritization
Patches are categorized by severity and urgency:
| Priority Level | Criteria |
|----------------|--------------------------------------------------------------------------|
| **Critical** | Security vulnerabilities, system outages, data loss risks |
| **High** | Major bugs affecting multiple users, performance degradation |
| **Medium** | Functional bugs with workarounds, minor usability issues |
| **Low** | Cosmetic issues, documentation updates |
## Patch workflow
The following steps define the patch workflow from issue identification to post-deployment review. This process ensures consistent quality and minimal disruption to users:
1. **Identification**: Potential issues are detected through automated monitoring, internal testing, audits, or user reports submitted via the support ticketing system.
2. **Assessment**: The product and engineering teams triage the issue, determine severity based on business and user impact, and prioritize it within the patch queue.
3. **Development**: A fix is implemented on a dedicated feature or hotfix branch, adhering to coding standards and version control protocols.
4. **Testing**: All patches undergo automated unit and integration tests, as well as manual QA validation in a staging environment that closely mirrors production.
5. **Approval**: Once tested, the patch must be approved by the product owner or a designated release manager, with proper documentation and change control entries.
6. **Deployment**: The patch is rolled out using CI/CD pipelines during predefined deployment windows or as soon as possible for critical issues.
7. **Post-deployment review**: After deployment, the fix is verified in production, and monitoring tools are used to detect regressions or unintended side effects.
This workflow ensures that patches are handled with the same level of discipline as planned releases, supporting both reliability and agility.
# Communication plan
A lightweight approach reduces manual effort while maintaining transparency.
## Announcement channels
| Channel | Audience | Purpose | Owner |
|---------|----------|---------|-------|
| **openCode Changelog** | Community & EE | Primary source of truth for every release | DevOps |
| **AccountManager Mail / Ticket** | Enterprise customers | Targeted information & upgrade advice | Customer Success |
## Timing of communications
| Release Type | What | When |
|--------------|------|------|
| **Major** | Roadmap entry + migration highlights | 4 weeks before release |
| | Final confirmation | 1 week before release |
| **Minor** | Changelog entry (draft) | Immediately after feature freeze (end of week 3) |
| | EE mail/ticket | 2 business days before deployment |
| **Patch** | Changelog entry | Right after production deploy |
| | EE mail/ticket (only if impacted) | Within 1 business day |
Community users consume information via openCode; Enterprise customers get an additional nudge via their account manager  **no mass mailings are sent manually**.
# Documentation requirements
Each release (major, minor, or patch) must include:
- **Release notes** outlining new features, fixes, and known issues
- **Change logs** with commit references and affected components
- **Test reports** confirming QA coverage and results
- **Deployment checklist** reviewed and approved by the product owner
# Compliance & review
- The release process is reviewed **bi-annually** to incorporate feedback and evolving requirements
- Emergency patches (e.g., zero-day security issues) may bypass the standard schedule but must be documented post-deployment

View File

@@ -1,4 +1,5 @@
<!-- <!--
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
--> -->
@@ -12,6 +13,8 @@ This section covers the internal system requirements and external service requir
* [Hardware](#hardware) * [Hardware](#hardware)
* [Kubernetes](#kubernetes) * [Kubernetes](#kubernetes)
* [Ingress controller](#ingress-controller) * [Ingress controller](#ingress-controller)
* [Supported controllers](#supported-controllers)
* [Minimal configuration](#minimal-configuration)
* [Volume provisioner](#volume-provisioner) * [Volume provisioner](#volume-provisioner)
* [Certificate management](#certificate-management) * [Certificate management](#certificate-management)
* [External services](#external-services) * [External services](#external-services)
@@ -23,30 +26,31 @@ This section covers the internal system requirements and external service requir
openDesk is a Kubernetes-only solution and requires an existing Kubernetes (K8s) cluster. openDesk is a Kubernetes-only solution and requires an existing Kubernetes (K8s) cluster.
- K8s cluster >= 1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/) - K8s cluster >= v1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/)
- Domain and DNS Service - Domain and DNS Service
- Ingress controller (Ingress NGINX) >= [4.11.5/1.11.5](https://github.com/kubernetes/ingress-nginx/releases) - tested with 1.11.1 up to 1.11.5 - Ingress controller (Ingress NGINX) >= [4.11.5/1.11.5](https://github.com/kubernetes/ingress-nginx/releases)
- **Important Note**: We are working on support for more recent versions, but please ensure to use at least 1.11.5 due to ["security issues"](https://www.wiz.io/blog/ingress-nginx-kubernetes-vulnerabilities) in earlier versions. - [Helm](https://helm.sh/) >= v3.17.3, but not v3.18.0[^1]
- [Helm](https://helm.sh/) >= v3.9.0 - [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= v1.0.0
- [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v1.0.0-rc8** - [HelmDiff](https://github.com/databus23/helm-diff) >= v3.11.0
- [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0 - Volume provisioner supporting RWO (read-write-once)[^2]
- Volume provisioner supporting RWO (read-write-once)
- Certificate handling with [cert-manager](https://cert-manager.io/) - Certificate handling with [cert-manager](https://cert-manager.io/)
- [OpenKruise](https://openkruise.io/)[^1] >= 1.6
**Additional openDesk Enterprise requirements**
- [OpenKruise](https://openkruise.io/)[^3] >= v1.6
# Hardware # Hardware
The following minimal requirements are thought for initial evaluation deployment: The following minimum requirements are intended for initial evaluation deployment:
| Spec | Value                                                 | | Spec | Value |
| ---- | ----------------------------------------------------- | |------|-------------------------------------------------------|
| CPU  | 12 Cores of x64 or x86 CPU (ARM is not supported yet) | | CPU | 12 Cores of x64 or x86 CPU (ARM is not supported yet) |
| RAM  | 32 GB, more recommended                               | | RAM | 32 GB, more recommended |
| Disk | HDD or SSD, >10 GB                                    | | Disk | HDD or SSD, >10 GB |
# Kubernetes # Kubernetes
Any self-hosted or managed K8s cluster >= 1.24 listed in Any self-hosted or managed K8s cluster >= v1.24 listed in
[CNCF Certified Kubernetes distributions](https://www.cncf.io/certification/software-conformance/) should be supported. [CNCF Certified Kubernetes distributions](https://www.cncf.io/certification/software-conformance/) should be supported.
The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/kubespray) based clusters. The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/kubespray) based clusters.
@@ -56,14 +60,36 @@ The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/
# Ingress controller # Ingress controller
The deployment is intended to be used only over HTTPS via a configured FQDN, therefore it is required to have a proper The deployment is intended to be used only over HTTPS via a configured FQDN, therefore it is required to have a properly
configured ingress controller deployed. configured ingress controller deployed in your cluster.
## Supported controllers
**Supported controllers:**
- [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx) - [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx)
> **Note**<br> > **Note**<br>
> The platform development team is evaluating the use of [Gateway API](https://gateway-api.sigs.k8s.io/). If you have feedback on that topic, please share it with us. > The platform development team is evaluating the use of [Gateway API](https://gateway-api.sigs.k8s.io/).
**Compatibility with Ingress NGINX >= 1.12.0**
With the release 1.12.0 Ingress NGINX introduced new security default settings, which are incompatible with current openDesk releases. If you want to use Ingress-NGINX >= 1.12.0 the following settings have to be set:
```
controller.config.annotations-risk-level=Critical
controller.config.strict-validate-path-type=false
```
See the [`annotations-risk-level` documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#annotations-risk-level) and [`strict-validate-path-type` documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#strict-validate-path-type) for details.
> **Important Note**<br>
> Ensure to install at least Ingress NGINX 1.11.5 or 1.12.1 due to [security issues](https://www.wiz.io/blog/ingress-nginx-kubernetes-vulnerabilities) in earlier versions.
## Minimal configuration
Several components in openDesk make use of snippet annotations, which are disabled by default. Please enable them using the following configuration:
```
controller.allowSnippetAnnotations=true
controller.admissionWebhooks.allowSnippetAnnotations=true
```
See the [`allowSnippetAnnotations` documentation](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#allow-snippet-annotations) for context.
# Volume provisioner # Volume provisioner
@@ -71,7 +97,7 @@ Initial evaluation deployment requires a `ReadWriteOnce` volume provisioner. For
provisioner is sufficient. provisioner is sufficient.
> **Note**<br> > **Note**<br>
> Some components require a `ReadWriteMany` volume provisioner for distributed mode or scaling. > Some components require a `ReadWriteMany` volume provisioner for distributed mode or horizontal scaling.
# Certificate management # Certificate management
@@ -79,7 +105,7 @@ This deployment leverages [cert-manager](https://cert-manager.io/) to generate v
but a secret containing a valid TLS certificate is required. but a secret containing a valid TLS certificate is required.
Only `Certificate` resources will be deployed; the `cert-manager`, including its CRD must be installed before this or Only `Certificate` resources will be deployed; the `cert-manager`, including its CRD must be installed before this or
openDesk certificate management switched off. openDesk certificate management is switched off.
# External services # External services
@@ -88,10 +114,10 @@ deployments, you need to make use of your own production-grade services; see the
[external-services.md](./external-services.md) for configuration details. [external-services.md](./external-services.md) for configuration details.
| Group | Type | Version | Tested against | | Group | Type | Version | Tested against |
| -------- | ------------------- | ------- | --------------------- | |----------|---------------------|---------|-----------------------|
| Cache | Memcached | `1.6.x` | Memcached | | Cache | Memcached | `1.6.x` | Memcached |
| | Redis | `7.x.x` | Redis | | | Redis | `7.x.x` | Redis |
| Database | Cassandra[^1] | `5.0.x` | Cassandra | | Database | Cassandra[^3] | `5.0.x` | Cassandra |
| | MariaDB | `10.x` | MariaDB | | | MariaDB | `10.x` | MariaDB |
| | PostgreSQL | `15.x` | PostgreSQL | | | PostgreSQL | `15.x` | PostgreSQL |
| Mail | Mail Transfer Agent | | Postfix | | Mail | Mail Transfer Agent | | Postfix |
@@ -107,8 +133,12 @@ deployments, you need to make use of your own production-grade services; see the
The deployment of each component is [Helm](https://helm.sh/) based. The 35+ Helm charts are configured and The deployment of each component is [Helm](https://helm.sh/) based. The 35+ Helm charts are configured and
templated via [Helmfile](https://helmfile.readthedocs.io/en/latest/) to provide a streamlined deployment experience. templated via [Helmfile](https://helmfile.readthedocs.io/en/latest/) to provide a streamlined deployment experience.
Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare the desired against the deployed state. Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare the desired state against the deployed state.
# Footnotes # Footnotes
[^1]: Required for Dovecot Pro as part of openDesk Enterprise Edition. [^1]: Due to a [Helm bug](https://github.com/helm/helm/issues/30890) Helm 3.18.0 is not supported.
[^2]: Due to [restrictions on Kubernetes `emptyDir`](https://github.com/kubernetes/kubernetes/pull/130277) you need a volume provisioner that has sticky bit support, otherwise the OpenProject seeder job will fail.
[^3]: Required for Dovecot Pro as part of openDesk Enterprise Edition.

View File

@@ -1,23 +1,39 @@
<!-- <!--
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
--> -->
<h1>Scaling</h1> <h1>Scaling</h1>
This document covers the ability to scale applications. This document covers the possibilities to scale the applications in openDesk.
# Horizontal scalability It provides rough benchmarks for configuring your own environment across various scale levels.
In production, resource demands are primarily driven by actual usage patterns and system load, especially the number of concurrently active users.
Consequently, we strongly recommend implementing monitoring and logging solutions to detect usage trends and enable timely intervention when needed.
We are working on generating this document automatically based on the file | Application | Recommendation | Note(s) |
[`replicas.yaml.gotmpl`](../helmfile/environments/default/replicas.yaml.gotmpl) that contains necessary annotations. | ------------ | -------------- | ------- |
In the meantime, this file can be used to check the components scaling support/capabilities. | Collabora | - 1 vCPU per 15 active users <br/> - 50 MB RAM per active user <br/> - 1 MBit/s per 10 active users | - |
| Element | Per 10k users with values for federation activated / federation deactivated:<br/><br/> Homeserver:<br/> - 15 / 10 vCPU<br/> - 12 / 8 GB RAM<br/><br/>Postgres:<br/> - 10 / 4 vCPU<br/> - 32 / 16 GB RAM | Required hardware resources are impacted by whether or not federation is being used |
| Cryptpad | No large-scale deployments seen, minimum requirements: <br/> - 2 vCPU <br/> - 2 GB RAM <br/> - 20 GB storage (depending on planned usage) | Most of the computation is done client-side |
| Jitsi | Jitsi-Meet server: <br/> - 4 vCPU <br/> - 8 GB RAM <br/> <br/> For every 200 concurrent users one JVB with: <br/> - 8 vCPU <br/> - 8 GB RAM <br/><br/> Network bandwidth: <br/> - 1 GBit/s - 10 GBit/s small deployments <br/> - 10 Gbit/s *per bridge* large deployments<br/> | JVB network bandwidth calculation depends on the stream resolution (HD vs. 4k). |
| Nextcloud | Up to 5k / more than 5k users: <br/> - 4 to 20 Nextcloud AIO Pods with 8 vCPUs and 32 / 64 GB RAM each <br/> - 2 / 4 DB servers with 8 / 16 vCPUs and 64 / 128 GB RAM each, plus DB load balancer | - |
| OpenProject | - 4-6 vCPU per ~500 users <br/> - 6-8 GB per ~500 users <br/> - +20-50 GB storage per ~500 users, depending on workload and attachment storage[^1] <br/><br/> - Web Workers: +4 per ~500 users <br/> - Background Workers: +1-2 multithreaded workers per ~500 users, depending on workload | These values are guidelines and should be adjusted based on actual monitoring of resource usage. Scaling should prioritize CPU and RAM, prioritize scaling Web Workers first, followed by Background Workers and Disk Space as needed. |
| Open-Xchange | For ~200 users (64 concurrent users to App Suite & 128 users to Dovecot): <br/> - 10 vCPU <br/> - 58 GB RAM <br/> - 660 GB storage | - |
| XWiki | Advise for small instances: <br> - 4 vCPU <br/> - 6 GB RAM | - |
[^1]: Nextcloud is configured for attachment storage as well.
# Upstream information # Upstream information
While scaling services horizontally is the ideal solution, information about vertical scaling is helpful While scaling services horizontally is the ideal solution, information about vertical scaling is helpful
when defining the application's resources, see [`resources.yaml.gotmpl`](../helmfile/environments/default/resources.yaml.gotmpl) for references. when defining the application's resources, see [`resources.yaml.gotmpl`](../helmfile/environments/default/resources.yaml.gotmpl) for references.
Please find below links to the application's upstream resources about scaling: Linked below is documentation related to scaling for upstream applications, where publically available:
- [OpenProject system requirements](https://www.openproject.org/docs/installation-and-operations/system-requirements/) - [Collabora Online Technical Documentation](https://mautic.collaboraoffice.com/asset/60:collabora-online-technical-information-pdf)
- [OpenProject System Requirements](https://www.openproject.org/docs/installation-and-operations/system-requirements/)
- [XWiki Performance](https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Performances/)
- [Element Requirements and Recommendations](https://ems-docs.element.io/books/element-server-suite-documentation-lts-2404/page/requirements-and-recommendations)
- [Jitsi DevOps Guide (scalable setup)](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-scalable/), [Jitsi Meet Needs](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-requirements/)

View File

@@ -147,7 +147,7 @@ This list gives you an overview of templated security settings and if they compl
| process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities | | process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities |
| ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ | | ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ |
| **collabora**/collabora-online | :x: | yes | no | no | yes | 100 | 101 | yes | no ["CHOWN","FOWNER","SYS_CHROOT"] | | **collabora**/collabora-online | :x: | yes | no | no | yes | 1001 | 1001 | yes | no ["CHOWN","FOWNER","SYS_CHROOT"] |
| **cryptpad**/cryptpad | :x: | no | no | no | yes | 4001 | 4001 | yes | yes | | **cryptpad**/cryptpad | :x: | no | no | no | yes | 4001 | 4001 | yes | yes |
| **element**/matrix-neoboard-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes | | **element**/matrix-neoboard-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
| **element**/matrix-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes | | **element**/matrix-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
@@ -169,22 +169,19 @@ This list gives you an overview of templated security settings and if they compl
| **jitsi**/jitsi/jitsi/web | :x: | no | no | no | no | 0 | 0 | yes | no | | **jitsi**/jitsi/jitsi/web | :x: | no | no | no | no | 0 | 0 | yes | no |
| **jitsi**/jitsi/patchJVB | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes | | **jitsi**/jitsi/patchJVB | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
| **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 101 | 101 | yes | yes | | **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 101 | 101 | yes | yes |
| **nextcloud**/opendesk-nextcloud-notifypush | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
| **nextcloud**/opendesk-nextcloud/aio | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes | | **nextcloud**/opendesk-nextcloud/aio | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
| **nextcloud**/opendesk-nextcloud/exporter | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes | | **nextcloud**/opendesk-nextcloud/exporter | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
| **notes**/impress/backend | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes | | **notes**/impress/backend | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
| **notes**/impress/frontend | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes | | **notes**/impress/frontend | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **notes**/impress/yProvider | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes | | **notes**/impress/y-provider | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
| **nubus**/intercom-service | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/intercom-service | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/intercom-service/provisioning | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no | | **nubus**/intercom-service/provisioning | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
| **nubus**/opendesk-keycloak-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/opendesk-keycloak-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/keycloak | :x: | no | n/a | no | yes | 1000 | 1000 | yes | yes | | **nubus**/ums/keycloak | :x: | no | n/a | no | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusGuardian/authorizationApi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/ums/nubusKeycloakBootstrap | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusGuardian/managementApi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusGuardian/managementUi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusGuardian/openPolicyAgent | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusKeycloakBootstrap | :x: | no | n/a | no | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusKeycloakExtensions/handler | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no | | **nubus**/ums/nubusKeycloakExtensions/handler | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
| **nubus**/ums/nubusKeycloakExtensions/proxy | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no | | **nubus**/ums/nubusKeycloakExtensions/proxy | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusLdapNotifier | :x: | no | n/a | yes | yes | 101 | 102 | yes | yes | | **nubus**/ums/nubusLdapNotifier | :x: | no | n/a | yes | yes | 101 | 102 | yes | yes |
| **nubus**/ums/nubusNotificationsApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/ums/nubusNotificationsApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusPortalConsumer | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no | | **nubus**/ums/nubusPortalConsumer | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
@@ -197,7 +194,7 @@ This list gives you an overview of templated security settings and if they compl
| **nubus**/ums/nubusUdmListener | :x: | no | n/a | yes | yes | 102 | 65534 | yes | yes | | **nubus**/ums/nubusUdmListener | :x: | no | n/a | yes | yes | 102 | 65534 | yes | yes |
| **nubus**/ums/nubusUdmRestApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/ums/nubusUdmRestApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusUmcGateway | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes | | **nubus**/ums/nubusUmcGateway | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
| **nubus**/ums/nubusUmcServer | :x: | no | n/a | yes | no | 0 | 0 | yes | yes | | **nubus**/ums/nubusUmcServer | :x: | no | n/a | yes | yes | 999 | 999 | yes | yes |
| **open-xchange**/dovecot | :x: | no | n/a | yes | n/a | n/a | n/a | yes | no ["CHOWN","DAC_OVERRIDE","KILL","NET_BIND_SERVICE","SETGID","SETUID","SYS_CHROOT"] | | **open-xchange**/dovecot | :x: | no | n/a | yes | n/a | n/a | n/a | yes | no ["CHOWN","DAC_OVERRIDE","KILL","NET_BIND_SERVICE","SETGID","SETUID","SYS_CHROOT"] |
| **open-xchange**/open-xchange/appsuite/core-documentconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes | | **open-xchange**/open-xchange/appsuite/core-documentconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
| **open-xchange**/open-xchange/appsuite/core-guidedtours | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes | | **open-xchange**/open-xchange/appsuite/core-guidedtours | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |

View File

@@ -5,15 +5,15 @@ SPDX-License-Identifier: Apache-2.0
<h1>Security</h1> <h1>Security</h1>
This document should cover the current status of security measurements. This document covers the current status of security measures.
<!-- TOC --> <!-- TOC -->
* [Helm Chart Trust Chain](#helm-chart-trust-chain) * [Helm chart trust chain](#helm-chart-trust-chain)
* [Kubernetes Security Enforcements](#kubernetes-security-enforcements) * [Kubernetes security enforcements](#kubernetes-security-enforcements)
* [NetworkPolicies](#networkpolicies) * [Network policies](#network-policies)
<!-- TOC --> <!-- TOC -->
# Helm Chart Trust Chain # Helm chart trust chain
Helm charts are signed and validated against GPG keys in `helmfile/files/gpg-pubkeys`. Helm charts are signed and validated against GPG keys in `helmfile/files/gpg-pubkeys`.
@@ -21,31 +21,31 @@ For more details on Chart validation, please visit: https://helm.sh/docs/topics/
All charts except the ones mentioned below are verifiable: All charts except the ones mentioned below are verifiable:
| Repository        | Verifiable | | Repository | Verifiable |
|-------------------|:----------:| |-------------------|:----------:|
| open-xchange-repo |     no     | | open-xchange-repo | no |
# Kubernetes Security Enforcements # Kubernetes security enforcements
This list gives you an overview of default security settings and whether they comply with security standards: This list gives you an overview of default security settings and whether they comply with security standards:
⟶ Visit our generated detailed [Security Context](./security-context.md) overview. ⟶ Visit our generated detailed [Security Context](./docs/security-context.md) overview.
# NetworkPolicies # Network policies
Kubernetes NetworkPolicies are an essential measure to secure your Kubernetes apps and clusters. Kubernetes network policies are an essential measure to secure your Kubernetes apps and clusters.
When applied, they restrict the traffic to your services. When applied, they restrict traffic to your services.
This protects other deployments in your cluster or other services in your deployment from getting compromised when one `NetworkPolicy` resources protect other deployments in your cluster or other services in your deployment from getting compromised when another
component is compromised. component is compromised.
We ship a default set of Otterize ClientIntents via We ship a default set of Otterize `ClientIntents` via
[Otterize intents operator](https://github.com/otterize/intents-operator) which translates intent-based access control [Otterize intents operator](https://github.com/otterize/intents-operator) which translates intent-based access control
(IBAC) into Kubernetes native NetworkPolicies. (IBAC) into Kubernetes native network policies.
This requires the Otterize intents operator to be installed. This requires the Otterize intents operator to be installed.
```yaml ```yaml
security: security:
  otterizeIntents: otterizeIntents:
    enabled: true enabled: true
``` ```

View File

@@ -9,14 +9,14 @@ SPDX-License-Identifier: Apache-2.0
* [Overview](#overview) * [Overview](#overview)
* [Test concept](#test-concept) * [Test concept](#test-concept)
* [Rely on upstream applications QA](#rely-on-upstream-applications-qa) * [Rely on upstream applications QA](#rely-on-upstream-applications-qa)
* [Run minimal functional QA (end-to-end tests)](#run-minimal-functional-qa-end-to-end-tests) * [Functional QA (end-to-end tests)](#functional-qa-end-to-end-tests)
* [Run extensive load- and performance tests](#run-extensive-load--and-performance-tests) * [Nightly testing](#nightly-testing)
* [Reporting test results](#reporting-test-results)
* [Load- and performance testing](#load--and-performance-testing)
* [Base performance testing](#base-performance-testing) * [Base performance testing](#base-performance-testing)
* [Load testing to saturation point](#load-testing-to-saturation-point) * [Load testing to saturation point](#load-testing-to-saturation-point)
* [Load testing up to a defined user count](#load-testing-up-to-a-defined-user-count) * [Load testing up to a defined user count](#load-testing-up-to-a-defined-user-count)
* [Overload/recovery tests](#overloadrecovery-tests) * [Overload/recovery tests](#overloadrecovery-tests)
* [Reporting and test results](#reporting-and-test-results)
* [Allure TestOps](#allure-testops)
<!-- TOC --> <!-- TOC -->
# Overview # Overview
@@ -25,7 +25,7 @@ The following section provides an overview of the testing approach adopted to en
1. Relying on application QA: Utilizing the existing QA processes of the applications to ensure baseline functionality and quality standards. 1. Relying on application QA: Utilizing the existing QA processes of the applications to ensure baseline functionality and quality standards.
2. Minimal functional QA: Executing end-to-end tests to validate critical workflows and ensure that key functionalities operate as expected. 2. Minimal functional QA: Executing end-to-end tests to validate critical workflows and ensure that key functionalities operate as expected.
3. Extensive load and performance testing: Conducting comprehensive load and performance tests to assess openDesk's scalability and response under varying usage conditions. 3. Extensive load and performance testing: Conducting comprehensive load and performance tests to assess openDesk's scalability and responsiveness under varying usage conditions.
These efforts are designed to complement each other, minimizing redundancy while ensuring robust testing coverage. These efforts are designed to complement each other, minimizing redundancy while ensuring robust testing coverage.
@@ -33,78 +33,116 @@ These efforts are designed to complement each other, minimizing redundancy while
## Rely on upstream applications QA ## Rely on upstream applications QA
openDesk contains applications from different suppliers, as a general approach, we rely on the testing openDesk contains applications from different suppliers. As a general approach, we rely on the testing
conducted by these suppliers for their respective applications. conducted by these suppliers for their respective applications.
We review the supplier's QA measures on a regular basis, to ensure a reliable and sufficient QA of the underlying applications. We review the supplier's QA measures on a regular basis, to ensure a reliable and sufficient QA of the underlying applications.
We receive the release notes early before a new application release is integrated into openDesk, so We receive the release notes early before a new application release is integrated into openDesk, so
we are able to check the existence of a sufficient set of test scases. we are able to check for the existence of a sufficient set of test cases.
The suppliers create a set of test cases for each new functionality. The suppliers create a set of test cases for each new function.
## Run minimal functional QA (end-to-end tests) ## Functional QA (end-to-end tests)
To ensure the functioning of all applications, we run a minimal set of testcases to check the We develop and maintain a [set of end-to-end tests](https://gitlab.opencode.de/bmi/opendesk/deployment/e2e-tests) focussing on:
basic functionality of openDesk and all integrated applications.
Furthermore, we analyze all features/usecases which are implemented by a set of more than one - use cases that are spanning more than a single application, e.g.
applications. - the filepicker in OX App Suite for selecting files from Nextcloud or
All these features are not testable naturally by the suppliers, so we develop testcases - the central navigation that is part of the top bar of most applications.
for such features. - openDesk specific configurations/supported settings that can be found in the `functional.yaml.gotmpl`, e.g.
- SSO federation or
- sharing settings for Nextcloud.
- bugs identified in the past, e.g.
- creating a folder in OX or
- enforcement of an account's password renewal.
The openDesk application owners prioritize then this list of end-to-end-testcases, and we We execute the tests using English and German as language profile.
implement these testcases in the [test automation framework](https://gitlab.opencode.de/bmi/opendesk/deployment/e2e-tests).
## Run extensive load- and performance tests The development team utilizes the test automation described above for QA'ing their feature branches.
We want to deliver openDesk as an application-grade software with the ability to serve a large user base. ### Nightly testing
We create and perform extensive load- and performance tests for every release of openDesk. We use the functional e2e-tests in nightly testruns on a matrix of deployments addressing different application profiles to ensure the quality of the development branch's current state.
The following naming scheme is applied for the deployment matrix:
- `<edition>-<type>-<profile>` resulting e.g. in `ce-init-default` or `ee-upgr-extsrv`
**`<edition>`**
- `ce`: openDesk Community Edition
- `ee`: openDesk Enterprise Edition
**`<type>`**
- `init`: Initial / fresh / from the scratch deployment of `develop` branch into an empty namespace.
- `upgr`: Deploy latest migration release (needs to be pinned manually) into an empty namespace, afterwards run upgrade deployment with current state of `develop` branch.
- `upd`: Deploy latest release (`main` branch) into an empty namespace, afterwards run upgrade deployment with current state of `develop` branch.
**`<profile>`**: The following profiles are defined
- `default`: With
- *`functional.yaml`*: No changes beside specific `2FA testing` group and enabled UDM REST API (required for user import).
- *Services*: Internal services deployed with openDesk are used.
- *Secrets*: Master password based secrets based on `secrets.yaml.gotmpl`
- *Certificates*: Letsencrypt-prod certificates are used.
- *Deployment*: GitLab CI based deployment.
- `funct1`: Different configuration of `functional.yaml`, self-signed-certs [and when available external secrets].
- `extsrv`: External services (where possible).
- `gitops`: Argo CD based deployment.
### Reporting test results
All executions of the end-to-end tests are tracked in a central platform running [Allure TestOps](https://docs.qameta.io/allure-testops/).
As the TestOps tool contains infrastructure details of our development and test clusters it is currently only accessible for to project members.
## Load- and performance testing
Our goal is to deliver openDesk as application-grade software with the ability to serve large user bases.
We create and perform [load- and performance tests](https://gitlab.opencode.de/bmi/opendesk/deployment/load-tests) for each release of openDesk.
Our approach consists of different layers of load testing. Our approach consists of different layers of load testing.
### Base performance testing ### Base performance testing
For these tests we define a set of "normal", not too complicated user-interactions with openDesk. For these tests we define a set of "normal", uncomplicated user-interactions with openDesk.
For each testcase in this set, we measure the duration of the whole testcase (and steps inside the For each testcase in this set, we measure the duration of the whole testcase (and individual steps within the
testcase) on a given, unloaded environment, installed with a predefined setup and openDesk release. testcase) on a given, unloaded environment, prepared with a predefined setup and openDesk release installed.
As a result, we receive the total runtime of one iteration of the given testcase, the runtime of each As a result, we receive the total runtime of one iteration of the given testcase, the runtime of each
step inside the testcase, the error rate and min/max/median runtimes. step inside the testcase, the error rate and min/max/median runtimes.
Most importantly, the environment should not be used by other users or background tasks, so it should Most importantly, the environment should not be used by other users or have running background tasks, so it should
be an environment being mostly in idle state. be an environment in a mostly idle state.
The results can be compared with the results of the previous release, so we can see if changes The results can be compared with the results of the previous release, so we can see if changes
in software components improve or decrease the performance of a testcase. in software components improve or decrease the performance of a testcase.
### Load testing to saturation point ### Load testing to saturation point
These tests are performed to ensure the correct processing and user interactions even in These tests are performed to ensure the correct processing and user interaction, even under
high-load scenarios. high-load scenarios.
We use the same test cases as in the base performance tests. We use the same test cases as in the base performance tests.
Now we measure the duration on a well-defined environment while the system is being used Now we measure the duration on a well-defined environment while the system is being used
by a predefined number of test users in parallel. This number will be scaled up. by a predefined number of test users in parallel. The number of users is incrementally scaled up.
Our goal is to see constant runtimes of each testcase iteration, while the total throughput Our goal is to see constant runtimes of each testcase iteration, despite the increased overall throughput due to the increasing number of parallel users.
of requests increases consistently with the number of users in parallel usage of the system.
At a distinct point, a further increase of the number of users leads to no more increase of the At a certain point, increasing the number of users does not lead to higher overall throughput, but instead leads to an increase in the runtime of each testcase iteration.
total throughput, but instead leads to an increase in the runtime of each testcase iteration.
This point, the saturation point, is the load limit of the environment. Up to this point the This point, the saturation point, is the load limit of the environment. Up to this point, the
environment and the installed software packages can handle the load. More load over this point environment and the installed software packages can handle the load. Beyond this point, response times increase and error rates rise.
leads to increased response times and increased error rates.
### Load testing up to a defined user count ### Load testing up to a defined user count
For interested partners, that are looking into large scale openDesk deployments, For partners interested in large scale openDesk deployments,
we offer a load testing analysis based on defined scenarios to be discussed together with the partner in a workshop. we offer a tailored workshop in which we define scenarios and perform load testing analysis.
This way, we can help to decide on the appropriate sizing for the planned openDesk usage scenario. This way, we can help you decide on the appropriate sizing for the planned openDesk deployment.
### Overload/recovery tests ### Overload/recovery tests
@@ -113,29 +151,3 @@ test cases until no further increase in throughput is visible. Then we add even
until the first HTTP requests run into timeouts or errors. until the first HTTP requests run into timeouts or errors.
After a few minutes, we reduce the load below the saturation point. After a few minutes, we reduce the load below the saturation point.
Now we can check if the system is able to recover from the overload status. Now we can check if the system is able to recover from the overload status.
# Reporting and test results
We perform testruns every night on every of our environments.
For each environment, we define so called profiles, these contains the features enabled
per environment.
For example: Testing the email features in an environment without deployment of Open-Xchange makes no sense at all.
Also we test the whole system via a browser with `language=DE` and another browser with `language=EN`.
The test results will be saved in an [Allure TestOps](https://qameta.io/) server, so interested persons
are able to view the test results in detail.
## Allure TestOps
The Allure TestOps [server](https://testops.opendesk.run/) is currently only accessible to project members.
The relevant project is called *opendesk*.
To get an overview, click in the left symbol list onto the symbol "Rocket" to
check all relevant launches.
Now you can, e.g., see the launch #1733, and directly check for the success
of this launch.

View File

@@ -14,17 +14,17 @@ This document covers the theming options for an openDesk deployment.
# Settings # Settings
All default settings can be found in the [`theme.gotmpl`](../helmfile/environments/default/theme.gotmpl). Most of the components adhere to these settings. All default settings can be found in [`theme.yaml.gotmpl`](../helmfile/environments/default/theme.yaml.gotmpl). Most of the components adhere to these settings.
Please review the default configuration that is applied to understand your customization options. Please review the default configuration that is applied to understand your customization options.
You can just update the files in: You can just update the files in [helmfile/files/theme](../helmfile/files/theme) to change logos, favicons etc. Note that the `.svg` versions of the favicons are also used for the portal tiles.
- [helmfile/files/theme](../helmfile/files/theme): To change logos, favicons etc.
- [helmfile/files/portal-tiles](../helmfile/files/portal-tiles): To change the icons in the portal. > **Note**<br>
> Theming focuses on colors, iconography and imagery. If you like to adapt the default links in the portal pointing to external
> resources (like "Support", "Legal Notice") please check the `functional.portal` section
> in [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl)
# Known limitations # Known limitations
Not all applications support theming. Known exceptions are: - Portal and Keycloak screen styles, especially colors, must be applied in the [`portalStylesheets.css`](../helmfile/files/theme/portalStylesheet.css),
- OpenProject, comes with a build in openDesk theming that can be modified in the Enterprise version's OpenProject web interface.
- The portal background logo can (currently) only be set on initial deployment.
- Portal and Keycloak screen styles must be applied in the [`portalStylesheets.css`](../helmfile/files/theme/portalStylesheet.css).

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
controller: controller:
enableHashmapParallelization: true enableHashmapParallelization: true
@@ -25,6 +23,7 @@ controller:
image: image:
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collaboraController.registry }}/{{ .Values.images.collaboraController.repository }}" repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collaboraController.registry }}/{{ .Values.images.collaboraController.repository }}"
tag: {{ .Values.images.collaboraController.tag | quote }} tag: {{ .Values.images.collaboraController.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imagePullSecrets: imagePullSecrets:
{{- range .Values.global.imagePullSecrets }} {{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }} - name: {{ . | quote }}
@@ -32,14 +31,23 @@ imagePullSecrets:
ingress: ingress:
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
annotations:
{{- with .Values.annotations.coco.ingress }}
{{ . | toYaml | nindent 4 }}
{{- end }}
className: {{ .Values.ingress.ingressClassName | quote }} className: {{ .Values.ingress.ingressClassName | quote }}
hosts: hosts:
- host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}" - host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
paths: paths:
- path: "/controller" - path: "/controller"
pathType: "Prefix" pathType: "Prefix"
tls:
- secretName: {{ .Values.ingress.tls.secretName | quote }}
hosts:
- "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.coco.pod | toYaml | nindent 2 }}
securityContext: securityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
@@ -60,4 +68,7 @@ replicaCount: {{ .Values.replicas.collaboraController }}
resources: resources:
{{ .Values.resources.collaboraController | toYaml | nindent 2 }} {{ .Values.resources.collaboraController | toYaml | nindent 2 }}
serviceAccount:
annotations:
{{ .Values.annotations.coco.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
image: image:
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}" repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
autoscaling: autoscaling:
enabled: false enabled: false
@@ -22,6 +20,11 @@ collabora:
--o:num_prespawn_children={{ .Values.technical.collabora.numPrespawnChildren }} --o:num_prespawn_children={{ .Values.technical.collabora.numPrespawnChildren }}
--o:remote_font_config.url=https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/apps/richdocuments/settings/fonts.json --o:remote_font_config.url=https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/apps/richdocuments/settings/fonts.json
--o:net.proto={{ if eq .Values.cluster.networking.ipFamilies "DualStack" }}all{{ else }}{{ .Values.cluster.networking.ipFamilies }}{{ end }} --o:net.proto={{ if eq .Values.cluster.networking.ipFamilies "DualStack" }}all{{ else }}{{ .Values.cluster.networking.ipFamilies }}{{ end }}
--o:security.enable_macros_execution={{ .Values.functional.weboffice.macros.enabled }}
--o:security.macro_security_level={{- $val := printf "%v" .Values.functional.weboffice.macros.securityLevel -}}{{- if or (eq $val "0") (eq $val "1") -}}{{ $val }}
{{- else -}}
{{ fail (printf "Invalid value for functional.weboffice.macros.securityLevel: '%s'. Allowed values: 0 or 1" $val) }}
{{- end }}
{{- if .Values.debug.enabled }} {{- if .Values.debug.enabled }}
--o:logging.level=debug --o:logging.level=debug
{{- else }} {{- else }}
@@ -32,7 +35,7 @@ collabora:
{{- end }} {{- end }}
{{- if .Values.apps.collaboraController.enabled }} {{- if .Values.apps.collaboraController.enabled }}
--o:indirection_endpoint.url=https://{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}/controller/routeToken --o:indirection_endpoint.url=https://{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}/controller/routeToken
--o:monitors.monitor[0]=wss://{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}/controller/ws --o:monitors.monitor[0]=ws://collabora-controller-cool-controller:9000/controller/ws
--o:monitors.monitor[0][@retryInterval]=5 --o:monitors.monitor[0][@retryInterval]=5
{{- end }} {{- end }}
username: "collabora-internal-admin" username: "collabora-internal-admin"
@@ -65,6 +68,35 @@ ingress:
location /cool/getMetrics { deny all; return 403; } location /cool/getMetrics { deny all; return 403; }
location /cool/adminws/ { deny all; return 403; } location /cool/adminws/ { deny all; return 403; }
location /browser/dist/admin/admin.html { deny all; return 403; } location /browser/dist/admin/admin.html { deny all; return 403; }
# NGINX
nginx.org/websocket-services: "collabora"
nginx.org/lb-method: "hash $arg_WOPISrc consistent"
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
nginx.org/server-snippets: |
# block admin and metrics endpoint from outside by default
location /cool/getMetrics { deny all; return 403; }
location /cool/adminws/ { deny all; return 403; }
location /browser/dist/admin/admin.html { deny all; return 403; }
# HAProxy
haproxy.org/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
haproxy.org/backend-config-snippet: |
balance url_param WOPISrc check_post
hash-type consistent
# HAProxy - Community: https://haproxy-ingress.github.io/
haproxy-ingress.github.io/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
haproxy-ingress.github.io/balance-algorithm: "url_param WOPISrc check_post"
haproxy-ingress.github.io/config-backend: |
hash-type consistent
# block admin urls from outside
acl admin_url path_beg /cool/getMetrics
acl admin_url path_beg /cool/adminws/
acl admin_url path_beg /browser/dist/admin/admin.html
http-request deny if admin_url
{{- with .Values.annotations.collabora.ingress }}
{{ . | toYaml | nindent 4 }}
{{- end }}
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName | quote }} className: {{ .Values.ingress.ingressClassName | quote }}
hosts: hosts:
@@ -77,10 +109,11 @@ ingress:
hosts: hosts:
- "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}" - "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.collabora.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
fsGroup: 100 fsGroup: 1001
prometheus: prometheus:
servicemonitor: servicemonitor:
@@ -102,8 +135,8 @@ securityContext:
privileged: false privileged: false
readOnlyRootFilesystem: false readOnlyRootFilesystem: false
runAsNonRoot: true runAsNonRoot: true
runAsUser: 100 runAsUser: 1001
runAsGroup: 101 runAsGroup: 1001
seccompProfile: seccompProfile:
type: "RuntimeDefault" type: "RuntimeDefault"
capabilities: capabilities:
@@ -116,6 +149,13 @@ securityContext:
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.collabora | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.collabora | toYaml | nindent 4 }}
serviceAccount: serviceAccount:
create: true create: true
annotations:
{{ .Values.annotations.collabora.serviceAccount | toYaml | nindent 4 }}
service:
annotations:
{{ .Values.annotations.collabora.service | toYaml | nindent 4 }}
... ...

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/README.md or # https://github.com/cryptpad/helm/blob/main/charts/cryptpad/README.md or
# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/values.yaml # https://github.com/cryptpad/helm/blob/main/charts/cryptpad/values.yaml
@@ -39,6 +37,9 @@ ingress:
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
annotations: annotations:
nginx.org/websocket-services: "cryptpad" nginx.org/websocket-services: "cryptpad"
{{- with .Values.annotations.cryptpad.ingress }}
{{ . | toYaml | nindent 4 }}
{{- end }}
className: {{ .Values.ingress.ingressClassName | quote }} className: {{ .Values.ingress.ingressClassName | quote }}
hosts: hosts:
- host: "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}" - host: "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}"
@@ -53,7 +54,8 @@ ingress:
persistence: persistence:
enabled: false enabled: false
podAnnotations: {} podAnnotations:
{{ .Values.annotations.cryptpad.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
fsGroup: 4001 fsGroup: 4001
@@ -80,6 +82,8 @@ securityContext:
serviceAccount: serviceAccount:
create: true create: true
annotations:
{{ .Values.annotations.cryptpad.serviceAccount | toYaml | nindent 4 }}
workloadStateful: false workloadStateful: false

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
commonAnnotations:
{{ .Values.annotations.element.common | toYaml | nindent 2 }}
configuration: configuration:
endToEndEncryption: true endToEndEncryption: true
additionalConfiguration: additionalConfiguration:
@@ -136,8 +137,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.element.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.element.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -148,6 +152,14 @@ replicaCount: {{ .Values.replicas.element }}
resources: resources:
{{ .Values.resources.element | toYaml | nindent 2 }} {{ .Values.resources.element | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.element.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.element.serviceAccount | toYaml | nindent 4 }}
theme: theme:
title: "Chat - {{ .Values.theme.texts.productName }}" title: "Chat - {{ .Values.theme.texts.productName }}"
{{ .Values.theme | toYaml | nindent 2 }} {{ .Values.theme | toYaml | nindent 2 }}

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.elementMatrixNeoboardWidget.additional | toYaml | nindent 2 }}
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
@@ -39,8 +40,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementMatrixNeoboardWidget.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixNeoboardWidget.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -51,6 +55,14 @@ replicaCount: {{ .Values.replicas.matrixNeoBoardWidget }}
resources: resources:
{{ .Values.resources.matrixNeoBoardWidget | toYaml | nindent 2 }} {{ .Values.resources.matrixNeoBoardWidget | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementMatrixNeoboardWidget.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixNeoboardWidget.serviceAccount | toYaml | nindent 4 }}
theme: theme:
{{ .Values.theme | toYaml | nindent 2 }} {{ .Values.theme | toYaml | nindent 2 }}

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.elementMatrixNeochoiceWidget.additional | toYaml | nindent 2 }}
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
@@ -39,8 +40,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementMatrixNeochoiceWidget.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixNeochoiceWidget.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -48,6 +52,14 @@ podSecurityContext:
replicaCount: {{ .Values.replicas.matrixNeoChoiceWidget }} replicaCount: {{ .Values.replicas.matrixNeoChoiceWidget }}
service:
annotations:
{{ .Values.annotations.elementMatrixNeochoiceWidget.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixNeochoiceWidget.serviceAccount | toYaml | nindent 4 }}
theme: theme:
{{ .Values.theme | toYaml | nindent 2 }} {{ .Values.theme | toYaml | nindent 2 }}

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
cleanup: cleanup:
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }} deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
@@ -26,7 +24,8 @@ image:
fullnameOverride: "matrix-neodatefix-bot-bootstrap" fullnameOverride: "matrix-neodatefix-bot-bootstrap"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixBotBootstrap.pod | toYaml | nindent 2 }}
securityContext: securityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
@@ -43,4 +42,7 @@ securityContext:
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
podAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixBotBootstrap.serviceAccount | toYaml | nindent 2 }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.additional | toYaml | nindent 2 }}
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
hosts: hosts:
@@ -76,6 +77,8 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.ingress | toYaml | nindent 4 }}
liveness sample: liveness sample:
enabled: true enabled: true
@@ -83,8 +86,11 @@ liveness sample:
persistence: persistence:
size: {{ .Values.persistence.storages.matrixNeoDateFixBot.size | quote }} size: {{ .Values.persistence.storages.matrixNeoDateFixBot.size | quote }}
storageClass: {{ coalesce .Values.persistence.storages.matrixNeoDateFixBot.storageClassName .Values.persistence.storageClassNames.RWO | quote }} storageClass: {{ coalesce .Values.persistence.storages.matrixNeoDateFixBot.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
annotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.persistence | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -98,4 +104,12 @@ replicaCount: {{ .Values.replicas.matrixNeoDateFixBot }}
resources: resources:
{{ .Values.resources.matrixNeoDateFixBot | toYaml | nindent 2 }} {{ .Values.resources.matrixNeoDateFixBot | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixNeodatefixBot.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixWidget.additional | toYaml | nindent 2 }}
configuration: configuration:
bot: bot:
username: "meetings-bot" username: "meetings-bot"
@@ -44,8 +45,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementMatrixNeodatefixWidget.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixNeodatefixWidget.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -59,6 +63,14 @@ resources:
theme: theme:
{{ .Values.theme | toYaml | nindent 2 }} {{ .Values.theme | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementMatrixNeodatefixWidget.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixNeodatefixWidget.serviceAccount | toYaml | nindent 4 }}
nginx: nginx:
ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }} ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
cleanup: cleanup:
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }} deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
@@ -26,7 +24,8 @@ image:
fullnameOverride: "opendesk-matrix-user-verification-service-bootstrap" fullnameOverride: "opendesk-matrix-user-verification-service-bootstrap"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixUserVerificationServiceBootstrap.pod | toYaml | nindent 2 }}
securityContext: securityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
@@ -42,4 +41,10 @@ securityContext:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixUserVerificationServiceBootstrap.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS"
SPDX-FileCopyrightText: 2023 Federal Ministry of the Interior and Community, PG ZenDiS "Project group for the development of ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.elementMatrixUserVerificationService.additional | toYaml | nindent 2 }}
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
@@ -42,7 +43,8 @@ image:
repository: {{ .Values.images.matrixUserVerificationService.repository | quote }} repository: {{ .Values.images.matrixUserVerificationService.repository | quote }}
tag: {{ .Values.images.matrixUserVerificationService.tag | quote }} tag: {{ .Values.images.matrixUserVerificationService.tag | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementMatrixUserVerificationService.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -53,4 +55,12 @@ replicaCount: {{ .Values.replicas.matrixUserVerificationService }}
resources: resources:
{{ .Values.resources.matrixUserVerificationService | toYaml | nindent 2 }} {{ .Values.resources.matrixUserVerificationService | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementMatrixUserVerificationService.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementMatrixUserVerificationService.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
commonAnnotations:
{{ .Values.annotations.elementSynapseWeb.common | toYaml | nindent 2 }}
clusterDomain: {{ .Values.cluster.networking.domain }} clusterDomain: {{ .Values.cluster.networking.domain }}
containerSecurityContext: containerSecurityContext:
@@ -44,6 +45,9 @@ ingress:
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.element }}" nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.element }}"
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s" nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s"
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s" nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s"
{{- with .Values.annotations.elementSynapseWeb.ingress }}
{{ . | toYaml | nindent 4 }}
{{- end }}
host: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}" host: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
ingressClassName: {{ .Values.ingress.ingressClassName | quote }} ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
@@ -51,7 +55,8 @@ ingress:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementSynapseWeb.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -62,4 +67,12 @@ replicaCount: {{ .Values.replicas.synapseWeb }}
resources: resources:
{{ .Values.resources.synapseWeb | toYaml | nindent 2 }} {{ .Values.resources.synapseWeb | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementSynapseWeb.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementSynapseWeb.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
commonAnnotations:
{{ .Values.annotations.elementSynapse.common | toYaml | nindent 2 }}
configuration: configuration:
additionalConfiguration: additionalConfiguration:
user_directory: user_directory:
@@ -131,7 +132,7 @@ configuration:
allowUsersToUpdateDisplayname: {{ .Values.functional.chat.matrix.profile.allowUsersToUpdateDisplayname }} allowUsersToUpdateDisplayname: {{ .Values.functional.chat.matrix.profile.allowUsersToUpdateDisplayname }}
smtp: smtp:
senderAddress: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.domain }}" senderAddress: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.mailDomain | default .Values.global.domain }}"
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }} host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
port: 25 port: 25
tls: false tls: false
@@ -217,6 +218,8 @@ federation:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementSynapse.federationIngress | toYaml | nindent 6 }}
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
@@ -234,8 +237,11 @@ image:
persistence: persistence:
size: {{ .Values.persistence.storages.synapse.size | quote }} size: {{ .Values.persistence.storages.synapse.size | quote }}
storageClass: {{ coalesce .Values.persistence.storages.synapse.storageClassName .Values.persistence.storageClassNames.RWO | quote }} storageClass: {{ coalesce .Values.persistence.storages.synapse.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
annotations:
{{ .Values.annotations.elementSynapse.persistence | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementSynapse.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -250,6 +256,14 @@ replicaCount: {{ .Values.replicas.synapse }}
resources: resources:
{{ .Values.resources.synapse | toYaml | nindent 2 }} {{ .Values.resources.synapse | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementSynapse.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementSynapse.serviceAccount | toYaml | nindent 4 }}
tls: tls:
secretName: {{ if .Values.global.matrixDomain }}"opendesk-certificates-synapse-tls"{{ else }}"opendesk-certificates-tls"{{ end }} secretName: {{ if .Values.global.matrixDomain }}"opendesk-certificates-synapse-tls"{{ else }}"opendesk-certificates-tls"{{ end }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
commonAnnotations:
{{ .Values.annotations.elementWellKnown.common | toYaml | nindent 2 }}
configuration: configuration:
e2ee: e2ee:
forceDisable: false forceDisable: false
@@ -44,8 +45,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.elementWellKnown.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.elementWellKnown.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -56,4 +60,11 @@ replicaCount: {{ .Values.replicas.wellKnown }}
resources: resources:
{{ .Values.resources.wellKnown | toYaml | nindent 2 }} {{ .Values.resources.wellKnown | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.elementWellKnown.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.elementWellKnown.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
@@ -10,8 +8,10 @@ global:
{{ .Values.global.hosts | toYaml | nindent 4 }} {{ .Values.global.hosts | toYaml | nindent 4 }}
imagePullSecrets: imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
podAnnotations: {} {{- if .Values.annotations.jitsiGlobal.pod }}
podAnnotations:
{{ .Values.annotations.jitsiGlobal.pod | toYaml | nindent 4}}
{{- end }}
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
enabled: true enabled: true
@@ -77,6 +77,12 @@ jitsi:
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
ingress: ingress:
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
{{- if .Values.annotations.jitsiWeb.ingress }}
annotations:
{{- with .Values.annotations.jitsiWeb.ingress }}
{{ . | toYaml | nindent 8 }}
{{- end }}
{{- end }}
ingressClassName: {{ .Values.ingress.ingressClassName | quote }} ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
hosts: hosts:
- host: "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}" - host: "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
@@ -104,6 +110,10 @@ jitsi:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.jitsi | toYaml | nindent 8 }} {{ .Values.seLinuxOptions.jitsi | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiWeb.pod }}
podAnnotations:
{{ .Values.annotations.jitsiWeb.pod | toYaml | nindent 6 }}
{{- end }}
prosody: prosody:
image: image:
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.prosody.registry }}/{{ .Values.images.prosody.repository }}" repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.prosody.registry }}/{{ .Values.images.prosody.repository }}"
@@ -153,6 +163,10 @@ jitsi:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.prosody | toYaml | nindent 8 }} {{ .Values.seLinuxOptions.prosody | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiProsody.pod }}
podAnnotations:
{{ .Values.annotations.jitsiProsody.pod | toYaml | nindent 6 }}
{{- end }}
jicofo: jicofo:
replicaCount: {{ .Values.replicas.jicofo }} replicaCount: {{ .Values.replicas.jicofo }}
image: image:
@@ -176,6 +190,10 @@ jitsi:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.jicofo | toYaml | nindent 8 }} {{ .Values.seLinuxOptions.jicofo | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiJicofo.pod }}
podAnnotations:
{{ .Values.annotations.jitsiJicofo.pod | toYaml | nindent 6 }}
{{- end }}
jigasi: jigasi:
replicaCount: {{ .Values.replicas.jigasi }} replicaCount: {{ .Values.replicas.jigasi }}
enabled: {{ .Values.sip.jigasi.enabled }} enabled: {{ .Values.sip.jigasi.enabled }}
@@ -205,6 +223,10 @@ jitsi:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.jigasi | toYaml | nindent 8 }} {{ .Values.seLinuxOptions.jigasi | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiJigasi.pod }}
podAnnotations:
{{ .Values.annotations.jitsiJigasi.pod | toYaml | nindent 6 }}
{{- end }}
jvb: jvb:
replicaCount: {{ .Values.replicas.jvb }} replicaCount: {{ .Values.replicas.jvb }}
# The `useNodeIP` option provided by the upstream charts does not support all relevant scenarios, but since # The `useNodeIP` option provided by the upstream charts does not support all relevant scenarios, but since
@@ -221,6 +243,10 @@ jitsi:
{{ .Values.resources.jvb | toYaml | nindent 6 }} {{ .Values.resources.jvb | toYaml | nindent 6 }}
service: service:
type: {{ coalesce .Values.service.type.jitsiVideoBridge .Values.cluster.service.type | quote }} type: {{ coalesce .Values.service.type.jitsiVideoBridge .Values.cluster.service.type | quote }}
{{- if .Values.annotations.jitsiJvb.service }}
annotations:
{{ .Values.annotations.jitsiJvb.service | toYaml | nindent 8 }}
{{- end }}
securityContext: securityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: {} capabilities: {}
@@ -233,6 +259,18 @@ jitsi:
type: "RuntimeDefault" type: "RuntimeDefault"
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.jvb | toYaml | nindent 8 }} {{ .Values.seLinuxOptions.jvb | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiJvb.pod }}
podAnnotations:
{{ .Values.annotations.jitsiJvb.pod | toYaml | nindent 6 }}
{{- end }}
metrics:
prometheusAnnotations:
{{ .Values.annotations.jitsiJvb.metricsPrometheus | toYaml | nindent 8 }}
{{- if .Values.annotations.jitsiJvb.metricsGrafana }}
grafanaDashboards:
annotations:
{{ .Values.annotations.jitsiJvb.metricsGrafana | toYaml | nindent 10 }}
{{- end }}
jibri: jibri:
replicaCount: {{ .Values.replicas.jibri }} replicaCount: {{ .Values.replicas.jibri }}
image: image:
@@ -249,12 +287,22 @@ jitsi:
# Chart does not allow to template more # Chart does not allow to template more
capabilities: capabilities:
add: ["SYS_ADMIN"] add: ["SYS_ADMIN"]
{{- if .Values.annotations.jitsiJibri.pod }}
podAnnotations:
{{ .Values.annotations.jitsiJibri.pod | toYaml | nindent 6 }}
{{- end }}
imagePullSecrets: imagePullSecrets:
{{- range .Values.global.imagePullSecrets }} {{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }} - name: {{ . | quote }}
{{- end }} {{- end }}
{{- if .Values.annotations.jitsi.serviceAccount }}
serviceAccount:
annotations:
{{ .Values.annotations.jitsi.serviceAccount | toYaml | nindent 6 }}
{{- end }}
patchJVB: patchJVB:
backoffLimit: 12
configuration: configuration:
staticLoadbalancerIP: {{ .Values.cluster.networking.ingressGatewayIP | quote }} staticLoadbalancerIP: {{ .Values.cluster.networking.ingressGatewayIP | quote }}
loadbalancerStatusField: {{ .Values.cluster.networking.loadBalancerStatusField | quote }} loadbalancerStatusField: {{ .Values.cluster.networking.loadBalancerStatusField | quote }}
@@ -275,14 +323,21 @@ patchJVB:
{{ .Values.seLinuxOptions.jitsiPatchJVB | toYaml | nindent 6 }} {{ .Values.seLinuxOptions.jitsiPatchJVB | toYaml | nindent 6 }}
image: image:
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }} imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.jitsiPatchJVB.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.jitsiPatchJVB.registry | quote }}
repository: {{ .Values.images.jitsiPatchJVB.repository | quote }} repository: {{ .Values.images.jitsiPatchJVB.repository | quote }}
tag: {{ .Values.images.jitsiPatchJVB.tag | quote }} tag: {{ .Values.images.jitsiPatchJVB.tag | quote }}
podAnnotations: {} {{- if .Values.annotations.jitsi.pod }}
podAnnotations:
{{ .Values.annotations.jitsi.pod | toYaml | nindent 2 }}
{{- end }}
replicaCount: {{ .Values.replicas.jitsiKeycloakAdapter }} replicaCount: {{ .Values.replicas.jitsiKeycloakAdapter }}
resources: resources:
{{ .Values.resources.jitsiKeycloakAdapter | toYaml | nindent 2 }} {{ .Values.resources.jitsiKeycloakAdapter | toYaml | nindent 2 }}
serviceAccount:
annotations:
{{ .Values.annotations.jitsi.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -24,9 +24,9 @@ releases:
chart: "nextcloud-repo/{{ .Values.charts.nextcloudManagement.name }}" chart: "nextcloud-repo/{{ .Values.charts.nextcloudManagement.name }}"
version: "{{ .Values.charts.nextcloudManagement.version }}" version: "{{ .Values.charts.nextcloudManagement.version }}"
values: values:
- "values-nextcloud-mgmt.yaml.gotmpl" - "values-nextcloud-management.yaml.gotmpl"
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }} {{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
- "values-nextcloud-mgmt-enterprise.yaml.gotmpl" - "values-nextcloud-management-ee.yaml.gotmpl"
{{- end }} {{- end }}
{{- range .Values.customization.release.opendeskNextcloudManagement }} {{- range .Values.customization.release.opendeskNextcloudManagement }}
- {{ . }} - {{ . }}
@@ -34,14 +34,14 @@ releases:
waitForJobs: true waitForJobs: true
wait: true wait: true
installed: {{ .Values.apps.nextcloud.enabled }} installed: {{ .Values.apps.nextcloud.enabled }}
timeout: 900 timeout: 1800
- name: "opendesk-nextcloud" - name: "opendesk-nextcloud"
chart: "nextcloud-repo/{{ .Values.charts.nextcloud.name }}" chart: "nextcloud-repo/{{ .Values.charts.nextcloud.name }}"
version: "{{ .Values.charts.nextcloud.version }}" version: "{{ .Values.charts.nextcloud.version }}"
values: values:
- "values-nextcloud.yaml.gotmpl" - "values-nextcloud.yaml.gotmpl"
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }} {{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
- "values-nextcloud-enterprise.yaml.gotmpl" - "values-nextcloud-ee.yaml.gotmpl"
{{- end }} {{- end }}
{{- range .Values.customization.release.opendeskNextcloud }} {{- range .Values.customization.release.opendeskNextcloud }}
- {{ . }} - {{ . }}
@@ -49,6 +49,23 @@ releases:
needs: needs:
- "opendesk-nextcloud-management" - "opendesk-nextcloud-management"
installed: {{ .Values.apps.nextcloud.enabled }} installed: {{ .Values.apps.nextcloud.enabled }}
timeout: 1800
- name: "opendesk-nextcloud-notifypush"
chart: "nextcloud-repo/{{ .Values.charts.nextcloudNotifyPush.name }}"
version: "{{ .Values.charts.nextcloudNotifyPush.version }}"
values:
- "values-nextcloud-notifypush.yaml.gotmpl"
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
- "values-nextcloud-notifypush-ee.yaml.gotmpl"
{{- end }}
{{- range .Values.customization.release.opendeskNextcloudNotifyPush }}
- {{ . }}
{{- end }}
wait: true
needs:
- "opendesk-nextcloud"
installed: {{ and .Values.apps.nextcloud.enabled (gt .Values.replicas.nextcloudNotifyPush 0) }}
timeout: 1800
commonLabels: commonLabels:
deployStage: "050-components" deployStage: "050-components"

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
aio: aio:
image: image:

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
image: image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }}

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
@@ -12,7 +10,10 @@ global:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
additionalAnnotations: additionalAnnotations:
intents.otterize.com/service-name: "opendesk-nextcloud-management" intents.otterize.com/service-name: "opendesk-nextcloud-php"
{{- with .Values.annotations.nextcloudNextcloudMgmt.additional }}
{{ . | toYaml | nindent 2}}
{{- end }}
cleanup: cleanup:
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }} deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
@@ -64,6 +65,8 @@ configuration:
enabled: true enabled: true
integrationOpenproject: integrationOpenproject:
enabled: {{ .Values.apps.openproject.enabled }} enabled: {{ .Values.apps.openproject.enabled }}
notifyPush:
enabled: {{ gt .Values.replicas.nextcloudNotifyPush 0 }}
spreed: spreed:
enabled: true enabled: true
circles: circles:
@@ -72,6 +75,7 @@ configuration:
collabora: collabora:
# internalWopiUrl: "" # internalWopiUrl: ""
wopiAllowlist: {{ join ", " ( concat .Values.cluster.networking.cidr .Values.cluster.networking.incomingCIDR ) | quote }} wopiAllowlist: {{ join ", " ( concat .Values.cluster.networking.cidr .Values.cluster.networking.incomingCIDR ) | quote }}
defaultFormat: {{ .Values.functional.weboffice.defaultFormat | quote }}
database: database:
{{ if eq .Values.databases.nextcloud.type "mariadb" }} {{ if eq .Values.databases.nextcloud.type "mariadb" }}
@@ -97,7 +101,9 @@ configuration:
{{- end }} {{- end }}
ldap: ldap:
base: {{ .Values.ldap.baseDn | quote }}
host: {{ .Values.ldap.host | quote }} host: {{ .Values.ldap.host | quote }}
dn: "uid=ldapsearch_nextcloud,cn=users,{{ .Values.ldap.baseDn }}"
password: password:
value: {{ .Values.secrets.nubus.ldapSearch.nextcloud | quote }} value: {{ .Values.secrets.nubus.ldapSearch.nextcloud | quote }}
adminGroupName: "managed-by-attribute-FileshareAdmin" adminGroupName: "managed-by-attribute-FileshareAdmin"
@@ -124,6 +130,7 @@ configuration:
opendeskIntegration: opendeskIntegration:
centralNavigation: centralNavigation:
jsonUrl: "http://ums-portal-server/portal/navigation.json"
username: username:
value: "opendesk_username" value: "opendesk_username"
password: password:
@@ -155,7 +162,7 @@ configuration:
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }} host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
port: 587 port: 587
fromAddress: {{ .Values.smtp.localpartNoReply | quote }} fromAddress: {{ .Values.smtp.localpartNoReply | quote }}
mailDomain: "{{ .Values.global.domain }}" mailDomain: "{{ .Values.global.mailDomain | default .Values.global.domain }}"
security: "tls" security: "tls"
skipVerifyPeer: true skipVerifyPeer: true
@@ -169,6 +176,9 @@ configuration:
token: token:
value: {{ .Values.secrets.nextcloud.metricsToken | quote }} value: {{ .Values.secrets.nextcloud.metricsToken | quote }}
# A sane default for windows clients would be: `* " | & ? , ; : \ / ~ < >`
forbiddenChars: "* \" | & ? , ; : \\ / ~ < >"
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
@@ -184,8 +194,6 @@ containerSecurityContext:
runAsNonRoot: true runAsNonRoot: true
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.nextcloudManagement | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.nextcloudManagement | toYaml | nindent 4 }}
podSecurityContext:
fsGroup: 101
debug: debug:
loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }} loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }}
@@ -214,10 +222,47 @@ image:
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }} imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
tag: {{ .Values.images.nextcloud.tag | quote }} tag: {{ .Values.images.nextcloud.tag | quote }}
theme: podAnnotations:
{{ .Values.theme | toYaml | nindent 2 }} {{ .Values.annotations.nextcloudNextcloudMgmt.pod | toYaml | nindent 2 }}
podSecurityContext:
fsGroup: 101
resources: resources:
{{ .Values.resources.nextcloud | toYaml | nindent 4 }} {{ .Values.resources.nextcloud | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.nextcloudNextcloudMgmt.serviceAccount | toYaml | nindent 4 }}
theme:
background:
# Static color background
# NOTE: Not available yet because of a bug in Nextcloud 31.X
# Ref: https://github.com/nextcloud/server/commit/da51459022d21a569ab8271c5456f69c9316cdad
color: {{ .Values.theme.colors.primary | quote }}
# PNG or JPEG image background. Overwrites `theme.background.color`
imgBase64: {{ .Values.theme.imagery.files.backgroudImg | quote }}
colors:
primary: {{ .Values.theme.colors.primary | quote }}
favicon:
pngBase64: {{ .Values.theme.imagery.files.faviconPng | quote }}
logo:
svgBase64: {{ .Values.theme.imagery.logoHeaderSvgB64 | quote }}
# Overwrites the header color of Nextcloud with the value set in the `integration_swp` app
# This can *intentionally* only be adjusted via customizing
swpOverrideHeaderColor: true
texts:
slogan: {{ .Values.theme.texts.slogan | quote }}
productName: {{ .Values.theme.texts.productName | quote }}
urls:
imprint: {{ .Values.functional.portal.linkLegalNotice | quote }}
privacy: {{ .Values.functional.portal.linkPrivacyStatement | quote }}
main: {{ printf "%s.%s" .Values.global.hosts.nubus .Values.global.domain }}
... ...

View File

@@ -0,0 +1,6 @@
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
# SPDX-License-Identifier: Apache-2.0
---
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }}
...

View File

@@ -0,0 +1,141 @@
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
# SPDX-License-Identifier: Apache-2.0
---
global:
domain: {{ .Values.global.domain | quote }}
hosts:
{{ .Values.global.hosts | toYaml | nindent 4 }}
imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
additionalAnnotations:
intents.otterize.com/service-name: "opendesk-nextcloud-notifypush"
{{- with .Values.annotations.nextcloudNotifyPush.additional }}
{{ . | toYaml | nindent 4 }}
{{- end }}
configuration:
cache:
auth:
enabled: true
username:
value: {{ .Values.cache.nextcloud.username }}
password:
value: {{ .Values.cache.nextcloud.password | default .Values.secrets.redis.password | quote }}
host: {{ .Values.cache.nextcloud.host | quote }}
port: {{ .Values.cache.nextcloud.port | quote }}
tls: {{ .Values.cache.nextcloud.tls }}
database:
{{ if eq .Values.databases.nextcloud.type "mariadb" }}
type: "mysql"
{{ else if eq .Values.databases.nextcloud.type "postgresql" }}
type: "postgres"
{{ else }}
{{ .Values.databases.nextcloud.type | quote }}
{{ end }}
host: {{ .Values.databases.nextcloud.host | quote }}
port: {{ .Values.databases.nextcloud.port | quote }}
name: {{ .Values.databases.nextcloud.name | quote }}
auth:
username:
value: {{ .Values.databases.nextcloud.username | quote }}
password:
{{- if or (eq .Values.databases.nextcloud.type "mariadb") (eq .Values.databases.nextcloud.type "mysql") }}
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.mariadb.nextcloudUser | quote }}
{{- else if or (eq .Values.databases.nextcloud.type "postgresql") (eq .Values.databases.nextcloud.type "psql") }}
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.postgresql.nextcloudUser | quote }}
{{- else }}
value: {{ .Values.databases.nextcloud.password | quote }}
{{- end }}
trustedProxy: {{ join " " .Values.cluster.networking.cidr | quote }}
# Nextcloud connection
# FIXME: Dynamically get the service name of the `opendesk-nextcloud-aio` chart
# IDEA: helmfile > service-names.yaml.gotmpl with service names (external/internal)
# So this is controller on a more "global" level
# TODO: Find a sensible default
nextcloudUrl: "http://opendesk-nextcloud-aio"
logging:
# Default value for logging is "error" we bump it to "info" for better information in logs
# NOTE: "trace", which includes "debug" might be too verbose
# https://docs.rs/env_logger/latest/env_logger/#enabling-logging
level: {{ if .Values.debug.enabled }}"debug"{{ else }}"info"{{ end }}
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- "ALL"
enabled: true
privileged: false
runAsUser: 101
runAsGroup: 101
seccompProfile:
type: "RuntimeDefault"
readOnlyRootFilesystem: true
runAsNonRoot: true
seLinuxOptions:
{{ .Values.seLinuxOptions.nextcloud | toYaml | nindent 6 }}
{{- if .Values.certificate.selfSigned }}
extraEnvVars:
- name: "FS_ENV_CA_CERTIFICATE_PATH"
value: "/etc/ssl/certs/ca-certificates.crt"
extraVolumes:
- name: "trusted-cert-secret-volume"
secret:
secretName: "opendesk-certificates-ca-tls"
items:
- key: "ca.crt"
path: "ca-certificates.crt"
extraVolumeMounts:
- name: "trusted-cert-secret-volume"
mountPath: "/etc/ssl/certs/ca-certificates.crt"
subPath: "ca-certificates.crt"
{{- end }}
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }}
repository: {{ .Values.images.nextcloud.repository | quote }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
tag: {{ .Values.images.nextcloud.tag | quote }}
ingress:
enabled: {{ .Values.ingress.enabled }}
annotations:
{{- with .Values.annotations.nextcloudNotifyPush.ingress }}
{{ . | toYaml | nindent 6 }}
{{- end }}
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
host: "{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
tls:
secretName: {{ .Values.ingress.tls.secretName | quote }}
metrics:
enabled: true
service:
annotations:
{{ .Values.annotations.nextcloudNotifyPush.serviceMetrics | toYaml | nindent 6 }}
podAnnotations:
{{ .Values.annotations.nextcloudNotifyPush.pod | toYaml | nindent 4 }}
podSecurityContext:
fsGroup: 101
# prometheus:
# serviceMonitor:
# enabled: { .Values.monitoring.prometheus.serviceMonitors.enabled }}
# labels:
# { .Values.monitoring.prometheus.serviceMonitors.labels | toYaml | nindent 8 }}
# prometheusRule:
# enabled: { .Values.monitoring.prometheus.prometheusRules.enabled }}
# additionalLabels:
# { .Values.monitoring.prometheus.prometheusRules.labels | toYaml | nindent 8 }}
replicaCount: {{ .Values.replicas.nextcloudNotifyPush }}
resources:
{{ .Values.resources.nextcloudNotifyPush | toYaml | nindent 4 }}
service:
annotations:
{{ .Values.annotations.nextcloudNotifyPush.service | toYaml | nindent 6 }}
serviceAccount:
annotations:
{{ .Values.annotations.nextcloudNotifyPush.serviceAccount | toYaml | nindent 6 }}
...

View File

@@ -1,14 +1,19 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
imagePullSecrets: imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
exporter: exporter:
additionalAnnotations:
intents.otterize.com/service-name: "opendesk-nextcloud-exporter"
{{- with .Values.annotations.nextcloudExporter.additional }}
{{ . | toYaml | nindent 4 }}
{{- end }}
enabled: true enabled: true
configuration: configuration:
server: "http://opendesk-nextcloud-aio" server: "http://opendesk-nextcloud-aio"
@@ -34,7 +39,8 @@ exporter:
repository: "{{ .Values.images.nextcloudExporter.repository }}" repository: "{{ .Values.images.nextcloudExporter.repository }}"
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }} imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
tag: {{ .Values.images.nextcloudExporter.tag | quote }} tag: {{ .Values.images.nextcloudExporter.tag | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.nextcloudExporter.pod | toYaml | nindent 4 }}
prometheus: prometheus:
serviceMonitor: serviceMonitor:
enabled: {{ .Values.monitoring.prometheus.serviceMonitors.enabled }} enabled: {{ .Values.monitoring.prometheus.serviceMonitors.enabled }}
@@ -48,9 +54,17 @@ exporter:
resources: resources:
{{ .Values.resources.nextcloudExporter | toYaml | nindent 4 }} {{ .Values.resources.nextcloudExporter | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.nextcloudExporter.serviceAccount | toYaml | nindent 6 }}
aio: aio:
additionalAnnotations: additionalAnnotations:
intents.otterize.com/service-name: "opendesk-nextcloud-aio" intents.otterize.com/service-name: "opendesk-nextcloud-aio"
{{- with .Values.annotations.nextcloudAio.additional }}
{{ . | toYaml | nindent 4 }}
{{- end }}
configuration: configuration:
cache: cache:
auth: auth:
@@ -139,11 +153,15 @@ aio:
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.nextcloud }}" nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.nextcloud }}"
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.nextcloud }}s" nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.nextcloud }}s"
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.nextcloud }}s" nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.nextcloud }}s"
{{- with .Values.annotations.nextcloudAio.ingress }}
{{ . | toYaml | nindent 6 }}
{{- end }}
ingressClassName: {{ .Values.ingress.ingressClassName | quote }} ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
host: "{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}" host: "{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
tls: tls:
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.nextcloudAio.pod | toYaml | nindent 4 }}
podSecurityContext: podSecurityContext:
fsGroup: 101 fsGroup: 101
prometheus: prometheus:
@@ -159,4 +177,12 @@ aio:
resources: resources:
{{ .Values.resources.nextcloud | toYaml | nindent 4 }} {{ .Values.resources.nextcloud | toYaml | nindent 4 }}
service:
annotations:
{{ .Values.annotations.nextcloudAio.service | toYaml | nindent 6 }}
serviceAccount:
annotations:
{{ .Values.annotations.nextcloudAio.serviceAccount | toYaml | nindent 6 }}
... ...

View File

@@ -1,98 +1,112 @@
{{/* # SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
image: global:
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesBackend.registry) (.Values.images.notesBackend.repository) | quote }} collaborationServerSecret:
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} value: {{ .Values.secrets.notes.collaborationSecret | quote }}
tag: {{ .Values.images.notesBackend.tag }} fqdn: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
credentials: imagePullSecrets:
name: {{ .Values.global.imagePullSecrets | first | quote }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
tlsSecretName: {{ .Values.ingress.tls.secretName | quote }}
yProviderApiKey:
value: {{ .Values.secrets.notes.collaborationSecret | quote }}
ingress: backend:
enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName }}
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
tls:
enabled: "{{ .Values.ingress.tls.enabled }}"
secretName: {{ .Values.ingress.tls.secretName | quote }}
ingressCollaborationWS:
enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName }}
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
path: "/collaboration/ws/"
tls:
enabled: "{{ .Values.ingress.tls.enabled }}"
secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Can-Edit, X-User-Id"
nginx.ingress.kubernetes.io/auth-url: https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/documents/collaboration-auth/
nginx.ingress.kubernetes.io/enable-websocket: "true"
nginx.ingress.kubernetes.io/proxy-read-timeout: "86400"
nginx.ingress.kubernetes.io/proxy-send-timeout: "86400"
nginx.ingress.kubernetes.io/upstream-hash-by: $arg_room
ingressAdmin:
enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName }}
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
tls:
enabled: "{{ .Values.ingress.tls.enabled }}"
secretName: {{ .Values.ingress.tls.secretName | quote }}
ingressMedia:
enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName }}
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
annotations:
nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Amz-Date, X-Amz-Content-SHA256"
nginx.ingress.kubernetes.io/auth-url: "https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/documents/media-auth/"
nginx.ingress.kubernetes.io/upstream-vhost: {{ .Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
nginx.ingress.kubernetes.io/use-regex: "true"
nginx.ingress.kubernetes.io/rewrite-target: /{{ .Values.objectstores.notes.bucket }}/$1
nginx.ingress.kubernetes.io/session-cookie-path: /media
tls:
enabled: "{{ .Values.ingress.tls.enabled }}"
secretName: {{ .Values.ingress.tls.secretName | quote }}
ingressCollaborationApi:
enabled: {{ .Values.ingress.enabled }}
className: {{ .Values.ingress.ingressClassName }}
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
path: /collaboration/api/
tls:
enabled: "{{ .Values.ingress.tls.enabled }}"
secretName: {{ .Values.ingress.tls.secretName | quote }}
serviceMedia:
host: {{ .Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
port: {{ .Values.objectstores.notes.port | default 443 }}
frontend:
image: image:
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesFrontend.registry) (.Values.images.notesFrontend.repository) | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesBackend.registry | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} repository: {{ .Values.images.notesBackend.repository | quote }}
tag: {{ .Values.images.notesFrontend.tag }} pullPolicy: "IfNotPresent"
envVars: tag: {{ .Values.images.notesBackend.tag | quote }}
PORT: 8080 ingress:
NEXT_PUBLIC_API_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }} annotations:
NEXT_PUBLIC_Y_PROVIDER_URL: {{ printf "wss://%s.%s/ws" .Values.global.hosts.notes .Values.global.domain | quote }} "nginx.ingress.kubernetes.io/proxy-body-size": "{{ .Values.ingress.parameters.bodySize.notes }}"
NEXT_PUBLIC_MEDIA_URL: {{ printf "https://%s" (.Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain)) | quote }} "nginx.ingress.kubernetes.io/proxy-read-timeout": "{{ .Values.ingress.parameters.bodyTimeout.notes }}"
runtimeEnvs: "nginx.ingress.kubernetes.io/proxy-send-timeout": "{{ .Values.ingress.parameters.bodyTimeout.notes }}"
ICS_BASE_URL: {{ printf "https://%s.%s" .Values.global.hosts.intercomService .Values.global.domain | quote }} {{- if .Values.annotations.notesBackend.ingress }}
PORTAL_BASE_URL: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }} {{ .Values.annotations.notesBackend.ingress | toYaml | nindent 6 }}
replicas: {{ .Values.replicas.notesFrontend }} {{- end }}
resources: ingressClassName: {{ .Values.ingress.ingressClassName }}
{{ .Values.resources.notesFrontend | toYaml | nindent 4 }} ingressAdmin:
securityContext: enabled: true
annotations:
{{ .Values.annotations.notesBackend.ingressAdmin | toYaml | nindent 6 }}
ingressClassName: {{ .Values.ingress.ingressClassName }}
replicaCount: {{ .Values.replicas.notesBackend }}
configuration:
ai:
apiKey:
value: {{ .Values.ai.apiKey }}
baseUrl: {{ .Values.ai.endpoint }}
model: {{ .Values.ai.model | quote }}
aws:
endpointUrl: {{ printf "https://%s" (.Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain)) | quote }}
s3AccessKeyId:
value: {{ .Values.objectstores.notes.username }}
s3SecretAccessKey:
value: {{ .Values.objectstores.notes.secretKey | default .Values.secrets.minio.notesUser | quote }}
storageBucketName: {{ .Values.objectstores.notes.bucket }}
collaboration:
apiUrl: {{ printf "https://%s.%s/collaboration/api/" .Values.global.hosts.notes .Values.global.domain | quote }}
wsUrl: {{ printf "wss://%s.%s/collaboration/ws/" .Values.global.hosts.notes .Values.global.domain | quote }}
database:
host: {{ .Values.databases.notes.host | quote }}
name: {{ .Values.databases.notes.name | quote }}
password:
value: {{ .Values.databases.notes.password | default .Values.secrets.postgresql.notesUser | quote }}
port: {{ .Values.databases.notes.port | quote }}
user:
value: {{ .Values.databases.notes.username | quote }}
email:
brandName: "openDesk"
from: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.mailDomain | default .Values.global.domain }}"
host: "postfix"
port: "25"
logoImage: {{ printf "https://%s.%s/univention/portal/icons/entries/swp.notes.svg" .Values.global.hosts.nubus .Values.global.domain | quote }}
user:
value: {{ printf "%s@%s" "opendesk-system" ( .Values.global.mailDomain | default .Values.global.domain ) }}
password:
value: {{ .Values.secrets.postfix.opendeskSystemPassword | quote }}
oidc:
enabled: true
rpClientId:
value: "opendesk-notes"
rpClientSecret:
value: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
opJWKSEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/certs"
opAuthorizationEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/auth"
opTokenEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token"
opUserEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/userinfo"
opLogoutEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/logout"
rpScopes: "openid opendesk-notes-scope"
loginRedirectUrl: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
loginRedirectUrlFailure: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
logoutRedirectUrl: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
redirectAllowedHosts: {{ printf "https://%s.%s/*" .Values.global.hosts.notes .Values.global.domain | quote }}
essentialClaims: "email"
fullnameFields: "given_name,family_name"
shortnameField: "given_name"
django:
secretKey:
value: {{ .Values.secrets.notes.djangoSecretKey }}
createSuperuser: true
superuserEmail:
value: {{ printf "default.admin@%s" .Values.global.domain | quote }}
superuserPassword:
value: {{ .Values.secrets.notes.superuser }}
frontendTheme: "openDesk"
redisUrl:
value: "redis://default:{{ .Values.cache.notes.password | default .Values.secrets.redis.password }}@{{ .Values.cache.notes.host }}:{{ .Values.cache.notes.port }}/7"
extraEnvVars:
- name: "FRONTEND_HOMEPAGE_FEATURE_ENABLED"
value: "False"
- name: "FRONTEND_FOOTER_FEATURE_ENABLED"
value: "False"
containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
drop: drop:
- "ALL" - "ALL"
enabled: true
privileged: false privileged: false
runAsUser: 1001 runAsUser: 1001
runAsGroup: 1001 runAsGroup: 1001
@@ -100,136 +114,120 @@ frontend:
type: "RuntimeDefault" type: "RuntimeDefault"
readOnlyRootFilesystem: true readOnlyRootFilesystem: true
runAsNonRoot: true runAsNonRoot: true
seLinuxOptions:
{{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }}
podAnnotations:
{{ .Values.annotations.notesBackend.pod | toYaml | nindent 4 }}
podAnnotationsCreateUser:
{{ .Values.annotations.notesBackend.createUserJob | toYaml | nindent 4 }}
podAnnotationsMigrate:
{{ .Values.annotations.notesBackend.migrateJob | toYaml | nindent 4 }}
podSecurityContext:
enabled: true
fsGroup: 1000
fsGroupChangePolicy: "Always"
resources:
{{ .Values.resources.notesBackend | toYaml | nindent 4 }}
service:
annotations:
{{ .Values.annotations.notesBackend.service | toYaml | nindent 6 }}
{{- if .Values.certificate.selfSigned }}
extraVolumes:
- name: "trusted-cert-secret-volume"
secret:
secretName: "opendesk-certificates-ca-tls"
items:
- key: "ca.crt"
path: "ca-certificates.crt"
extraVolumeMounts:
- name: "trusted-cert-secret-volume"
mountPath: "/usr/local/lib/python3.12/site-packages/certifi/cacert.pem"
subPath: "ca-certificates.crt"
{{- end }}
frontend:
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesFrontend.registry | quote }}
repository: {{ .Values.images.notesFrontend.repository | quote }}
pullPolicy: "IfNotPresent"
tag: {{ .Values.images.notesFrontend.tag | quote }}
ingress:
enabled: true
annotations:
{{ .Values.annotations.notesFrontend.ingress | toYaml | nindent 6 }}
ingressClassName: {{ .Values.ingress.ingressClassName }}
ingressMedia:
enabled: true
annotations:
{{ .Values.annotations.notesFrontend.ingressMedia | toYaml | nindent 6 }}
ingressClassName: {{ .Values.ingress.ingressClassName }}
extraEnvVars:
- name: "ICS_BASE_URL"
value: {{ printf "https://%s.%s" .Values.global.hosts.intercomService .Values.global.domain | quote }}
- name: "PORTAL_BASE_URL"
value: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
configuration:
objectStoreHost: {{ printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain | quote }}
resources:
{{ .Values.resources.notesFrontend | toYaml | nindent 4 }}
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- "ALL"
enabled: true
privileged: false
runAsUser: 1000
runAsGroup: 1000
seccompProfile:
type: "RuntimeDefault"
readOnlyRootFilesystem: true
runAsNonRoot: true
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.notesFrontend | toYaml | nindent 6 }} {{ .Values.seLinuxOptions.notesFrontend | toYaml | nindent 6 }}
podAnnotations:
{{ .Values.annotations.notesFrontend.pod | toYaml | nindent 4 }}
podSecurityContext:
enabled: true
fsGroup: 1000
fsGroupChangePolicy: "Always"
service:
annotations:
{{ .Values.annotations.notesFrontend.service | toYaml | nindent 6 }}
serviceMedia:
annotations:
{{ .Values.annotations.notesFrontend.service | toYaml | nindent 6 }}
yProvider: y-provider:
image: image:
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.notesYProvider.registry) (.Values.images.notesYProvider.repository) | quote }} registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.notesYProvider.registry | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} repository: {{ .Values.images.notesYProvider.repository | quote }}
pullPolicy: "IfNotPresent"
tag: {{ .Values.images.notesYProvider.tag }} tag: {{ .Values.images.notesYProvider.tag }}
resources: replicaCount: 1
{{ .Values.resources.notesYProvider | toYaml | nindent 4 }} debug: true
replicas: {{ .Values.replicas.notesYProvider }} {{- if .Values.certificate.selfSigned }}
securityContext: extraEnvVars:
allowPrivilegeEscalation: false - name: "NODE_EXTRA_CA_CERTS"
capabilities: value: "/etc/ssl/certs/cacert.pem"
drop: extraVolumes:
- "ALL" - name: "trusted-cert-secret-volume"
privileged: false secret:
runAsUser: 1001 secretName: "opendesk-certificates-ca-tls"
runAsGroup: 1001 items:
seccompProfile: - key: "ca.crt"
type: "RuntimeDefault" path: "ca-certificates.crt"
readOnlyRootFilesystem: true extraVolumeMounts:
runAsNonRoot: true - name: "trusted-cert-secret-volume"
seLinuxOptions: mountPath: "/etc/ssl/certs/cacert.pem"
{{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }} subPath: "ca-certificates.crt"
envVars: {{- end }}
COLLABORATION_LOGGING: {{ if .Values.debug.enabled }}"true"{{ else }}"false"{{ end }} containerSecurityContext:
COLLABORATION_SERVER_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
COLLABORATION_SERVER_SECRET: {{ .Values.secrets.notes.collaborationSecret | quote }}
Y_PROVIDER_API_KEY: {{ .Values.secrets.notes.collaborationSecret | quote }}
oidc:
clientId: "opendesk-notes"
clientSecret: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
aiApiKey: {{ .Values.ai.apiKey }}
aiBaseUrl: {{ .Values.ai.endpoint }}
djangoSuperUserEmail: "default.admin@{{ .Values.global.domain }}"
djangoSuperUserPass: {{ .Values.secrets.notes.superuser }}
djangoSecretKey: {{ .Values.secrets.notes.djangoSecretKey }}
backend:
image:
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesBackend.registry) (.Values.images.notesBackend.repository) | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
tag: {{ .Values.images.notesBackend.tag }}
replicas: {{ .Values.replicas.notesBackend }}
envVars:
DB_HOST: {{ .Values.databases.notes.host | quote }}
DB_NAME: {{ .Values.databases.notes.name | quote }}
DB_USER: {{ .Values.databases.notes.username | quote }}
DB_PASSWORD: {{ .Values.databases.notes.password | default .Values.secrets.postgresql.notesUser | quote }}
DB_PORT: {{ .Values.databases.notes.port | quote }}
POSTGRES_DB: {{ .Values.databases.notes.name | quote }}
POSTGRES_USER: {{ .Values.databases.notes.username | quote }}
POSTGRES_PASSWORD: {{ .Values.databases.notes.password | default .Values.secrets.postgresql.notesUser | quote }}
FRONTEND_THEME: "openDesk"
REDIS_URL: "redis://default:{{ .Values.cache.notes.password | default .Values.secrets.redis.password }}@{{ .Values.cache.notes.host }}:{{ .Values.cache.notes.port }}/7"
AWS_S3_ENDPOINT_URL: {{ printf "https://%s" (.Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain)) | quote }}
AWS_S3_ACCESS_KEY_ID: {{ .Values.objectstores.notes.username }}
AWS_S3_SECRET_ACCESS_KEY: {{ .Values.objectstores.notes.secretKey | default .Values.secrets.minio.notesUser | quote }}
AWS_STORAGE_BUCKET_NAME: {{ .Values.objectstores.notes.bucket }}
DJANGO_CSRF_TRUSTED_ORIGINS: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
DJANGO_SITE_DOMAIN: {{ printf "%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
DJANGO_SITE_NAME: {{ printf "%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
DJANGO_CONFIGURATION: Production
DJANGO_ALLOWED_HOSTS: "*"
DJANGO_SECRET_KEY: {{ .Values.secrets.notes.djangoSecretKey }}
DJANGO_SETTINGS_MODULE: impress.settings
DJANGO_SUPERUSER_PASSWORD: {{ .Values.secrets.notes.superuser }}
DJANGO_EMAIL_BRAND_NAME: "openDesk"
DJANGO_EMAIL_LOGO_IMG: {{ printf "https://%s.%s/univention/portal/icons/entries/swp.notes.svg" .Values.global.hosts.nubus .Values.global.domain | quote }}
DJANGO_EMAIL_FROM: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.domain }}"
DJANGO_EMAIL_HOST: "postfix"
DJANGO_EMAIL_PORT: 25
DJANGO_EMAIL_USE_SSL: False
DJANGO_EMAIL_HOST_USER: {{ printf "%s@%s" "opendesk-system" ( .Values.global.mailDomain | default .Values.global.domain ) }}
DJANGO_EMAIL_HOST_PASSWORD: {{ .Values.secrets.postfix.opendeskSystemPassword | quote }}
DJANGO_EMAIL_USE_TLS: False
OIDC_RP_CLIENT_ID: "opendesk-notes"
OIDC_RP_CLIENT_SECRET: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
OIDC_OP_JWKS_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/certs"
OIDC_OP_AUTHORIZATION_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/auth"
OIDC_OP_TOKEN_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token"
OIDC_OP_USER_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/userinfo"
OIDC_OP_LOGOUT_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/logout"
OIDC_RP_SIGN_ALGO: RS256
OIDC_RP_SCOPES: "openid opendesk-notes-scope"
USER_OIDC_FIELD_TO_SHORTNAME: "given_name"
USER_OIDC_FIELDS_TO_FULLNAME: "given_name,family_name"
USER_OIDC_ESSENTIAL_CLAIMS: "email"
OIDC_REDIRECT_ALLOWED_HOSTS: {{ printf "https://%s.%s/*" .Values.global.hosts.notes .Values.global.domain | quote }}
OIDC_AUTH_REQUEST_EXTRA_PARAMS: "{}"
OIDC_RENEW_ID_TOKEN: "False"
LOGIN_REDIRECT_URL: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
LOGIN_REDIRECT_URL_FAILURE: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
LOGOUT_REDIRECT_URL: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
AI_BASE_URL: {{ .Values.ai.endpoint | quote }}
AI_API_KEY: {{ .Values.ai.apiKey | quote }}
AI_MODEL: {{ .Values.ai.model | quote }}
Y_PROVIDER_API_KEY: {{ .Values.secrets.notes.collaborationSecret | quote }}
Y_PROVIDER_API_BASE_URL: {{ printf "https://%s.%s/api/" .Values.global.hosts.notes .Values.global.domain | quote }}
COLLABORATION_API_URL: {{ printf "https://%s.%s/collaboration/api/" .Values.global.hosts.notes .Values.global.domain | quote }}
COLLABORATION_SERVER_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
COLLABORATION_SERVER_SECRET: {{ .Values.secrets.notes.collaborationSecret | quote }}
COLLABORATION_WS_URL: {{ printf "wss://%s.%s/collaboration/ws/" .Values.global.hosts.notes .Values.global.domain | quote }}
migrate:
command:
- "/bin/sh"
- "-c"
- |
python manage.py migrate --no-input
restartPolicy: Never
createsuperuser:
command:
- "/bin/sh"
- "-c"
- |
python manage.py createsuperuser --email default.admin@{{ .Values.global.domain }} --password {{ .Values.secrets.notes.superuser }}
restartPolicy: Never
resources:
{{ .Values.resources.notesBackend | toYaml | nindent 4 }}
securityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
drop: drop:
- "ALL" - "ALL"
enabled: true
privileged: false privileged: false
runAsUser: 1001 runAsUser: 1001
runAsGroup: 1001 runAsGroup: 1001
@@ -239,4 +237,21 @@ backend:
runAsNonRoot: true runAsNonRoot: true
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }} {{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }}
ingressCollaborationApi:
annotations:
{{ .Values.annotations.notesYProvider.ingressCollaborationAPI | toYaml | nindent 6 }}
ingressClassName: {{ .Values.ingress.ingressClassName }}
ingressCollaborationWs:
annotations:
{{ .Values.annotations.notesYProvider.ingressCollaborationWS | toYaml | nindent 6 }}
ingressClassName: {{ .Values.ingress.ingressClassName }}
podAnnotations:
{{ .Values.annotations.notesYProvider.pod | toYaml | nindent 4 }}
podSecurityContext:
enabled: true
fsGroup: 1001
fsGroupChangePolicy: "Always"
service:
annotations:
{{ .Values.annotations.notesYProvider.service | toYaml | nindent 6 }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
{{ .Values.annotations.nubusIntercomService.additional | toYaml | nindent 2 }}
containerSecurityContext: containerSecurityContext:
allowPrivilegeEscalation: false allowPrivilegeEscalation: false
capabilities: capabilities:
@@ -50,30 +51,35 @@ global:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
ics: ics:
session:
secret: {{ .Values.secrets.intercom.secret | quote }} secret: {{ .Values.secrets.intercom.secret | quote }}
issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}" issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
originRegex: "{{ .Values.global.domain }}" originRegex: "{{ .Values.global.domain }}"
enableSessionCookie: true enableSessionCookie: true
userUniqueMapper: {{ if .Values.functional.chat.matrix.profile.useImmutableIdentifierForLocalpart }}"opendesk_useruuid"{{ else }}"opendesk_username"{{ end }} userUniqueMapper: {{ if .Values.functional.chat.matrix.profile.useImmutableIdentifierForLocalpart }}"opendesk_useruuid"{{ else }}"opendesk_username"{{ end }}
usernameClaim: "opendesk_username" usernameClaim: "opendesk_username"
logLevel: {{ if .Values.debug.enabled }}"DEBUG"{{ else }}"INFO"{{ end }}
keycloak: keycloak:
realm: {{ .Values.platform.realm | quote }} realm: {{ .Values.platform.realm | quote }}
default: default:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
oidc: oidc:
id: "opendesk-intercom" id: "opendesk-intercom"
secret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }} clientSecret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }}
matrix: matrix:
asSecret: {{ .Values.secrets.intercom.synapseAsToken | quote }}
subdomain: {{ .Values.global.hosts.synapse | quote }} subdomain: {{ .Values.global.hosts.synapse | quote }}
serverName: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}" serverName: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
auth:
applicationServiceSecret: {{ .Values.secrets.intercom.synapseAsToken | quote }}
nordeck: nordeck:
subdomain: {{ .Values.global.hosts.matrixNeoDateFixBot | quote }} subdomain: {{ .Values.global.hosts.matrixNeoDateFixBot | quote }}
portal: portal:
apiKey: {{ .Values.secrets.centralnavigation.apiKey | quote }} auth:
sharedSecret: {{ .Values.secrets.centralnavigation.apiKey | quote }}
redis: redis:
host: {{ .Values.cache.intercomService.host | quote }} host: {{ .Values.cache.intercomService.host | quote }}
port: {{ .Values.cache.intercomService.port }} port: {{ .Values.cache.intercomService.port }}
auth:
password: {{ .Values.cache.intercomService.password | default .Values.secrets.redis.password | quote }} password: {{ .Values.cache.intercomService.password | default .Values.secrets.redis.password | quote }}
openxchange: openxchange:
oci: true oci: true
@@ -99,8 +105,11 @@ ingress:
tls: tls:
enabled: {{ .Values.ingress.tls.enabled }} enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
annotations:
{{ .Values.annotations.nubusIntercomService.ingress | toYaml | nindent 4 }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.nubusIntercomService.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -112,21 +121,20 @@ provisioning:
# client's claims this way. # client's claims this way.
enabled: false enabled: false
config: config:
nubusBaseUrl: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}" clientBaseUrl: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}"
keycloak: keycloak:
url: "http://ums-keycloak:8080/realms/{{ .Values.platform.realm }}/"
username: "kcadmin"
realm: {{ .Values.platform.realm | quote }} realm: {{ .Values.platform.realm | quote }}
connection: connection:
host: "{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}" protocol: "http"
baseUrl: "http://ums-keycloak:8080" host: "ums-keycloak"
credentialSecret: port: 8080
auth:
username: "kcadmin"
existingSecret:
name: "ums-opendesk-keycloak-credentials" name: "ums-opendesk-keycloak-credentials"
keyMapping:
password: "admin_password"
key: "admin_password" key: "admin_password"
ics_client:
clientSecret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }}
credentialSecret:
key: "ics_secret"
image: image:
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }} imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
@@ -150,4 +158,11 @@ replicaCount: {{ .Values.replicas.intercomService }}
resources: resources:
{{ .Values.resources.intercomService | toYaml | nindent 2 }} {{ .Values.resources.intercomService | toYaml | nindent 2 }}
service:
annotations:
{{ .Values.annotations.nubusIntercomService.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.nubusIntercomService.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,12 +1,13 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
imagePullSecrets: imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
additionalAnnotations:
{{ .Values.annotations.nubusNginxS3Gateway.additional | toYaml | nindent 2 }}
image: image:
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nginxS3Gateway.registry | quote }} registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nginxS3Gateway.registry | quote }}
repository: {{ .Values.images.nginxS3Gateway.repository | quote }} repository: {{ .Values.images.nginxS3Gateway.repository | quote }}
@@ -20,6 +21,10 @@ ingress:
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: "/portal-assets/icons/$2/$3" nginx.ingress.kubernetes.io/rewrite-target: "/portal-assets/icons/$2/$3"
nginx.ingress.kubernetes.io/use-regex: "true" nginx.ingress.kubernetes.io/use-regex: "true"
{{- with .Values.annotations.nubusNginxS3Gateway.ingress }}
{{. | toYaml | nindent 4 }}
{{- end }}
path: "/univention/(portal|selfservice)/icons/(logos|entries)/(.*)$" path: "/univention/(portal|selfservice)/icons/(logos|entries)/(.*)$"
tls: tls:
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
@@ -36,8 +41,20 @@ configuration:
secretKey: secretKey:
value: {{ .Values.objectstores.nubus.secretKey | default .Values.secrets.minio.umsUser | quote }} value: {{ .Values.objectstores.nubus.secretKey | default .Values.secrets.minio.umsUser | quote }}
podAnnotations:
{{ .Values.annotations.nubusNginxS3Gateway.pod | toYaml | nindent 2 }}
resources: resources:
{{ .Values.resources.nginxS3Gateway | toYaml | nindent 2 }} {{ .Values.resources.nginxS3Gateway | toYaml | nindent 2 }}
replicaCount: {{ .Values.replicas.nginxS3Gateway }} replicaCount: {{ .Values.replicas.nginxS3Gateway }}
service:
annotations:
{{ .Values.annotations.nubusNginxS3Gateway.service | toYaml | nindent 4 }}
serviceAccount:
annotations:
{{ .Values.annotations.nubusNginxS3Gateway.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -0,0 +1,233 @@
# SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
# SPDX-License-Identifier: Apache-2.0
---
#
# This file is currently optional for customizing purposes only. It will be a mandatory part of Nubus in a later release.
#
nubusGuardian:
authorizationApi:
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
readOnlyRootFilesystem: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
seLinuxOptions:
{{ .Values.seLinuxOptions.umsGuardianAuthorizationApi | toYaml | nindent 8 }}
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianAuthorizationApi.registry | quote }}
repository: {{ .Values.images.nubusGuardianAuthorizationApi.repository }}
tag: {{ .Values.images.nubusGuardianAuthorizationApi.tag }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
podAnnotations:
intents.otterize.com/service-name: "ums-guardian-authorization-api"
{{- with .Values.annotations.nubusGuardian.authorizationApiPod }}
{{ . | toYaml | nindent 6 }}
{{- end }}
podSecurityContext:
fsGroup: 1000
fsGroupChangePolicy: "Always"
replicaCount: {{ .Values.replicas.umsGuardianAuthorizationApi }}
resources:
{{ .Values.resources.umsGuardianAuthorizationApi | toYaml | nindent 6 }}
global:
podAnnotations:
{{ .Values.annotations.nubusGuardian.globalPod | toYaml | nindent 6 }}
ingress:
annotations:
{{ .Values.annotations.nubusGuardian.ingressIngress | toYaml | nindent 6 }}
certManager:
enabled: false
tls:
enabled: {{ .Values.ingress.tls.enabled }}
secretName: {{ .Values.ingress.tls.secretName | quote }}
items:
- name: management-ui
host: ""
# -- Define the Ingress paths.
paths:
- path: /univention/guardian/management-ui
pathType: Prefix
backend:
service:
name: guardian-management-ui
port:
number: 80
ingressClassName: ""
annotations:
{{ .Values.annotations.nubusGuardian.ingressManagementUi | toYaml | nindent 10 }}
tls:
# enabled: true
secretName: ""
- name: management-api
host: ""
paths:
- path: /guardian/management
pathType: Prefix
backend:
service:
name: guardian-management-api
port:
number: 80
ingressClassName: ""
annotations:
{{ .Values.annotations.nubusGuardian.ingressManagementApi | toYaml | nindent 10 }}
tls:
# enabled: true
secretName: ""
- name: authorization-api
host: ""
paths:
- path: /guardian/authorization
pathType: Prefix
backend:
service:
name: guardian-authorization-api
port:
number: 80
ingressClassName: ""
annotations:
{{ .Values.annotations.nubusGuardian.ingressAuthorizationApi | toYaml | nindent 10 }}
tls:
# enabled: true
secretName: ""
managementApi:
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
readOnlyRootFilesystem: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
seLinuxOptions:
{{ .Values.seLinuxOptions.umsGuardianManagementApi | toYaml | nindent 8 }}
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianManagementApi.registry | quote }}
repository: {{ .Values.images.nubusGuardianManagementApi.repository }}
tag: {{ .Values.images.nubusGuardianManagementApi.tag }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
podAnnotations:
intents.otterize.com/service-name: "ums-guardian-management-api"
{{- with .Values.annotations.nubusGuardian.managementApiPod }}
{{ . | toYaml | nindent 6 }}
{{- end }}
podSecurityContext:
fsGroup: 1000
fsGroupChangePolicy: "Always"
replicaCount: {{ .Values.replicas.umsGuardianManagementApi }}
resources:
{{ .Values.resources.umsGuardianManagementApi | toYaml | nindent 6 }}
managementUi:
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
readOnlyRootFilesystem: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
seLinuxOptions:
{{ .Values.seLinuxOptions.umsGuardianManagementUi | toYaml | nindent 8 }}
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianManagementUi.registry | quote }}
repository: {{ .Values.images.nubusGuardianManagementUi.repository }}
tag: {{ .Values.images.nubusGuardianManagementUi.tag }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
podAnnotations:
intents.otterize.com/service-name: "ums-guardian-management-ui"
{{- with .Values.annotations.nubusGuardian.managementUiPod }}
{{ . | toYaml | nindent 6 }}
{{- end }}
replicaCount: {{ .Values.replicas.umsGuardianManagementUi }}
resources:
{{ .Values.resources.umsGuardianManagementUi | toYaml | nindent 6 }}
openPolicyAgent:
containerSecurityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
readOnlyRootFilesystem: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
seLinuxOptions:
{{ .Values.seLinuxOptions.umsGuardianOpenPolicyAgent | toYaml | nindent 8 }}
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusOpenPolicyAgent.registry | quote }}
repository: {{ .Values.images.nubusOpenPolicyAgent.repository }}
tag: {{ .Values.images.nubusOpenPolicyAgent.tag }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
podSecurityContext:
fsGroup: 1000
fsGroupChangePolicy: "Always"
podAnnotations:
intents.otterize.com/service-name: "ums-ums-open-policy-agent"
replicaCount: {{ .Values.replicas.umsGuardianOpenPolicyAgent }}
resources:
{{ .Values.resources.umsOpenPolicyAgent | toYaml | nindent 6 }}
postgresql:
connection:
host: {{ .Values.databases.umsGuardianManagementApi.host | quote }}
port: {{ .Values.databases.umsGuardianManagementApi.port | quote }}
auth:
username: {{ .Values.databases.umsGuardianManagementApi.username | quote }}
database: {{ .Values.databases.umsGuardianManagementApi.name | quote }}
existingSecret:
name: "ums-guardian-postgresql-opendesk-credentials"
keyMapping:
password: "guardianDatabasePassword"
provisioning:
enabled: false
config:
nubusBaseUrl: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain }}
keycloak:
credentialSecret:
name: "ums-opendesk-keycloak-credentials"
key: "admin_password"
realm: {{ .Values.platform.realm | quote }}
username: "kcadmin"
keycloak:
auth:
existingSecret:
name: "ums-opendesk-guardian-client-secret"
keyMapping:
password: "managementApiClientSecret"
connection:
host: "{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}"
baseUrl: "http://ums-keycloak:8080"
image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianProvisioning.registry | quote }}
repository: {{ .Values.images.nubusGuardianProvisioning.repository }}
tag: {{ .Values.images.nubusGuardianProvisioning.tag }}
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
serviceAccount:
annotations:
{{ .Values.annotations.nubusGuardian.serviceAccount | toYaml | nindent 6 }}
---

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: "{{ .Values.global.domain }}" domain: "{{ .Values.global.domain }}"
@@ -98,8 +96,27 @@ config:
intraCluster: intraCluster:
enabled: true enabled: true
internalBaseUrl: "http://ums-keycloak.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}:8080" internalBaseUrl: "http://ums-keycloak.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}:8080"
realmSettings:
accessTokenLifespan: {{ .Values.functional.authentication.realmSettings.accessTokenLifespan }}
revokeRefreshToken: {{ .Values.functional.authentication.realmSettings.revokeRefreshToken }}
ssoSessionIdleTimeout: {{ .Values.functional.authentication.realmSettings.ssoSessionIdleTimeout }}
ssoSessionMaxLifespan: {{ .Values.functional.authentication.realmSettings.ssoSessionMaxLifespan }}
accessCodeLifespanUserAction: {{ .Values.functional.authentication.realmSettings.accessCodeLifespanUserAction }}
accessCodeLifespanLogin: {{ .Values.functional.authentication.realmSettings.accessCodeLifespanLogin }}
offlineSessionIdleTimeout: {{ .Values.functional.authentication.realmSettings.offlineSessionIdleTimeout }}
offlineSessionMaxLifespanEnabled: {{ .Values.functional.authentication.realmSettings.offlineSessionMaxLifespanEnabled }}
offlineSessionMaxLifespan: {{ .Values.functional.authentication.realmSettings.offlineSessionMaxLifespan }}
clientSessionIdleTimeout: {{ .Values.functional.authentication.realmSettings.clientSessionIdleTimeout }}
clientSessionMaxLifespan: {{ .Values.functional.authentication.realmSettings.clientSessionMaxLifespan }}
clientOfflineSessionIdleTimeout: {{ .Values.functional.authentication.realmSettings.clientOfflineSessionIdleTimeout }}
clientOfflineSessionMaxLifespan: {{ .Values.functional.authentication.realmSettings.clientOfflineSessionMaxLifespan }}
ssoFederation:
enabled: {{ .Values.functional.authentication.ssoFederation.enabled }}
enforceFederatedLogin: {{ .Values.functional.authentication.ssoFederation.enforceFederatedLogin }}
name: {{ .Values.functional.authentication.ssoFederation.name | quote }}
idpDetails: {{ .Values.functional.authentication.ssoFederation.idpDetails | toYaml | nindent 6 }}
twoFactorSettings: twoFactorSettings:
additionalGroups: {{ .Values.functional.authentication.twoFactor.groups }} additionalGroups: {{ .Values.functional.authentication.twoFactor.groups | toYaml | nindent 6 }}
precreateGroups: [ 'Domain Admins', 'Domain Users', '2fa-users', 'IAM API - Full Access', precreateGroups: [ 'Domain Admins', 'Domain Users', '2fa-users', 'IAM API - Full Access',
{{ if .Values.apps.nextcloud.enabled }}'managed-by-attribute-Fileshare', 'managed-by-attribute-FileshareAdmin',{{ end }} {{ if .Values.apps.nextcloud.enabled }}'managed-by-attribute-Fileshare', 'managed-by-attribute-FileshareAdmin',{{ end }}
{{ if .Values.apps.xwiki.enabled }}'managed-by-attribute-Knowledgemanagement', 'managed-by-attribute-KnowledgemanagementAdmin',{{ end }} {{ if .Values.apps.xwiki.enabled }}'managed-by-attribute-Knowledgemanagement', 'managed-by-attribute-KnowledgemanagementAdmin',{{ end }}
@@ -512,7 +529,10 @@ config:
publicClient: false publicClient: false
authorizationServicesEnabled: false authorizationServicesEnabled: false
attributes: attributes:
use.refresh.tokens: true
backchannel.logout.session.required: true backchannel.logout.session.required: true
standard.token.exchange.enabled: true
standard.token.exchange.enableRefreshRequestedTokenType: "SAME_SESSION"
backchannel.logout.revoke.offline.tokens: true backchannel.logout.revoke.offline.tokens: true
backchannel.logout.url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/backchannel-logout" backchannel.logout.url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/backchannel-logout"
protocolMappers: protocolMappers:
@@ -744,9 +764,15 @@ containerSecurityContext:
additionalAnnotations: additionalAnnotations:
argocd.argoproj.io/hook: "Sync" argocd.argoproj.io/hook: "Sync"
argocd.argoproj.io/hook-delete-policy: "BeforeHookCreation" argocd.argoproj.io/hook-delete-policy: "BeforeHookCreation"
{{- with .Values.annotations.nubusKeycloakBootstrap.additional }}
{{. | toYaml | nindent 2 }}
{{- end }}
podAnnotations: podAnnotations:
intents.otterize.com/service-name: "ums-keycloak-bootstrap" intents.otterize.com/service-name: "ums-keycloak-bootstrap"
{{- with .Values.annotations.nubusKeycloakBootstrap.pod }}
{{. | toYaml | nindent 2 }}
{{- end }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
@@ -756,6 +782,10 @@ podSecurityContext:
resources: resources:
{{ .Values.resources.opendeskKeycloakBootstrap | toYaml | nindent 2 }} {{ .Values.resources.opendeskKeycloakBootstrap | toYaml | nindent 2 }}
serviceAccount:
annotations:
{{ .Values.annotations.nubusKeycloakBootstrap.serviceAccount | toYaml | nindent 4 }}
{{- if .Values.certificate.selfSigned }} {{- if .Values.certificate.selfSigned }}
extraVolumes: extraVolumes:
- name: "trusted-cert-secret-volume" - name: "trusted-cert-secret-volume"

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
image: image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.dovecot.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.dovecot.registry | quote }}
@@ -10,7 +8,7 @@ image:
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
imageInitCassandra: imageInitCassandra:
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.cassandra.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.cassandra.registry | quote }}
repository: {{ .Values.images.cassandra.repository | quote }} repository: {{ .Values.images.cassandra.repository | quote }}
tag: {{ .Values.images.cassandra.tag | quote }} tag: {{ .Values.images.cassandra.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
@@ -28,7 +26,7 @@ dovecot:
value: {{ .Values.secrets.cassandra.dovecotDictmapUser | quote }} value: {{ .Values.secrets.cassandra.dovecotDictmapUser | quote }}
keyspace: {{ .Values.databases.dovecotDictmap.name | quote }} keyspace: {{ .Values.databases.dovecotDictmap.name | quote }}
sharedMailboxes: sharedMailboxes:
enabled: false enabled: true
host: {{ .Values.databases.dovecotACL.host | quote }} host: {{ .Values.databases.dovecotACL.host | quote }}
port: {{ .Values.databases.dovecotACL.port }} port: {{ .Values.databases.dovecotACL.port }}
username: {{ .Values.databases.dovecotACL.username | quote }} username: {{ .Values.databases.dovecotACL.username | quote }}
@@ -36,13 +34,14 @@ dovecot:
value: {{ .Values.secrets.cassandra.dovecotACLUser | quote }} value: {{ .Values.secrets.cassandra.dovecotACLUser | quote }}
keyspace: {{ .Values.databases.dovecotACL.name | quote }} keyspace: {{ .Values.databases.dovecotACL.name | quote }}
objectStorage: objectStorage:
bucket: {{ .Values.objectstores.dovecot.bucket | quote }}
encryption: encryption:
privateKey: privateKey:
value: {{ env "DOVECOT_CRYPT_PRIVATE_KEY" | quote }} value: {{ requiredEnv "DOVECOT_CRYPT_PRIVATE_KEY" | quote }}
publicKey: publicKey:
value: {{ env "DOVECOT_CRYPT_PUBLIC_KEY" | quote }} value: {{ requiredEnv "DOVECOT_CRYPT_PUBLIC_KEY" | quote }}
fqdn: {{ .Values.objectstores.dovecot.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }} fqdn: {{ .Values.objectstores.dovecot.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
username: {{ .Values.objectstores.dovecot.username | quote }} username: {{ .Values.objectstores.dovecot.username | quote }}
password: password:
value: {{ .Values.secrets.minio.dovecotUser | quote }} value: {{ .Values.objectstores.dovecot.secretKey | default .Values.secrets.minio.dovecotUser | quote }}
... ...

View File

@@ -1,9 +1,10 @@
{{/* # SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
commonAnnotations:
{{ .Values.annotations.openxchangeDovecot.common | toYaml | nindent 2 }}
image: image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.dovecot.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.dovecot.registry | quote }}
repository: {{ .Values.images.dovecot.repository | quote }} repository: {{ .Values.images.dovecot.repository | quote }}
@@ -20,7 +21,8 @@ imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 2 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 2 }}
dovecot: dovecot:
mailDomain: {{ .Values.global.mailDomain | default .Values.global.domain | quote }} mailDomains: {{ toYaml (prepend .Values.global.additionalMailDomains (.Values.global.mailDomain | default .Values.global.domain) | uniq) | nindent 4 }}
defaultMailDomain: {{ .Values.global.mailDomain | default .Values.global.domain | quote }}
password: password:
value: {{ .Values.secrets.dovecot.doveadm | quote }} value: {{ .Values.secrets.dovecot.doveadm | quote }}
migration: migration:
@@ -35,6 +37,7 @@ dovecot:
dn: "uid=ldapsearch_dovecot,cn=users,{{ .Values.ldap.baseDn }}" dn: "uid=ldapsearch_dovecot,cn=users,{{ .Values.ldap.baseDn }}"
password: password:
value: {{ .Values.secrets.nubus.ldapSearch.dovecot | quote }} value: {{ .Values.secrets.nubus.ldapSearch.dovecot | quote }}
loginTrustedNetworks: {{ join " " .Values.cluster.networking.cidr | quote }}
oidc: oidc:
enabled: true enabled: true
clientID: clientID:
@@ -44,7 +47,14 @@ dovecot:
introspectionHost: {{ printf "%s.%s" .Values.global.hosts.keycloak .Values.global.domain | quote }} introspectionHost: {{ printf "%s.%s" .Values.global.hosts.keycloak .Values.global.domain | quote }}
introspectionPath: "/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token/introspect" introspectionPath: "/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token/introspect"
usernameAttribute: "opendesk_username" usernameAttribute: "opendesk_username"
loginTrustedNetworks: {{ join " " .Values.cluster.networking.cidr | quote }} quotaRules:
- "*:storage={{ mul .Values.functional.groupware.quota.default 1024 }}M"
- "Trash:storage=+{{ div (mul (mul .Values.functional.groupware.quota.default 1024) 20) 100 }}M"
- "LAZY_EXPUNGE:ignore"
quotaGrace: "{{ div (mul (mul .Values.functional.groupware.quota.default 1024) 10) 100 }}M"
sieve:
notify:
mailtoEnvelopeFrom: "orig_recipient"
submission: submission:
enabled: true enabled: true
ssl: "no" ssl: "no"
@@ -79,8 +89,9 @@ containerSecurityContext:
seLinuxOptions: seLinuxOptions:
{{ .Values.seLinuxOptions.dovecot | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.dovecot | toYaml | nindent 4 }}
{{- if .Values.debug.enabled }}
podAnnotations: {} debug: true
{{- end }}
{{- if .Values.certificate.selfSigned }} {{- if .Values.certificate.selfSigned }}
extraVolumes: extraVolumes:
@@ -111,14 +122,26 @@ persistence:
- "ReadWriteOnce" - "ReadWriteOnce"
{{- end }} {{- end }}
size: {{ .Values.persistence.storages.dovecot.size | quote }} size: {{ .Values.persistence.storages.dovecot.size | quote }}
annotations:
{{ .Values.annotations.openxchangeDovecot.persistence | toYaml | nindent 4 }}
podAnnotations:
{{ .Values.annotations.openxchangeDovecot.pod | toYaml | nindent 2 }}
resources: resources:
{{ .Values.resources.dovecot | toYaml | nindent 2 }} {{ .Values.resources.dovecot | toYaml | nindent 2 }}
{{- if or (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "NodePort") (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "LoadBalancer") }} {{- if or (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "NodePort") (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "LoadBalancer") }}
service: service:
annotations:
{{ .Values.annotations.openxchangeDovecot.service | toYaml | nindent 4 }}
external: external:
enabled: true enabled: true
type: {{ coalesce .Values.service.type.dovecot .Values.cluster.service.type | quote }} type: {{ coalesce .Values.service.type.dovecot .Values.cluster.service.type | quote }}
{{- end }} {{- end }}
serviceAccount:
annotations:
{{ .Values.annotations.openxchangeDovecot.serviceAccount | toYaml | nindent 4 }}
... ...

View File

@@ -1,9 +1,14 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
additionalAnnotations:
argocd.argoproj.io/hook: "Sync"
argocd.argoproj.io/hook-delete-policy: "HookSucceeded"
{{- with .Values.annotations.openxchangeBootstrap.additional }}
{{ . | toYaml | nindent 2 }}
{{- end }}
cleanup: cleanup:
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }} deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }} deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
@@ -31,7 +36,12 @@ image:
imagePullSecrets: imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 2 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 2 }}
additionalAnnotations: serviceAccount:
argocd.argoproj.io/hook: "Sync" annotations:
argocd.argoproj.io/hook-delete-policy: "HookSucceeded" {{ .Values.annotations.openxchangeBootstrap.serviceAccount | toYaml | nindent 4 }}
filestore:
# identifier must match identifier in /opt/open-xchange/etc/filestore-s3.properties
identifier: "ox-filestore-s3"
size: {{ .Values.objectstores.openxchange.maxSize }}
... ...

View File

@@ -1,12 +1,14 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
appsuite: appsuite:
core-mw: core-mw:
podAnnotations:
logging.open-xchange.com/format: "appsuite-json"
{{- with .Values.annotations.openxchangeEnterpriseContactPicker.appsuiteCoreMwPod }}
{{ . | toYaml | nindent 6 }}
{{- end }}
properties: properties:
# Enterprise contact picker # Enterprise contact picker
com.openexchange.contacts.ldap.accounts: "opendesk,other,functional" com.openexchange.contacts.ldap.accounts: "opendesk,other,functional"
@@ -28,9 +30,14 @@ appsuite:
dn: "uid=ldapsearch_ox,cn=users,{{ .Values.ldap.baseDn }}" dn: "uid=ldapsearch_ox,cn=users,{{ .Values.ldap.baseDn }}"
password: {{ .Values.secrets.nubus.ldapSearch.ox | quote }} password: {{ .Values.secrets.nubus.ldapSearch.ox | quote }}
serviceAccount:
annotations:
{{ .Values.annotations.openxchangeEnterpriseContactPicker.appsuiteCoreMwServiceAccount | toYaml | nindent 8 }}
uiSettings: uiSettings:
# Enterprise contact picker # Enterprise contact picker
io.ox/core//features/enterprisePicker/enabled: "true" io.ox/core//features/enterprisePicker/enabled: "true"
io.ox/contacts//search/fields: 'email1,email2'
yamlFiles: yamlFiles:
contacts-provider-ldap.yml: contacts-provider-ldap.yml:
@@ -278,6 +285,7 @@ appsuite:
givenname: "givenName" givenname: "givenName"
surname: "sn" surname: "sn"
email1: "mailPrimaryAddress" email1: "mailPrimaryAddress"
email2: "mailAlternativeAddress"
department: "oxDepartment,department" department: "oxDepartment,department"
company: "oxCompany,o" company: "oxCompany,o"
branches: "oxBranches" branches: "oxBranches"
@@ -289,8 +297,6 @@ appsuite:
city_home: "oxCityHome" city_home: "oxCityHome"
commercial_register: "oxCommercialRegister" commercial_register: "oxCommercialRegister"
country_home: "oxCountryHome" country_home: "oxCountryHome"
email2: "oxEmail2"
email3: "oxEmail3"
employeetype: "employeeType" employeetype: "employeeType"
fax_business: "oxFaxBusiness,facsimileTelehoneNumber" fax_business: "oxFaxBusiness,facsimileTelehoneNumber"
fax_home: "oxFaxHome" fax_home: "oxFaxHome"

View File

@@ -1,7 +1,5 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
appsuite: appsuite:
plugins-ui: plugins-ui:

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
hostname: "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}" hostname: "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
@@ -32,7 +30,8 @@ nextcloud-integration-ui:
{{- range .Values.global.imagePullSecrets }} {{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }} - name: {{ . | quote }}
{{- end }} {{- end }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeNextcloudIntegrationUi.pod | toYaml | nindent 4 }}
replicaCount: {{ .Values.replicas.openxchangeNextcloudIntegrationUI }} replicaCount: {{ .Values.replicas.openxchangeNextcloudIntegrationUI }}
resources: resources:
{{ .Values.resources.openxchangeNextcloudIntegrationUI | toYaml | nindent 4 }} {{ .Values.resources.openxchangeNextcloudIntegrationUI | toYaml | nindent 4 }}
@@ -66,7 +65,8 @@ public-sector-ui:
{{- end }} {{- end }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
replicaCount: {{ .Values.replicas.openxchangePublicSectorUI }} replicaCount: {{ .Values.replicas.openxchangePublicSectorUI }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangePublicSectorUi.pod | toYaml | nindent 4 }}
resources: resources:
{{ .Values.resources.openxchangePublicSectorUI | toYaml | nindent 4 }} {{ .Values.resources.openxchangePublicSectorUI | toYaml | nindent 4 }}
securityContext: securityContext:
@@ -95,6 +95,8 @@ appsuite:
istio: istio:
enabled: false enabled: false
ingress: ingress:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.ingress | toYaml | nindent 6 }}
enabled: {{ .Values.ingress.enabled }} enabled: {{ .Values.ingress.enabled }}
ingressClassName: {{ .Values.ingress.ingressClassName | quote }} ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
tls: tls:
@@ -104,14 +106,108 @@ appsuite:
hosts: hosts:
- "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}" - "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
dav: dav:
enabled: {{ .Values.functional.groupware.davSupport.enabled }}
hosts: hosts:
- "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}" - "{{ .Values.global.hosts.openxchangeDav }}.{{ .Values.global.domain }}"
routes: routes:
appsuite-base:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.appsuitebase | toYaml | nindent 10 }}
rootredirect:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.rootredirect | toYaml | nindent 10 }}
trailslash:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.trailslash | toYaml | nindent 10 }}
rest-routes-admin:
{{- if .Values.technical.oxAppSuite.provisioning.dedicatedCoreMwPod }}
enabled: false
{{- end }}
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.restRoutesAdmin | toYaml | nindent 10 }}
rest-routes-advertisement:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.restRoutesAdvertisement | toYaml | nindent 10 }}
rest-routes-chronos:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.restRoutesChronos | toYaml | nindent 10 }}
rest-routes-preliminary:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.restRoutesPreliminary | toYaml | nindent 10 }}
rest-routes-userfeedback:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.restRoutesUserfeedback | toYaml | nindent 10 }}
static-routes-servlet:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.staticRoutesServlet | toYaml | nindent 10 }}
static-routes-realtime:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.staticRoutesRealtime | toYaml | nindent 10 }}
static-routes-infostore:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.staticRoutesInfostore | toYaml | nindent 10 }}
static-routes-webservices:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.staticRoutesWebservices | toYaml | nindent 10 }}
drive-client-windows-ox-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.driveClientWindowsOxRoute | toYaml | nindent 10 }}
guard-api-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.guardApiRoute | toYaml | nindent 10 }}
guard-support-api-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.guardSupportApiRoute | toYaml | nindent 10 }}
guard-pgp-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.guardPgpRoute | toYaml | nindent 10 }}
http-api-routes-api:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.httpApiRoutesApi | toYaml | nindent 10 }}
http-api-routes-ajax:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.httpApiRoutesAjax | toYaml | nindent 10 }}
http-api-routes-appsuite-api: http-api-routes-appsuite-api:
annotations: annotations:
nginx.ingress.kubernetes.io/proxy-body-size: "{{ .Values.ingress.parameters.bodySize.oxAppSuite }}" nginx.ingress.kubernetes.io/proxy-body-size: "{{ .Values.ingress.parameters.bodySize.oxAppSuite }}"
nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.oxAppSuite }}" nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.oxAppSuite }}"
nginx.ingress.kubernetes.io/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.oxAppSuite }}" nginx.ingress.kubernetes.io/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.oxAppSuite }}"
{{- with .Values.annotations.openxchangeAppsuiteIngress.httpApiRoutesAppsuiteApi }}
{{ . | toYaml | nindent 10 }}
{{- end }}
http-api-routes-app-root-api:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.httpApiRoutesAppRootApi | toYaml | nindent 10 }}
rt2-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.rt2Route | toYaml | nindent 10 }}
documents-help-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.documentsHelpRoute | toYaml | nindent 10 }}
drive-help-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.driveHelpRoute | toYaml | nindent 10 }}
core-help-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.coreHelpRoute | toYaml | nindent 10 }}
office-web-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.officeWebRoute | toYaml | nindent 10 }}
caldav-well-known-redirect:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.caldavWellKnownRedirect | toYaml | nindent 10 }}
carddav-well-known-redirect:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.carddavWellKnownRedirect | toYaml | nindent 10 }}
dav-infostore-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.davInfostoreRoute | toYaml | nindent 10 }}
dav-root-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.davRootRoute | toYaml | nindent 10 }}
wopi-server-route:
annotations:
{{ .Values.annotations.openxchangeAppsuiteIngress.wopiServerRoute | toYaml | nindent 10 }}
trailslash: trailslash:
enabled: false enabled: false
core-mw: core-mw:
@@ -121,7 +217,79 @@ appsuite:
host: "all" host: "all"
productName: {{ .Values.theme.texts.productName | quote }} productName: {{ .Values.theme.texts.productName | quote }}
oidcLogin: true oidcLogin: true
oidcPath: "/oidc" oidcPath: "/oidc/"
defaultScaling:
nodes:
default:
roles:
- http-api
- sync
- admin
- businessmobility
- request-analyzer
roles:
admin:
values:
features:
status:
admin: "enabled"
packages:
status:
open-xchange-admin-contextrestore: "enabled"
open-xchange-admin-oauth-provider: "enabled"
open-xchange-admin-soap: "enabled"
open-xchange-admin-soap-usercopy: "enabled"
open-xchange-admin-user-copy: "enabled"
{{- if .Values.functional.migration.oxAppSuite.enabled }}
migration:
values:
packages:
status:
open-xchange-oidc: "disabled"
open-xchange-authentication-masterpassword: "enabled"
properties:
com.openexchange.calendar.allowOrganizerPartStatChanges: "true"
propertiesFiles:
/opt/open-xchange/etc/masterpassword-authentication.properties:
com.openexchange.authentication.masterpassword.password: {{ .Values.secrets.oxAppSuite.migrationsMasterPassword | quote }}
services:
- type: ClusterIP
ports:
- port: 80
targetPort: http
protocol: TCP
name: http
{{- end }}
scaling:
nodes:
{{- if .Values.functional.migration.oxAppSuite.enabled }}
migration:
replicas: 1
roles:
- "migration"
{{- end }}
{{- if .Values.technical.oxAppSuite.provisioning.dedicatedCoreMwPod }}
groupware:
replicas: {{ .Values.replicas.openxchangeCoreMW }}
roles:
- "http-api"
- "sync"
- "businessmobility"
- "request-analyzer"
admin:
replicas: 1
roles:
- "admin"
{{- else }}
groupware:
replicas: {{ .Values.replicas.openxchangeCoreMW }}
roles:
- "http-api"
- "sync"
- "businessmobility"
- "request-analyzer"
- "admin"
{{- end }}
masterAdmin: "admin" masterAdmin: "admin"
masterPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }} masterPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }}
hzGroupName: "hzgroup" hzGroupName: "hzgroup"
@@ -131,8 +299,11 @@ appsuite:
jolokiaLogin: "jolokia" jolokiaLogin: "jolokia"
jolokiaPassword: {{ .Values.secrets.oxAppSuite.jolokiaPassword | quote }} jolokiaPassword: {{ .Values.secrets.oxAppSuite.jolokiaPassword | quote }}
hostname: "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}" hostname: "{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreMw.pod | toYaml | nindent 6 }}
serviceAccount: serviceAccount:
annotations:
{{ .Values.annotations.openxchangeAppsuiteCoreMw.serviceAccount | toYaml | nindent 8 }}
create: true create: true
features: features:
status: status:
@@ -140,6 +311,10 @@ appsuite:
# admin: enabled # admin: enabled
documents: "disabled" documents: "disabled"
guard: "enabled" guard: "enabled"
# disabling admin role breaks webmail
# {{- if .Values.technical.oxAppSuite.provisioning.dedicatedCoreMwPod }}
# admin: "disabled"
# {{- end }}
gotenberg: gotenberg:
enabled: true enabled: true
imagePullSecrets: imagePullSecrets:
@@ -151,7 +326,8 @@ appsuite:
tag: {{ .Values.images.openxchangeGotenberg.tag | quote }} tag: {{ .Values.images.openxchangeGotenberg.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
replicaCount: {{ .Values.replicas.openxchangeGotenberg }} replicaCount: {{ .Values.replicas.openxchangeGotenberg }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreMw.gotenbergPod | toYaml | nindent 8 }}
resources: resources:
{{ .Values.resources.openxchangeGotenberg | toYaml | nindent 8 }} {{ .Values.resources.openxchangeGotenberg | toYaml | nindent 8 }}
securityContext: securityContext:
@@ -178,22 +354,34 @@ appsuite:
chown open-xchange:open-xchange /opt/open-xchange/guard-files chown open-xchange:open-xchange /opt/open-xchange/guard-files
packages: packages:
status: status:
{{- if .Values.functional.migration.oxAppSuite.enabled }}
open-xchange-authentication-masterpassword: "enabled"
open-xchange-authentication-ldap: "disabled"
open-xchange-authentication-oauth: "disabled"
open-xchange-oidc: "disabled"
{{- else }}
open-xchange-oidc: "enabled" open-xchange-oidc: "enabled"
open-xchange-authentication-masterpassword: "disabled"
open-xchange-authentication-oauth: "disabled"
open-xchange-authentication-database: "disabled" open-xchange-authentication-database: "disabled"
open-xchange-authentication-oauth: "enabled"
open-xchange-authentication-ldap: "disabled" open-xchange-authentication-ldap: "disabled"
{{- end }}
# OX Documents (office-web) is not used in openDesk # OX Documents (office-web) is not used in openDesk
open-xchange-documents-backend: "disabled" open-xchange-documents-backend: "disabled"
open-xchange-documents-monitoring: "disabled" open-xchange-documents-monitoring: "disabled"
open-xchange-documents-templates: "disabled" open-xchange-documents-templates: "disabled"
# Required for the central contacts integration
open-xchange-oauth-provider: "enabled"
# Needed to set com.openexchange.hostname
open-xchange-hostname-config-cascade: "enabled"
# Enable s3 storage
open-xchange-filestore-s3: "enabled"
{{- if .Values.technical.oxAppSuite.provisioning.dedicatedCoreMwPod }}
# disabling admin feature breaks webmail, so only sub packages are disabled:
open-xchange-admin-contextrestore: "disabled"
open-xchange-admin-oauth-provider: "disabled"
open-xchange-admin-soap: "disabled"
open-xchange-admin-soap-usercopy: "disabled"
open-xchange-admin-user-copy: "disabled"
{{- end }}
{{- if .Values.functional.groupware.davSupport.enabled }}
open-xchange-authentication-application-storage-rdb: "enabled"
{{- end }}
properties: properties:
com.openexchange.hostname: {{ printf "%s.%s" .Values.global.hosts.openxchange .Values.global.domain }}
com.openexchange.UIWebPath: "/appsuite/" com.openexchange.UIWebPath: "/appsuite/"
com.openexchange.showAdmin: "false" com.openexchange.showAdmin: "false"
# PDF Export # PDF Export
@@ -223,6 +411,8 @@ appsuite:
com.openexchange.oidc.startDefaultBackend: "true" com.openexchange.oidc.startDefaultBackend: "true"
com.openexchange.oidc.userLookupClaim: "opendesk_username" com.openexchange.oidc.userLookupClaim: "opendesk_username"
com.openexchange.oidc.userLookupNamePart: "full" com.openexchange.oidc.userLookupNamePart: "full"
com.openexchange.oidc.enablePasswordGrant: "true"
com.openexchange.oidc.passwordGrantUserNamePart: "local-part"
# OAUTH # OAUTH
com.openexchange.oauth.provider.enabled: "true" com.openexchange.oauth.provider.enabled: "true"
com.openexchange.oauth.provider.allowedIssuer: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}" com.openexchange.oauth.provider.allowedIssuer: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
@@ -232,18 +422,24 @@ appsuite:
com.openexchange.oauth.provider.mode: "expect_jwt" com.openexchange.oauth.provider.mode: "expect_jwt"
com.openexchange.oauth.provider.userLookupNamePart: "full" com.openexchange.oauth.provider.userLookupNamePart: "full"
com.openexchange.oauth.provider.userLookupClaim: "opendesk_username" com.openexchange.oauth.provider.userLookupClaim: "opendesk_username"
com.openexchange.authentication.oauth.clientId: "opendesk-oxappsuite"
com.openexchange.authentication.oauth.tokenEndpoint: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token"
com.openexchange.authentication.oauth.clientSecret: {{ .Values.secrets.keycloak.clientSecret.as8oidc | quote }}
# MAIL # MAIL
com.openexchange.mail.authType: "xoauth2" com.openexchange.mail.authType: "xoauth2"
com.openexchange.mail.loginSource: "mail" com.openexchange.mail.loginSource: "name"
com.openexchange.mail.mailServer: "dovecot" com.openexchange.mail.mailServer: "dovecot"
com.openexchange.mail.mailServerSource: "global" com.openexchange.mail.mailServerSource: "global"
com.openexchange.mail.transport.authType: "xoauth2" com.openexchange.mail.transport.authType: "xoauth2"
com.openexchange.mail.transportServer: "postfix-ox" com.openexchange.mail.transportServer: "postfix-ox"
com.openexchange.mail.transportServerSource: "global" com.openexchange.mail.transportServerSource: "global"
# Requirements for OX-Connector # Mail Login Resolver
com.openexchange.mail.login.resolver.enabled: "true"
com.openexchange.mail.login.resolver.ldap.enabled: "true"
com.openexchange.mail.login.resolver.ldap.clientId: "contactsLdapClient"
com.openexchange.mail.login.resolver.ldap.mailLoginSearchFilter: "(entryUUID=[mailLogin])"
com.openexchange.mail.login.resolver.ldap.userNameAttribute: "uid"
com.openexchange.mail.login.resolver.ldap.contextNameAttribute: "oxContextIDNum"
com.openexchange.mail.login.resolver.ldap.entitySearchFilter: "(&(oxContextIDNum=[cid])(uid=[uname]))"
com.openexchange.mail.login.resolver.ldap.mailLoginAttribute: "entryUUID"
# Requirements for OX Connector
com.openexchange.user.enforceUniqueDisplayName: "false" com.openexchange.user.enforceUniqueDisplayName: "false"
com.openexchange.folderstorage.database.preferDisplayName: "false" com.openexchange.folderstorage.database.preferDisplayName: "false"
# Mailfilter # Mailfilter
@@ -297,7 +493,19 @@ appsuite:
# Usage (in browser console after login): # Usage (in browser console after login):
# http = (await import('./io.ox/core/http.js')).default # http = (await import('./io.ox/core/http.js')).default
# await http.POST({ module: 'oxguard/smime', params: { action: 'test' } }) # await http.POST({ module: 'oxguard/smime', params: { action: 'test' } })
com.openexchange.smime.test: "true" com.openexchange.smime.test: {{ .Values.debug.enabled | quote }}
# DAV
{{- if .Values.functional.groupware.davSupport.enabled }}
com.openexchange.caldav.enabled: "true"
com.openexchange.caldav.url: {{ printf "https://%s.%s/caldav/[folderId]" .Values.global.hosts.openxchangeDav .Values.global.domain }}
com.openexchange.carddav.enabled: "true"
com.openexchange.carddav.url: {{ printf "https://%s.%s/carddav/[folderId]" .Values.global.hosts.openxchangeDav .Values.global.domain }}
com.openexchange.client.onboarding.caldav.url: {{ printf "https://%s.%s/" .Values.global.hosts.openxchangeDav .Values.global.domain }}
com.openexchange.client.onboarding.carddav.url: {{ printf "https://%s.%s/" .Values.global.hosts.openxchangeDav .Values.global.domain }}
{{- else }}
com.openexchange.caldav.enabled: "false"
com.openexchange.carddav.enabled: "false"
{{- end }}
# Other # Other
com.openexchange.secret.secretSource: "\"<user-id> + '@' + <context-id> + '/' + <random>\"" com.openexchange.secret.secretSource: "\"<user-id> + '@' + <context-id> + '/' + <random>\""
{{- if .Values.certificate.selfSigned }} {{- if .Values.certificate.selfSigned }}
@@ -307,6 +515,12 @@ appsuite:
com.openexchange.net.ssl.custom.truststore.path: "/etc/ssl/certs/truststore.jks" com.openexchange.net.ssl.custom.truststore.path: "/etc/ssl/certs/truststore.jks"
com.openexchange.net.ssl.custom.truststore.password: {{ .Values.secrets.certificates.password | quote }} com.openexchange.net.ssl.custom.truststore.password: {{ .Values.secrets.certificates.password | quote }}
{{- end }} {{- end }}
{{- if .Values.functional.groupware.davSupport.enabled }}
com.openexchange.authentication.application.appTypes: "caldav,carddav"
com.openexchange.authentication.application.enabled: "true"
com.openexchange.authentication.application.storage.rdb.loginNameSource: "mail"
com.openexchange.authentication.application.storage.rdb.contextLookupNamePart: "full"
{{- end }}
{{- if .Values.certificate.selfSigned }} {{- if .Values.certificate.selfSigned }}
extraEnv: extraEnv:
- name: "JAVA_OPTS_APPEND" - name: "JAVA_OPTS_APPEND"
@@ -330,19 +544,10 @@ appsuite:
com.openexchange.share.cryptKey: {{ .Values.secrets.oxAppSuite.shareCryptKey | quote }} com.openexchange.share.cryptKey: {{ .Values.secrets.oxAppSuite.shareCryptKey | quote }}
com.openexchange.conference.element.authToken: {{ .Values.secrets.oxAppSuite.synapseAsToken | quote }} com.openexchange.conference.element.authToken: {{ .Values.secrets.oxAppSuite.synapseAsToken | quote }}
propertiesFiles: propertiesFiles:
/opt/open-xchange/etc/masterpassword-authentication.properties:
com.openexchange.authentication.masterpassword.password: {{ .Values.secrets.oxAppSuite.migrationsMasterPassword | quote }}
/opt/open-xchange/etc/AdminDaemon.properties: /opt/open-xchange/etc/AdminDaemon.properties:
MASTER_ACCOUNT_OVERRIDE: "true" MASTER_ACCOUNT_OVERRIDE: "true"
/opt/open-xchange/etc/AdminUser.properties: /opt/open-xchange/etc/AdminUser.properties:
USERNAME_CHANGEABLE: "true" USERNAME_CHANGEABLE: "true"
/opt/open-xchange/etc/system.properties:
SERVER_NAME: "oxserver"
/opt/open-xchange/etc/ldapauth.properties:
java.naming.provider.url: "ldap://{{ .Values.ldap.host }}:389/{{ .Values.ldap.baseDn }}"
bindDN: "uid=ldapsearch_ox,cn=users,{{ .Values.ldap.baseDn }}"
bindDNPassword: {{ .Values.secrets.nubus.ldapSearch.ox | quote }}
bindOnly: "false"
/opt/open-xchange/etc/antivirus.properties: /opt/open-xchange/etc/antivirus.properties:
com.openexchange.antivirus.enabled: "true" com.openexchange.antivirus.enabled: "true"
{{- if .Values.antivirus.icap.host }} {{- if .Values.antivirus.icap.host }}
@@ -357,6 +562,25 @@ appsuite:
com.openexchange.antivirus.port: "1344" com.openexchange.antivirus.port: "1344"
{{- end }} {{- end }}
com.openexchange.antivirus.maxFileSize: "1024" com.openexchange.antivirus.maxFileSize: "1024"
/opt/open-xchange/etc/filestore-s3.properties:
com.openexchange.filestore.s3.ox-filestore-s3.endpoint: {{ .Values.objectstores.openxchange.endpoint | default (printf "https://%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
com.openexchange.filestore.s3.ox-filestore-s3.bucketName: {{ .Values.objectstores.openxchange.bucket | quote }}
com.openexchange.filestore.s3.ox-filestore-s3.accessKey: {{ .Values.objectstores.openxchange.username | quote }}
com.openexchange.filestore.s3.ox-filestore-s3.secretKey: {{ .Values.objectstores.openxchange.secretKey | default .Values.secrets.minio.openxchangeUser | quote }}
/opt/open-xchange/etc/ldapauth.properties:
java.naming.provider.url: "ldap://{{ .Values.ldap.host }}:389/{{ .Values.ldap.baseDn }}"
bindDN: "uid=ldapsearch_ox,cn=users,{{ .Values.ldap.baseDn }}"
bindDNPassword: {{ .Values.secrets.nubus.ldapSearch.ox | quote }}
bindOnly: "false"
/opt/open-xchange/etc/noreply.properties:
com.openexchange.noreply.address: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.mailDomain | default .Values.global.domain }}"
com.openexchange.noreply.login: {{ printf "%s@%s" "opendesk-system" ( .Values.global.mailDomain | default .Values.global.domain ) }}
com.openexchange.noreply.password: {{ .Values.secrets.postfix.opendeskSystemPassword | quote }}
com.openexchange.noreply.server: "postfix"
com.openexchange.noreply.port: "25"
com.openexchange.noreply.secureMode: "plain"
/opt/open-xchange/etc/system.properties:
SERVER_NAME: "oxserver"
uiSettings: uiSettings:
io.ox.nextcloud//server: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/fs/" io.ox.nextcloud//server: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/fs/"
io.ox.public-sector//ics/url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/" io.ox.public-sector//ics/url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/"
@@ -396,6 +620,8 @@ appsuite:
io.ox/dynamic-theme//folderBackground: {{ .Values.theme.colors.white | quote }} io.ox/dynamic-theme//folderBackground: {{ .Values.theme.colors.white | quote }}
io.ox/dynamic-theme//folderSelected: {{ .Values.theme.colors.primary15 | quote }} io.ox/dynamic-theme//folderSelected: {{ .Values.theme.colors.primary15 | quote }}
io.ox/dynamic-theme//folderHover: {{ .Values.theme.colors.secondaryGreyLight | quote }} io.ox/dynamic-theme//folderHover: {{ .Values.theme.colors.secondaryGreyLight | quote }}
# openDesk logo in top bar links to portal
io.ox/core//logoAction: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
secretETCFiles: secretETCFiles:
# Format of the OX Guard master key: # Format of the OX Guard master key:
# MC+base64(20 random bytes) # MC+base64(20 random bytes)
@@ -421,6 +647,8 @@ appsuite:
# podSecurityContext: {} # podSecurityContext: {}
# securityContext: {} # securityContext: {}
update: update:
podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreMw.updatePod | toYaml | nindent 8 }}
image: image:
repository: {{ .Values.images.openxchangeCoreMW.repository | quote }} repository: {{ .Values.images.openxchangeCoreMW.repository | quote }}
tag: {{ .Values.images.openxchangeCoreMW.tag | quote }} tag: {{ .Values.images.openxchangeCoreMW.tag | quote }}
@@ -434,6 +662,20 @@ appsuite:
initContainer: initContainer:
resources: resources:
{{ .Values.resources.openxchangeCoreMW | toYaml | nindent 8 }} {{ .Values.resources.openxchangeCoreMW | toYaml | nindent 8 }}
{{- if .Values.functional.groupware.davSupport.enabled }}
yamlFiles:
app-password-apps.yml:
caldav:
displayName_t10e: "Calendar Client (CalDAV)"
restrictedScopes: [dav,read_caldav,write_caldav]
requiredCapabilities: [caldav]
sortOrder: 30
carddav:
displayName_t10e: "Addressbook Client (CardDAV)"
restrictedScopes: [dav,read_carddav,write_carddav]
requiredCapabilities: [carddav]
sortOrder: 40
{{- end }}
core-ui: core-ui:
enabled: true enabled: true
@@ -447,7 +689,8 @@ appsuite:
tag: {{ .Values.images.openxchangeCoreUI.tag | quote }} tag: {{ .Values.images.openxchangeCoreUI.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
replicaCount: {{ .Values.replicas.openxchangeCoreUI }} replicaCount: {{ .Values.replicas.openxchangeCoreUI }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreUi.pod | toYaml | nindent 6 }}
resources: resources:
{{ .Values.resources.openxchangeCoreUI | toYaml | nindent 6 }} {{ .Values.resources.openxchangeCoreUI | toYaml | nindent 6 }}
securityContext: securityContext:
@@ -483,7 +726,8 @@ appsuite:
tag: {{ .Values.images.openxchangeCoreUIMiddleware.tag | quote }} tag: {{ .Values.images.openxchangeCoreUIMiddleware.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
overrides: {} overrides: {}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreUiMiddleware.pod | toYaml | nindent 6 }}
redis: *redisConfiguration redis: *redisConfiguration
replicaCount: {{ .Values.replicas.openxchangeCoreUIMiddleware }} replicaCount: {{ .Values.replicas.openxchangeCoreUIMiddleware }}
resources: resources:
@@ -521,12 +765,19 @@ appsuite:
cache: cache:
remoteCache: remoteCache:
enabled: false enabled: false
imagePullSecrets:
{{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }}
{{- end }}
image: image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.openxchangeDocumentConverter.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.openxchangeDocumentConverter.registry | quote }}
repository: {{ .Values.images.openxchangeDocumentConverter.repository | quote }} repository: {{ .Values.images.openxchangeDocumentConverter.repository | quote }}
tag: {{ .Values.images.openxchangeDocumentConverter.tag | quote }} tag: {{ .Values.images.openxchangeDocumentConverter.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
podAnnotations: {} {{- if .Values.annotations.openxchangeAppsuiteCoreDocumentconverter.pod }}
podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreDocumentconverter.pod | toYaml | nindent 6 }}
{{- end }}
redis: *redisConfiguration redis: *redisConfiguration
replicaCount: {{ .Values.replicas.openxchangeCoreDocumentConverter }} replicaCount: {{ .Values.replicas.openxchangeCoreDocumentConverter }}
resources: resources:
@@ -576,7 +827,8 @@ appsuite:
repository: {{ .Values.images.openxchangeCoreGuidedtours.repository | quote }} repository: {{ .Values.images.openxchangeCoreGuidedtours.repository | quote }}
tag: {{ .Values.images.openxchangeCoreGuidedtours.tag | quote }} tag: {{ .Values.images.openxchangeCoreGuidedtours.tag | quote }}
pullPolicy: {{ .Values.global.imagePullPolicy | quote }} pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreGuidedtours.pod | toYaml | nindent 6 }}
replicaCount: {{ .Values.replicas.openxchangeCoreGuidedtours }} replicaCount: {{ .Values.replicas.openxchangeCoreGuidedtours }}
resources: resources:
{{- .Values.resources.openxchangeCoreGuidedtours | toYaml | nindent 6 }} {{- .Values.resources.openxchangeCoreGuidedtours | toYaml | nindent 6 }}
@@ -603,6 +855,10 @@ appsuite:
adminPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }} adminPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }}
basicAuthLogin: "oxlogin" basicAuthLogin: "oxlogin"
basicAuthPassword: {{ .Values.secrets.oxAppSuite.basicAuthPassword | quote }} basicAuthPassword: {{ .Values.secrets.oxAppSuite.basicAuthPassword | quote }}
imagePullSecrets:
{{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }}
{{- end }}
image: image:
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.openxchangeImageConverter.registry | quote }} registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.openxchangeImageConverter.registry | quote }}
repository: {{ .Values.images.openxchangeImageConverter.repository | quote }} repository: {{ .Values.images.openxchangeImageConverter.repository | quote }}
@@ -614,7 +870,10 @@ appsuite:
endpoint: "." endpoint: "."
accessKey: "." accessKey: "."
secretKey: "." secretKey: "."
podAnnotations: {} {{- if .Values.annotations.openxchangeAppsuiteCoreImageconverter.pod }}
podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreImageconverter.pod | toYaml | nindent 6 }}
{{- end }}
redis: *redisConfiguration redis: *redisConfiguration
replicaCount: {{ .Values.replicas.openxchangeCoreImageConverter }} replicaCount: {{ .Values.replicas.openxchangeCoreImageConverter }}
resources: resources:
@@ -683,7 +942,8 @@ appsuite:
{{- range .Values.global.imagePullSecrets }} {{- range .Values.global.imagePullSecrets }}
- name: {{ . | quote }} - name: {{ . | quote }}
{{- end }} {{- end }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangeAppsuiteCoreUserGuide.pod | toYaml | nindent 6 }}
replicaCount: {{ .Values.replicas.openxchangeCoreUserGuide }} replicaCount: {{ .Values.replicas.openxchangeCoreUserGuide }}
resources: resources:
{{- .Values.resources.openxchangeCoreUserGuide | toYaml | nindent 6 }} {{- .Values.resources.openxchangeCoreUserGuide | toYaml | nindent 6 }}

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
{{- if .Values.certificate.selfSigned }} {{- if .Values.certificate.selfSigned }}
extraVolumes: extraVolumes:
@@ -51,7 +49,7 @@ oxConnector:
oxMasterAdmin: "admin" oxMasterAdmin: "admin"
oxMasterPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }} oxMasterPassword: {{ .Values.secrets.oxAppSuite.adminPassword | quote }}
oxSmtpServer: "smtp://127.0.0.1:587" oxSmtpServer: "smtp://127.0.0.1:587"
oxSoapServer: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}" oxSoapServer: "http://open-xchange-core-mw-admin"
provisioningApi: provisioningApi:
connection: connection:
@@ -69,7 +67,8 @@ persistence:
size: {{ .Values.persistence.storages.oxConnector.size | quote }} size: {{ .Values.persistence.storages.oxConnector.size | quote }}
storageClass: {{ coalesce .Values.persistence.storages.oxConnector.storageClassName .Values.persistence.storageClassNames.RWO | quote }} storageClass: {{ coalesce .Values.persistence.storages.oxConnector.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
podAnnotations: {} podAnnotations:
{{ .Values.annotations.nubusOxConnector.pod | toYaml | nindent 2 }}
replicaCount: {{ .Values.replicas.oxConnector }} replicaCount: {{ .Values.replicas.oxConnector }}
@@ -92,6 +91,8 @@ securityContext:
{{ .Values.seLinuxOptions.oxConnector | toYaml | nindent 4 }} {{ .Values.seLinuxOptions.oxConnector | toYaml | nindent 4 }}
serviceAccount: serviceAccount:
annotations:
{{ .Values.annotations.nubusOxConnector.serviceAccount | toYaml | nindent 4 }}
create: true create: true
... ...

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
certificate: certificate:
secretName: {{ .Values.ingress.tls.secretName | quote }} secretName: {{ .Values.ingress.tls.secretName | quote }}
@@ -48,16 +46,26 @@ postfix:
hostname: "postfix" hostname: "postfix"
inetProtocols: "ipv4" inetProtocols: "ipv4"
milterDefaultAction: "tempfail" milterDefaultAction: "tempfail"
overrides:
- fileName: "sasl_passwd.map"
content:
- {{ printf "%s %s:%s" .Values.smtp.host .Values.smtp.username .Values.smtp.password | quote }}
{{- if .Values.apps.dkimpy.enabled }} {{- if .Values.apps.dkimpy.enabled }}
dkimpyHost: "opendesk-dkimpy-milter.{{ .Release.Namespace }}.svc.{{.Values.cluster.networking.domain }}:8892" dkimpyHost: "opendesk-dkimpy-milter.{{ .Release.Namespace }}.svc.{{.Values.cluster.networking.domain }}:8892"
{{- end }} {{- end }}
minTLSVersion: "TLSv1.3"
smtpdTLSMandatoryCiphers: "high"
rspamdHost: "" rspamdHost: ""
relayHost: {{ if .Values.smtp.host }}{{ printf "[%s]:%d" .Values.smtp.host .Values.smtp.port | quote }}{{ else }}""{{ end }} {{- if .Values.smtp.host }}
relayNets: {{ join " " .Values.cluster.networking.cidr | quote }} relayHost:
enabled: true
host: {{ .Values.smtp.host }}
port: {{ .Values.smtp.port }}
authentication:
username:
value: {{ .Values.smtp.username }}
password:
value: {{ .Values.smtp.password }}
{{- end }}
allowRelayNets: false
smtpSASLAuthEnable: "yes" smtpSASLAuthEnable: "yes"
smtpSASLPasswordMaps: "lmdb:/etc/postfix/sasl_passwd.map" smtpSASLPasswordMaps: "lmdb:/etc/postfix/sasl_passwd.map"
smtpTLSSecurityLevel: "encrypt" smtpTLSSecurityLevel: "encrypt"
@@ -81,10 +89,11 @@ postfix:
smtpdMilters: "inet:clamav-simple:7357" smtpdMilters: "inet:clamav-simple:7357"
{{- end }} {{- end }}
{{- end }} {{- end }}
virtualMailboxDomains: {{ if .Values.global.additionalMailDomains }}{{ printf "%s,%s" (.Values.global.mailDomain | default .Values.global.domain) .Values.global.additionalMailDomains }}{{ else }}{{ .Values.global.mailDomain | default .Values.global.domain | quote }}{{ end }} virtualMailboxDomains: {{ toYaml (prepend .Values.global.additionalMailDomains (.Values.global.mailDomain | default .Values.global.domain) | uniq) | nindent 4 }}
virtualTransport: "lmtps:dovecot:24" virtualTransport: "lmtps:dovecot:24"
podAnnotations: {} podAnnotations:
{{ .Values.annotations.openxchangePostfix.pod | toYaml | nindent 2 }}
replicaCount: {{ .Values.replicas.postfix }} replicaCount: {{ .Values.replicas.postfix }}
@@ -93,6 +102,8 @@ resources:
{{- if or (eq (coalesce .Values.service.type.postfix .Values.cluster.service.type) "NodePort") (eq (coalesce .Values.service.type.postfix .Values.cluster.service.type) "LoadBalancer") }} {{- if or (eq (coalesce .Values.service.type.postfix .Values.cluster.service.type) "NodePort") (eq (coalesce .Values.service.type.postfix .Values.cluster.service.type) "LoadBalancer") }}
service: service:
annotations:
{{ .Values.annotations.openxchangePostfix.service | toYaml | nindent 4 }}
external: external:
enabled: true enabled: true
type: {{ coalesce .Values.service.type.postfix .Values.cluster.service.type | quote }} type: {{ coalesce .Values.service.type.postfix .Values.cluster.service.type | quote }}

View File

@@ -1,9 +1,15 @@
{{/*
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
podAnnotations: {} additionalAnnotations:
{{ .Values.annotations.opendeskMigrationsPost.additional | toYaml | nindent 2 }}
podAnnotations:
{{ .Values.annotations.opendeskMigrationsPost.pod | toYaml | nindent 2 }}
serviceAccount:
annotations:
{{ .Values.annotations.opendeskMigrationsPost.serviceAccount | toYaml | nindent 4 }}
migrations: migrations:
stage: "POST" stage: "POST"

View File

@@ -1,9 +1,15 @@
{{/*
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
podAnnotations: {} additionalAnnotations:
{{ .Values.annotations.opendeskMigrationsPre.additional | toYaml | nindent 2 }}
podAnnotations:
{{ .Values.annotations.opendeskMigrationsPre.pod | toYaml | nindent 2 }}
serviceAccount:
annotations:
{{ .Values.annotations.opendeskMigrationsPre.serviceAccount | toYaml | nindent 4 }}
migrations: migrations:
stage: "PRE" stage: "PRE"

View File

@@ -3,7 +3,7 @@
--- ---
repositories: repositories:
# openDesk OpenProject Bootstrap # openDesk OpenProject Bootstrap
# Source: Set when repo is managed on Open CoDE # Source: Set when repo is managed on openCode
- name: "openproject-bootstrap-repo" - name: "openproject-bootstrap-repo"
keyring: "../../files/gpg-pubkeys/opencode.gpg" keyring: "../../files/gpg-pubkeys/opencode.gpg"
verify: {{ .Values.charts.openprojectBootstrap.verify }} verify: {{ .Values.charts.openprojectBootstrap.verify }}

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
@@ -11,6 +9,9 @@ global:
imagePullSecrets: imagePullSecrets:
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }} {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
additionalAnnotations:
{{ .Values.annotations.openprojectBootstrap.additional | toYaml | nindent 2 }}
cleanup: cleanup:
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }} deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }} deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
@@ -72,6 +73,9 @@ image:
job: job:
enabled: true enabled: true
podAnnotations:
{{ .Values.annotations.openprojectBootstrap.pod | toYaml | nindent 2 }}
podSecurityContext: podSecurityContext:
enabled: true enabled: true
fsGroup: 1000 fsGroup: 1000

View File

@@ -1,8 +1,6 @@
{{/* # SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH # SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" # SPDX-License-Identifier: Apache-2.0
SPDX-License-Identifier: Apache-2.0
*/}}
--- ---
global: global:
domain: {{ .Values.global.domain | quote }} domain: {{ .Values.global.domain | quote }}
@@ -23,8 +21,9 @@ global:
synapseFederation: {{ .Values.global.hosts.synapseFederation }} synapseFederation: {{ .Values.global.hosts.synapseFederation }}
whiteboard: {{ .Values.global.hosts.whiteboard }} whiteboard: {{ .Values.global.hosts.whiteboard }}
{{- end }} {{- end }}
{{- if .Values.apps.nubus.enabled }} {{- if .Values.apps.elementAdmin.enabled }}
intercomService: {{ .Values.global.hosts.intercomService }} adminBot: {{ .Values.global.hosts.adminBot }}
synapseAdmin: {{ .Values.global.hosts.synapseAdmin }}
{{- end }} {{- end }}
{{- if .Values.apps.jitsi.enabled }} {{- if .Values.apps.jitsi.enabled }}
jitsi: {{ .Values.global.hosts.jitsi }} jitsi: {{ .Values.global.hosts.jitsi }}
@@ -36,23 +35,27 @@ global:
{{- if .Values.apps.nextcloud.enabled }} {{- if .Values.apps.nextcloud.enabled }}
nextcloud: {{ .Values.global.hosts.nextcloud }} nextcloud: {{ .Values.global.hosts.nextcloud }}
{{- end }} {{- end }}
{{- if .Values.apps.notes.enabled }}
notes: {{ .Values.global.hosts.notes }}
{{- end }}
{{- if .Values.apps.nubus.enabled }}
intercomService: {{ .Values.global.hosts.intercomService }}
keycloak: {{ .Values.global.hosts.keycloak }}
nubus: {{ .Values.global.hosts.nubus }}
{{- end }}
{{- if .Values.apps.openproject.enabled }} {{- if .Values.apps.openproject.enabled }}
openproject: {{ .Values.global.hosts.openproject }} openproject: {{ .Values.global.hosts.openproject }}
{{- end }} {{- end }}
{{- if .Values.apps.oxAppSuite.enabled }} {{- if .Values.apps.oxAppSuite.enabled }}
openxchange: {{ .Values.global.hosts.openxchange }} openxchange: {{ .Values.global.hosts.openxchange }}
openxchangeDav: {{ .Values.global.hosts.openxchangeDav }}
{{- end }} {{- end }}
{{- if .Values.apps.nubus.enabled }} {{- if .Values.apps.staticFiles.enabled }}
keycloak: {{ .Values.global.hosts.keycloak }} static: {{ .Values.global.hosts.static }}
nubus: {{ .Values.global.hosts.nubus }}
{{- end }} {{- end }}
{{- if .Values.apps.xwiki.enabled }} {{- if .Values.apps.xwiki.enabled }}
xwiki: {{ .Values.global.hosts.xwiki }} xwiki: {{ .Values.global.hosts.xwiki }}
{{- end }} {{- end }}
{{- if .Values.apps.notes.enabled }}
notes: {{ .Values.global.hosts.notes }}
{{- end }}
issuerRef: issuerRef:
name: {{ .Values.certificate.issuerRef.name | quote }} name: {{ .Values.certificate.issuerRef.name | quote }}

Some files were not shown because too many files have changed in this diff Show More