chore(release): 1.1.1 [skip ci]

## [1.1.1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.1.0...v1.1.1) (2025-01-27)

### Bug Fixes

* **docs:** Add permissions.md ([04ab28c](04ab28c029))
* **element:** MatrixID for Element "Welcome User" to support deployments where matrix domain differs from homeserver FQDN ([ccb51a0](ccb51a0de3))
* **element:** Update Element to 1.11.90 ([335806a](335806a53e))
* **element:** Update Helm chart to v6.0.2 for a fix when using non generated secrets in `opendesk-synapse` ([d5e73fe](d5e73feb88))
* **element:** Update Synapse to 1.121.1 ([33ff922](33ff9227b7))
* **helmfile:** Move the access restriction configuration for Keycloak client scopes into helmfile templating, instead of hardcoded Helm chart values ([3662b5c](3662b5cd25))
* **helmfile:** Remove duplicate entries from `secrets.yaml.gotmpl` ([a13cf63](a13cf63024))
* **helmfile:** Support component specific storageClassNames. **Note:** Please check the migration.md if you upgrade a deployment that has set custom PVC sizes using `persistence.size` settings. ([bacf51e](bacf51efb1))
* **helmfile:** Support PostgreSQL as alternative database backend for Nextcloud and XWiki. **Note:** PostgreSQL is likely to become the preferred option/default in the future and MariaDB might be deprecated at a later point. ([a0f52ee](a0f52ee7d4))
* **helmfile:** Update `opendesk-alerts` and `opendesk-dashboards` to get predictable sort order, improving GitOps deployments ([0c91117](0c91117575))
* **helmfile:** Update upstream images for k8s/kubectl to v1.32.0 ([b71c2e5](b71c2e57ee))
* **intercom:** Remove legacy OIDC claims ([6796f32](6796f320f7))
* **nextcloud:** Update image and Helm chart to support app toggles during deployment ([1cdfcf2](1cdfcf2784))
* **nextcloud:** Update to Nextcloud 29.0.10 ([d096fb1](d096fb1154))
* **nubus:** Fix `pullPolicy` setting for `ldapServer.leaderElector` to satisfy Kyverno linter ([6f2f7cd](6f2f7cd5db))
* **nubus:** Merge yaml files for better maintainability ([6c67eca](6c67eca7aa))
* **nubus:** Pre-create groups in Keycloak to avoid race condition on group sync when initial users login parallel ([5496317](5496317fee))
* **nubus:** Remove `extra` settings from ldapServer needed for openDesk 1.0.0 LDAP migration ([fab862e](fab862eec6))
* **nubus:** Remove b64 encoded files from CSS, instead use `opendesk-static-files` ([2926e2c](2926e2c93a))
* **nubus:** Template `secrets.nubus.masterpassword`. **Note:** Please check migrations.md for details. ([5aae75a](5aae75a152))
* **nubus:** Update customizations for group cleanup ([0b230fa](0b230fa2cc))
* **open-xchange:** Add missing `registryOpencodeDe` to OX-Connector's `waitForDependency` image ([a16d907](a16d9071c9))
* **openproject:** Update to 15.1.1 ([b4b714f](b4b714ff41))
* **openproject:** Update to 15.2.0 ([9d8e9c3](9d8e9c3ade))
* **static-files:** Update Helm chart to use more generic `assets` over `theme.imagery.assets` ([63562c1](63562c1aae))
* **static-files:** Update Helm chart to v4.0.1 to support longer domain names ([b0e665b](b0e665b031))
* **xwiki:** Update Helm chart to v1.4.1 to fix support for custom `ingressClassName` values. Ref [#144](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/issues/144) ([033cb55](033cb558dd))

.gitignore

@@ -2,7 +2,26 @@
 # SPDX-License-Identifier: Apache-2.0
 .vscode
 .idea
+.yamllint
 
 # Ignore changes to sample environments
-helmfile/environments/dev/values.yaml
-helmfile/environments/prod/values.yaml
+helmfile/environments/dev/*.yaml.gotmpl
+helmfile/environments/test/*.yaml.gotmpl
+helmfile/environments/prod/*.yaml.gotmpl
+!helmfile/environments/dev/sample.yaml.gotmpl
+!helmfile/environments/test/sample.yaml.gotmpl
+!helmfile/environments/prod/sample.yaml.gotmpl
+
+# Ignore in CI generated files
+.kyverno/opendesk.yaml
+.kyverno/kyverno-test.yaml
+
+# Ignore editor backup files
+*~
+
+# Ignore ./log directory and *.log files
+logs
+*.log
+
+# Ignore backup files, e.g. created by the script that eases the local chart development
+*.bak

.gitlab/common/common.yml

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+variables:
+  OPENDESK_CI_CLI_IMAGE: "registry.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli:2.7.1\
+    @sha256:f09e36a4ad4b3a3a9ed260d6f36293002e39866a877c0a6b1efa16a88b8fd107"
+  OPENDESK_LINT_IMAGE: "registry.opencode.de/bmi/opendesk/components/platform-development/images/ci-lint:1.0.14\
+    @sha256:34d2a96e5fc25155abd48fef4d335b131c71d8cbc00ad531df0cae9918b9f2ab"
+
+.common:
+  cache: {}
+  needs: []
+  tags: []
+...

.gitlab/generate/generate-common.yml

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+include:
+  - local: "/.gitlab/common/common.yml"
+
+.generate-common:
+  extends: ".common"
+  stage: ".post"
+  tags: []
+...

.gitlab/generate/generate-docs.yml

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+include:
+  - local: "/.gitlab/generate/generate-common.yml"
+
+generate-docs:
+  cache:
+    - key: "generate-docs-${CI_COMMIT_REF_SLUG}"
+      paths:
+        - "${CI_PROJECT_DIR}/docs"
+      policy: "push"
+  extends: ".generate-common"
+  image: "${OPENDESK_CI_CLI_IMAGE}"
+  rules:
+    - if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $RELEASE_BRANCH"
+      when: "on_success"
+  script:
+    - "node /app/src/index.js generate-docs -d ${CI_PROJECT_DIR}"
+...

.gitlab/lint/lint-common.yml

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+include:
+  - local: "/.gitlab/common/common.yml"
+
+.lint-common:
+  extends: ".common"
+  stage: "lint"
+
+...

.gitlab/lint/lint-kyverno.yml

@@ -0,0 +1,60 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+include:
+  - local: "/.gitlab/lint/lint-common.yml"
+
+lint-kyverno:
+  allow_failure: true
+  extends: ".lint-common"
+  image: "${OPENDESK_LINT_IMAGE}"
+  parallel:
+    matrix:
+      - APP:
+          - "collabora"
+          - "cryptpad"
+          - "element"
+          - "jitsi"
+          - "nextcloud"
+          - "notes"
+          - "nubus"
+          - "open-xchange"
+          - "opendesk-migrations-post"
+          - "opendesk-migrations-pre"
+          - "opendesk-openproject-bootstrap"
+          - "opendesk-services"
+          - "openproject"
+          - "services-external"
+          - "xwiki"
+  script:
+    - "cd ${CI_PROJECT_DIR}/helmfile/apps/${APP}"
+    - >
+      node /app/opendesk-ci-cli/src/index.js generate-kyverno-env
+      -d ${CI_PROJECT_DIR}/helmfile/environments
+      -x ${CI_PROJECT_DIR}/.kyverno/_overwrite.yaml
+    - "helmfile template -e test --include-needs --skip-tests > ${CI_PROJECT_DIR}/.kyverno/opendesk.yaml"
+    - >
+      node /app/opendesk-ci-cli/src/index.js remove-empty-keys
+      -f ${CI_PROJECT_DIR}/.kyverno/opendesk.yaml
+    - "cd ${CI_PROJECT_DIR}/.kyverno"
+    # Test optional
+    - >
+      node /app/opendesk-ci-cli/src/index.js generate-kyverno-tests
+      -d ${CI_PROJECT_DIR}/.kyverno
+      -t optional
+      -s manifest
+      -f opendesk.yaml
+      --skip-tests true
+      ${APP}
+    - "kyverno test . || true"
+    # Test required
+    - >
+      node /app/opendesk-ci-cli/src/index.js generate-kyverno-tests
+      -d ${CI_PROJECT_DIR}/.kyverno
+      -t required
+      -s manifest
+      -f opendesk.yaml
+      --skip-tests true
+      ${APP}
+    - "kyverno test ."
+...

.gitlab/lint/lint-opendesk.yml

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+include:
+  - local: "/.gitlab/lint/lint-common.yml"
+
+lint-opendesk:
+  extends: ".lint-common"
+  image: "${OPENDESK_CI_CLI_IMAGE}"
+  rules:
+    - if: >
+        $RUN_RENOVATE == "yes"
+      when: "never"
+    - when: "always"
+  script:
+    - "node /app/src/index.js sort-all -d ${CI_PROJECT_DIR}/helmfile"
+    - "git diff --exit-code"
+...

.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,16 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Summary
+
+- *describe the reason for/content of the MR*
+
+# Commits
+
+%{all_commits}
+
+# Authors
+
+%{co_authored_by}

.kyverno/_overwrite.yaml

@@ -1,8 +1,6 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 # SPDX-License-Identifier: Apache-2.0
 ---
-
-store-dav:
-  bundled: false
-
+replicas:
+  umsLdapServerPrimary: 2
 ...

.kyverno/policies/_policies.yaml

@@ -0,0 +1,292 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+pod:
+  - name: "require-tag-and-digest"
+    rule: "require-tag-and-digest"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-default-serviceaccount"
+    rule: "disallow-default-serviceAccountName"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "template-imagepullsecrets"
+    rule: "template-imagePullSecrets"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-latest-tag"
+    rule: "disallow-latest-tag"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-latest-tag"
+    rule: "require-image-tag-or-digest"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-imagepullpolicy"
+    rule: "require-imagePullPolicy"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-health-and-liveness-check"
+    rule: "require-health-and-liveness-check"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Pod"
+      - "DaemonSet"
+  - name: "template-storage"
+    rule: "template-storageClassName-pod"
+    type: "required"
+    kinds:
+      - "PersistentVolumeClaim"
+  - name: "template-storage"
+    rule: "template-storageClassName-pvc"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+  - name: "template-storage"
+    rule: "template-requests-storage-pod"
+    type: "required"
+    kinds:
+      - "PersistentVolumeClaim"
+  - name: "template-storage"
+    rule: "template-requests-storage-pvc"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+  - name: "require-requests-limits"
+    rule: "validate-resources"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "template-image-registries"
+    rule: "template-image-registries"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-ro-rootfs"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-no-privilege-escalation"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-all-capabilities-dropped"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-no-privileged"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-run-as-user"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-run-as-group"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-seccomp-profile"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-run-as-non-root"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-empty-seLinuxOptions"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "require-default-procMount"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "require-containersecuritycontext"
+    rule: "restrict-sysctls"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-container-sock-mounts"
+    rule: "validate-docker-sock-mount"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-container-sock-mounts"
+    rule: "validate-containerd-sock-mount"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-container-sock-mounts"
+    rule: "validate-crio-sock-mount"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-container-sock-mounts"
+    rule: "validate-dockerd-sock-mount"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-host-namespaces"
+    rule: "disallow-host-namespaces"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-host-path"
+    rule: "disallow-host-path"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-host-ports"
+    rule: "disallow-host-ports"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "disallow-host-process"
+    rule: "disallow-host-process"
+    type: "required"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+      - "Job"
+      - "Pod"
+      - "DaemonSet"
+  - name: "template-ingress"
+    rule: "template-ingressClassName"
+    type: "required"
+    kinds:
+      - "Ingress"
+  - name: "template-ingress"
+    rule: "template-tls-secretName"
+    type: "required"
+    kinds:
+      - "Ingress"
+  - name: "template-replicas"
+    rule: "template-replicas"
+    type: "optional"
+    kinds:
+      - "StatefulSet"
+      - "Deployment"
+...

.kyverno/policies/disallow-container-sock-mounts.yaml

@@ -0,0 +1,80 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-container-sock-mounts"
+  annotations:
+    policies.kyverno.io/title: "Disallow CRI socket mounts"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Container daemon socket bind mounts allow access to the container engine on the node.
+      This access can be used for privilege escalation and to manage containers outside of Kubernetes, and hence should
+      not be allowed.
+      This policy validates that the sockets used for CRI engines Docker, Containerd, and CRI-O are not used.
+      In addition to or replacement of this policy, preventing users from mounting the parent directories
+      (/var/run and /var) may be necessary to completely prevent socket bind mounts.
+spec:
+  background: true
+  rules:
+    - name: "validate-docker-sock-mount"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: "Use of the Docker Unix socket is not allowed."
+        anyPattern:
+          - spec:
+              =(volumes):
+                - =(hostPath):
+                    path: "!/var/run/docker.sock"
+          - spec:
+              =(volumes):
+    - name: "validate-containerd-sock-mount"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: "Use of the Containerd Unix socket is not allowed."
+        anyPattern:
+          - spec:
+              =(volumes):
+                - =(hostPath):
+                    path: "!/var/run/containerd/containerd.sock"
+          - spec:
+              =(volumes):
+    - name: "validate-crio-sock-mount"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: "Use of the CRI-O Unix socket is not allowed."
+        anyPattern:
+          - spec:
+              =(volumes):
+                - =(hostPath):
+                    path: "!/var/run/crio/crio.sock"
+          - spec:
+              =(volumes):
+    - name: "validate-dockerd-sock-mount"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: "Use of the Docker CRI socket is not allowed."
+        anyPattern:
+          - spec:
+              =(volumes):
+                - =(hostPath):
+                    path: "!/var/run/cri-dockerd.sock"
+          - spec:
+              =(volumes):

.kyverno/policies/disallow-default-serviceaccount.yaml

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-default-serviceaccount"
+  annotations:
+    policies.kyverno.io/title: "Prevent default ServiceAccount privilege escalation"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Kubernetes automatically creates a ServiceAccount object named default for every namespace in your cluster.
+      These default service accounts get no permissions by default.
+      Accidental or intended assignment of permissions on the default service account results in elevated permissions
+      for all pods with default service account assigned.
+      This risk can be mitigated by creating a custom ServiceAccount for each application or reduce the risk by disable
+      auto mounting the default service account into the pod.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "disallow-default-serviceAccountName"
+      validate:
+        message: >-
+          Field serviceAccountName must be set to anything other than 'default'.
+          When serviceAccountName is 'default' then automountServiceAccountToken must set to 'false' .
+        anyPattern:
+          - spec:
+              serviceAccountName: "!default"
+          - spec:
+              automountServiceAccountToken: "false"
+  validationFailureAction: "audit"
+...

.kyverno/policies/disallow-host-namespaces.yaml

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-host-namespaces"
+  annotations:
+    policies.kyverno.io/title: "Disallow Host Namespaces"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Host namespaces (Process ID namespace, Inter-Process Communication namespace, and network namespace) allow access
+      to shared information and can be used to elevate privileges.
+      Pods should not be allowed access to host namespaces.
+      This policy ensures fields which make use of these host namespaces are unset or set to `false`.
+spec:
+  background: true
+  rules:
+    - name: "disallow-host-namespaces"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: >-
+          Sharing the host namespaces is disallowed. The fields spec.hostNetwork,
+          spec.hostIPC, and spec.hostPID must be unset or set to `false`.
+        pattern:
+          spec:
+            =(hostPID): "false"
+            =(hostIPC): "false"
+            =(hostNetwork): "false"

.kyverno/policies/disallow-host-path.yaml

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-host-path"
+  annotations:
+    policies.kyverno.io/title: "Disallow hostPath"
+    policies.kyverno.io/subject: "Pod,Volume"
+    policies.kyverno.io/description: >-
+      HostPath volumes let Pods use host directories and volumes in containers.
+      Using host resources can be used to access shared data or escalate privileges and should not be allowed.
+      This policy ensures no hostPath volumes are in use.
+spec:
+  background: true
+  rules:
+    - name: "disallow-host-path"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: >-
+          HostPath volumes are forbidden. The field spec.volumes[*].hostPath must be unset.
+        anyPattern:
+          - spec:
+              =(volumes):
+                - X(hostPath): "null"
+          - spec:
+              =(volumes):

.kyverno/policies/disallow-host-ports.yaml

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-host-ports"
+  annotations:
+    policies.kyverno.io/title: "Disallow hostPorts"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Access to host ports allows potential snooping of network traffic and should not be allowed, or at minimum
+      restricted to a known list. This policy ensures the `hostPort` field is unset or set to `0`.
+spec:
+  background: true
+  rules:
+    - name: "disallow-host-ports"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: >-
+          Use of host ports is disallowed. The fields spec.containers[*].ports[*].hostPort
+          , spec.initContainers[*].ports[*].hostPort, and spec.ephemeralContainers[*].ports[*].hostPort
+          must either be unset or set to `0`.
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - =(ports):
+                  - =(hostPort): 0
+            =(initContainers):
+              - =(ports):
+                  - =(hostPort): 0
+            containers:
+              - =(ports):
+                  - =(hostPort): 0

.kyverno/policies/disallow-host-process.yaml

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-host-process"
+  annotations:
+    policies.kyverno.io/title: "Disallow hostProcess"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Windows pods offer the ability to run HostProcess containers which enables privileged access to the Windows node.
+      Privileged access to the host is disallowed in the baseline policy.
+      HostProcess pods are an alpha feature as of Kubernetes v1.22.
+      This policy ensures the `hostProcess` field, if present, is set to `false`.
+spec:
+  background: true
+  rules:
+    - name: "disallow-host-process"
+      match:
+        any:
+          - resources:
+              kinds:
+                - "Pod"
+      validate:
+        message: >-
+          HostProcess containers are disallowed. The fields spec.securityContext.windowsOptions.hostProcess,
+          spec.containers[*].securityContext.windowsOptions.hostProcess,
+          spec.initContainers[*].securityContext.windowsOptions.hostProcess, and
+          spec.ephemeralContainers[*].securityContext.windowsOptions.hostProcess must either be undefined or set to
+          `false`.
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - =(securityContext):
+                  =(windowsOptions):
+                    =(hostProcess): "false"
+            =(initContainers):
+              - =(securityContext):
+                  =(windowsOptions):
+                    =(hostProcess): "false"
+            containers:
+              - =(securityContext):
+                  =(windowsOptions):
+                    =(hostProcess): "false"

.kyverno/policies/disallow-latest-tag.yaml

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "disallow-latest-tag"
+  annotations:
+    policies.kyverno.io/title: "Disallow usage of latest tag"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      The ':latest' tag is mutable and can lead to unexpected errors if the image changes.
+      A best practice is to use an immutable tag that maps to a specific version of an application Pod.
+      This policy validates that the image specifies a tag and that it is not called `latest`.
+      Defining no image tag or digest result in the container engine retrieving the latest tag.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "disallow-latest-tag"
+      validate:
+        message: "Using a mutable image tag e.g. 'latest' is not allowed."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - image: "!*:latest"
+            =(initContainers):
+              - image: "!*:latest"
+            containers:
+              - image: "!*:latest"
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "require-image-tag-or-digest"
+      validate:
+        message: "A image tag or a digest is required, otherwise latest tag is chosen."
+        anyPattern:
+          - spec:
+              =(ephemeralContainers):
+                - image: "*:*"
+              =(initContainers):
+                - image: "*:*"
+              containers:
+                - image: "*:*"
+          - spec:
+              =(ephemeralContainers):
+                - image: "*@*"
+              =(initContainers):
+                - image: "*@*"
+              containers:
+                - image: "*@*"
+  validationFailureAction: "audit"
+...

.kyverno/policies/require-containersecuritycontext.yaml

@@ -0,0 +1,244 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "require-containersecuritycontext"
+  annotations:
+    policies.kyverno.io/title: "ContainerSecurityContext best practices are set."
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      The containerSecurityContext is the most important security-related section because it has the highest precedence
+      and restricts the container to its minimal privileges.
+spec:
+  background: true
+  rules:
+    - name: "require-ro-rootfs"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Root filesystem must be read-only."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  readOnlyRootFilesystem: true
+            =(initContainers):
+              - securityContext:
+                  readOnlyRootFilesystem: true
+            containers:
+              - securityContext:
+                  readOnlyRootFilesystem: true
+
+    - name: "require-no-privilege-escalation"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Disallow privilege escalation."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  allowPrivilegeEscalation: false
+            =(initContainers):
+              - securityContext:
+                  allowPrivilegeEscalation: false
+            containers:
+              - securityContext:
+                  allowPrivilegeEscalation: false
+
+    - name: "require-all-capabilities-dropped"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Required to drop ALL linux capabilities."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  capabilities:
+                    drop:
+                      - "ALL"
+            =(initContainers):
+              - securityContext:
+                  capabilities:
+                    drop:
+                      - "ALL"
+            containers:
+              - securityContext:
+                  capabilities:
+                    drop:
+                      - "ALL"
+
+    - name: "require-no-privileged"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Disallow privileged container."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  privileged: false
+            =(initContainers):
+              - securityContext:
+                  privileged: false
+            containers:
+              - securityContext:
+                  privileged: false
+
+    - name: "require-run-as-user"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Container must run as non-root user."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  runAsUser: ">0"
+            =(initContainers):
+              - securityContext:
+                  runAsUser: ">0"
+            containers:
+              - securityContext:
+                  runAsUser: ">0"
+
+    - name: "require-run-as-group"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Container must run as non-root group."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  runAsGroup: ">0"
+            =(initContainers):
+              - securityContext:
+                  runAsGroup: ">0"
+            containers:
+              - securityContext:
+                  runAsGroup: ">0"
+
+    - name: "require-seccomp-profile"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Container must have seccompProfile"
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  seccompProfile:
+                    type: "RuntimeDefault | Localhost"
+            =(initContainers):
+              - securityContext:
+                  seccompProfile:
+                    type: "RuntimeDefault | Localhost"
+            containers:
+              - securityContext:
+                  seccompProfile:
+                    type: "RuntimeDefault | Localhost"
+
+    - name: "require-run-as-non-root"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "Container must run in non-root mode."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  runAsNonRoot: true
+            =(initContainers):
+              - securityContext:
+                  runAsNonRoot: true
+            containers:
+              - securityContext:
+                  runAsNonRoot: true
+
+    - name: "require-empty-seLinuxOptions"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: "SELinux options have to be unset."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - securityContext:
+                  seLinuxOptions:
+            =(initContainers):
+              - securityContext:
+                  seLinuxOptions:
+            containers:
+              - securityContext:
+                  seLinuxOptions:
+
+    - name: "require-default-procMount"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: >-
+          Changing the proc mount from the default is not allowed. The fields
+          spec.containers[*].securityContext.procMount, spec.initContainers[*].securityContext.procMount,
+          and spec.ephemeralContainers[*].securityContext.procMount must be unset or
+          set to `Default`.
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - =(securityContext):
+                  =(procMount): "Default"
+            =(initContainers):
+              - =(securityContext):
+                  =(procMount): "Default"
+            containers:
+              - =(securityContext):
+                  =(procMount): "Default"
+
+    - name: "restrict-sysctls"
+      match:
+        resources:
+          kinds:
+            - "Pod"
+      validate:
+        message: >-
+          Setting additional sysctls above the allowed type is not allowed.
+          The field spec.securityContext.sysctls must be unset or not use any other names
+          than kernel.shm_rmid_forced, net.ipv4.ip_local_port_range,
+          net.ipv4.ip_unprivileged_port_start, net.ipv4.tcp_syncookies and
+          net.ipv4.ping_group_range.
+        pattern:
+          spec:
+            =(securityContext):
+              =(sysctls):
+                - =(name): >-
+                    kernel.shm_rmid_forced |
+                    net.ipv4.ip_local_port_range |
+                    net.ipv4.ip_unprivileged_port_start |
+                    net.ipv4.tcp_syncookies |
+                    net.ipv4.ping_group_range
+
+  validationFailureAction: "audit"
+...

.kyverno/policies/require-health-and-liveness-check.yaml

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "require-health-and-liveness-check"
+  annotations:
+    policies.kyverno.io/title: "Disallow usage of latest tag"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      Liveness and readiness probes need to be configured to correctly manage a Pod's lifecycle during deployments,
+      restarts, and upgrades.
+      For each Pod, a periodic `livenessProbe` is performed by the kubelet to determine if the Pod's containers are
+      running or need to be restarted.
+      A `readinessProbe` is used by Services and Pods to determine if the Pod is ready to receive network traffic.
+      This policy validates that all containers have livenessProbe and readinessProbe defined.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "require-health-and-liveness-check"
+      validate:
+        message: >-
+          Liveness and readiness probes are required. spec.containers[*].livenessProbe.periodSeconds must be set to a
+          value greater than 0.
+        pattern:
+          spec:
+            containers:
+              - livenessProbe:
+                  periodSeconds: ">0"
+                readinessProbe:
+                  periodSeconds: ">0"
+  validationFailureAction: "audit"
+...

.kyverno/policies/require-imagepullpolicy.yaml

@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "require-imagepullpolicy"
+  annotations:
+    policies.kyverno.io/title: "Disallow usage of latest tag"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      If the `latest` tag is allowed for images, it is a good idea to have the imagePullPolicy field set to `Always` to
+      ensure later pulls get an updated image in case the latest tag gets updated.
+      This policy validates the imagePullPolicy is set to `Always` when the `latest` tag is specified explicitly or
+      where a tag is not defined at all.
+      Additionally this policy checks if the variable `.Values.global.imagePullPolicy` is used in templates.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "require-imagePullPolicy"
+      validate:
+        message: >-
+          The imagePullPolicy must be set to `Always` when the `latest` tag is used, otherwise the value from
+          `.Values.global.imagePullPolicy` has to be used.
+        anyPattern:
+          - spec:
+              =(ephemeralContainers):
+                - (image): "*:latest | !*:*"
+                  imagePullPolicy: "Always"
+              =(initContainers):
+                - (image): "*:latest | !*:*"
+                  imagePullPolicy: "Always"
+              containers:
+                - (image): "*:latest | !*:*"
+                  imagePullPolicy: "Always"
+          - spec:
+              =(ephemeralContainers):
+                - (image): "!*:latest"
+                  imagePullPolicy: "kyverno"
+              =(initContainers):
+                - (image): "!*:latest"
+                  imagePullPolicy: "kyverno"
+              containers:
+                - (image): "!*:latest"
+                  imagePullPolicy: "kyverno"
+  validationFailureAction: "audit"
+...

.kyverno/policies/require-requests-limits.yaml

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "require-requests-limits"
+  annotations:
+    policies.kyverno.io/title: "Require resources cpu/memory request and limits."
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      As application workloads share cluster resources, it is important to limit resources requested and consumed by
+      each Pod.
+      It is recommended to require resource requests and limits per Pod, especially for memory and CPU.
+      If a Namespace level request or limit is specified, defaults will automatically be applied to each Pod based on
+      the LimitRange configuration.
+      This policy validates that all containers have specified requests for memory and CPU and a limit for memory.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "validate-resources"
+      validate:
+        message: "CPU and memory resource requests and limits are required."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - resources:
+                  limits:
+                    memory: "?*"
+                  requests:
+                    cpu: "?*"
+                    memory: "?*"
+            =(initContainers):
+              - resources:
+                  limits:
+                    memory: "?*"
+                  requests:
+                    cpu: "?*"
+                    memory: "?*"
+            containers:
+              - resources:
+                  limits:
+                    memory: "?*"
+                  requests:
+                    cpu: "?*"
+                    memory: "?*"
+  validationFailureAction: "audit"
+...

.kyverno/policies/require-tag-and-digest.yaml

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "require-tag-and-digest"
+  annotations:
+    policies.kyverno.io/title: "Require tag and digest for image."
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      To ensure that containers are not compromised in container registry by pushing malicious code to the same tag, it
+      is required to reference images by setting a sha256 hashed digest.
+      Setting only the digest is complicated for humans to compare software versions, therefore in openDesk it is
+      required to reference container images by tag and digest.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "require-tag-and-digest"
+      validate:
+        message: "An image tag and digest required."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - image: "*:*@sha256:*"
+            =(initContainers):
+              - image: "*:*@sha256:*"
+            containers:
+              - image: "*:*@sha256:*"
+  validationFailureAction: "audit"
+...

.kyverno/policies/template-image-registries.yaml

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "template-image-registries"
+  annotations:
+    policies.kyverno.io/title: "Check image registry template"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      This policy verifies that a custom external registry can be template to allow downloads from a private registry or
+      cache.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "template-image-registries"
+      validate:
+        message: "Unknown image registry."
+        pattern:
+          spec:
+            =(ephemeralContainers):
+              - image: "my_private_registry.domain.tld/*"
+            =(initContainers):
+              - image: "my_private_registry.domain.tld/*"
+            containers:
+              - image: "my_private_registry.domain.tld/*"
+  validationFailureAction: "audit"
+...

.kyverno/policies/template-ingress.yaml

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "template-ingress"
+  annotations:
+    policies.kyverno.io/title: "Validate openDesk Ingress templating"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      This policy verifies that ingress variables are templated.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Ingress"
+      name: "template-ingressClassName"
+      validate:
+        message: "Verifies that ingressClassName can be customized by `.Values.ingress.ingressClassName` variable."
+        pattern:
+          spec:
+            ingressClassName: "kyverno"
+    - match:
+        resources:
+          kinds:
+            - "Ingress"
+      name: "template-tls-secretName"
+      validate:
+        message: "Verifies that tls.secretName can be customized by `.Values.ingress.tls.secretName` variable."
+        pattern:
+          spec:
+            tls:
+              - secretName: "kyverno-tls"
+  validationFailureAction: "audit"
+...

.kyverno/policies/template-replicas.yaml

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "template-replicas"
+  annotations:
+    policies.kyverno.io/title: "Validate openDesk Pod replicas templating"
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      This policy verifies that `.Values.replicas.<app>` variables are templated.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Deployment"
+            - "StatefulSet"
+      name: "template-replicas"
+      validate:
+        message: "Verifies that replica count can be customized by `.Values.replicas.<app>` variable."
+        pattern:
+          spec:
+            replicas: 42
+
+  validationFailureAction: "audit"
+...

.kyverno/policies/template-require-imagepullsecets.yaml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "template-imagepullsecrets"
+  annotations:
+    policies.kyverno.io/title: "ImagePullSecrets template variable have to be implemented."
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      It is recommended to cache images to ensure continuous image availability during network partitions, rate limiting
+      or registry outages.
+      These caches as well as a company proxy may require authentication which will be provided as ImagePullSecrets.
+      This is a openDesk test to ensure that environment variables are templated in Helmfile deployment.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "Pod"
+      name: "template-imagePullSecrets"
+      validate:
+        message: "ImagePullSecrets are required."
+        pattern:
+          spec:
+            imagePullSecrets:
+              - name: "kyverno-test"
+  validationFailureAction: "audit"
+...

.kyverno/policies/template-storage.yaml

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+apiVersion: "kyverno.io/v1"
+kind: "ClusterPolicy"
+metadata:
+  name: "template-storage"
+  annotations:
+    policies.kyverno.io/title: "Validate storageClass and size templates."
+    policies.kyverno.io/subject: "Pod"
+    policies.kyverno.io/description: >-
+      This policy validates if `.Values.persistence.storageClassNames` variables are used in templates and if the size
+      of volumes can be customized by `.Values.persistence.storages.<COMPONENT>.size` variable.
+spec:
+  background: true
+  rules:
+    - match:
+        resources:
+          kinds:
+            - "StatefulSet"
+      name: "template-storageClassName-pod"
+      validate:
+        message: "VolumeClaims inside pods needs to have storageClass set when templated."
+        pattern:
+          spec:
+            (volumeClaimTemplates):
+              - spec:
+                  storageClassName: "kyverno-test"
+    - match:
+        resources:
+          kinds:
+            - "PersistentVolumeClaim"
+      name: "template-storageClassName-pvc"
+      validate:
+        message: "PersistentVolumeClaim needs to have storageClassName set when templated."
+        pattern:
+          spec:
+            storageClassName: "kyverno-test"
+
+    - match:
+        resources:
+          kinds:
+            - "StatefulSet"
+      name: "template-requests-storage-pod"
+      validate:
+        message: "VolumeClaims inside pods needs to have storageClass set when templated."
+        pattern:
+          spec:
+            (volumeClaimTemplates):
+              - spec:
+                  resources:
+                    requests:
+                      storage: "42Gi"
+    - match:
+        resources:
+          kinds:
+            - "PersistentVolumeClaim"
+      name: "template-requests-storage-pvc"
+      validate:
+        message: "PersistentVolumeClaim needs to have storageClassName set when templated."
+        pattern:
+          spec:
+            resources:
+              requests:
+                storage: "42Gi"
+  validationFailureAction: "audit"
+...

.renovate/config.yaml

@@ -0,0 +1,92 @@
+# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+# SPDX-License-Identifier: Apache-2.0
+---
+# Platform type of repository
+platform: "gitlab"
+
+# Enable onboarding merge request
+onboarding: false
+
+# If set to true: keep repository data between runs instead of deleting the data
+persistRepoData: false
+
+# Controls Renovate's behavior regarding repository config files such as renovate.json
+requireConfig: "ignored"
+
+# List of Repositories
+# See: https://docs.renovatebot.com/configuration-options/
+repositories:
+  - repository: "bmi/opendesk/deployment/opendesk"
+    # Set the branch to read current dependency state from, this is especially useful during
+    # renovate setup when looking into your feature branch or when your default branch is
+    # not the one you want to check on.
+    baseBranches: [ "develop" ]
+    # Set a limit for the maximum number of parallel MRs (default 10)
+    prConcurrentLimit: 50
+    # Prefix to use for all branch names created by renovate bot (default: "renovate/")
+    branchPrefix: "renovate/"
+    # Lowercase merge request and commit titles ("never" = leave titles untouched )
+    commitMessageLowerCase: "never"
+    # Commit scope to use if Semantic Commits are enabled (fix(<scope>)...)
+    semanticCommitScope: "renovate"
+    # Commit type to use if Semantic Commits are enabled (default: "chore")
+    semanticCommitType: "chore"
+    # Enable dependency dashboard
+    dependencyDashboard: true
+    # Include package files only within these defined paths
+    includePaths:
+      - "helmfile/environments/default/images.yaml.gotmpl"
+      - "helmfile/environments/default/charts.yaml.gotmpl"
+    customManagers:
+      - customType: "regex"
+        fileMatch:
+          - "helmfile/environments/default/images.yaml.gotmpl"
+        datasourceTemplate: "docker"
+        matchStrings:
+          # yamllint disable rule:line-length rule:quoted-strings
+          - ' providerResponsible: "(?<depType>.+?)"[\s\S]+? upstreamRegistry: "(?<registryUrl>.+?)"[\s\S]+? upstreamRepository: "(?<depName>.+?)"[\s\S]+? tag: "(?<currentValue>[^@]+)@(?<currentDigest>sha256:[a-f0-9]+)"'
+          # yamllint enable rule:line-length rule:quoted-strings
+      - customType: "regex"
+        fileMatch:
+          - "helmfile/environments/default/charts.yaml.gotmpl"
+        datasourceTemplate: "docker"
+        matchStrings:
+          # yamllint disable rule:line-length rule:quoted-strings
+          - ' providerResponsible: "(?<depType>.+?)"[\s\S]+? upstreamRegistry: "(?<registryUrl>.+?)"[\s\S]+? upstreamRepository: "(?<depName>.+?)"[\s\S]+? version: "(?<currentValue>.+?)"'
+          # yamllint enable rule:line-length rule:quoted-strings
+    # Rules for matching packages
+    packageRules:
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "openDesk" ]
+        groupName: "Platform"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "Collabora" ]
+        groupName: "Collabora"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "Element" ]
+        groupName: "Element"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "Nordeck" ]
+        groupName: "Nordeck"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "Open-Xchange" ]
+        groupName: "Open-Xchange"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "OpenProject" ]
+        groupName: "OpenProject"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "OpenProject" ]
+        groupName: "OpenProject"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "Univention" ]
+        groupName: "Univention"
+      - matchDatasources: [ "docker" ]
+        matchDepTypes: [ "XWiki" ]
+        groupName: "XWiki"
+    # Add merge request labels
+    labels:
+      - "renovate"
+    # Enable custom regex manager only
+    enabledManagers:
+      - "custom.regex"
+...

.reuse/dep5

@@ -1,8 +0,0 @@
-Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: openDesk
-Upstream-Contact: <git+bmi-souveraener-arbeitsplatz-cla-1339-29pr0g9pj4or9yi6wfly6pbhg-issue@opencode.de>
-Source: https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace
-
-Files: helmfile/environments/default/theme/*
-Copyright: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-License: Apache-2.0

COMPONENTS-FUNCTIONAL.md

@@ -1,28 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-
-SPDX-License-Identifier: Apache-2.0
--->
-**Content / Quick navigation**
-
-[[_TOC_]]
-
-# Functional Components
-
-Functional components are the core of the SWP as they provide it's rich functionaly. We use the community versions of the named products. For production environments please use enterprise versions for support and scalabiliy reasons.
-
-## Groupware - Open-Xchange AppSuite
-
-## WebOffice - Collabora Development Edition
-
-## File & Share - Nextcloud
-
-## Kollaboration - Element
-
-## Videokonferenzen - Jitsi
-
-## Knowledge Management - XWiki
-
-## Project Management - OpenProject
-
-## Portal & IAM - Univention Corporate Services

COMPONENTS-SERVICE.md

@@ -1,62 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-
-SPDX-License-Identifier: Apache-2.0
--->
-**Content / Quick navigation**
-
-[[_TOC_]]
-
-# Service Components
-
-Service components are required to operate the SWP. The deployment automation contains a full set of service components in order for the deployment to be self contained. But please be aware that the components are not ment to be used in production scenarios. Check out the service components details to understand how to make use of external services in case you want to setup production environments.
-
-## Database - MariaDB
-
-This services is used by:
-- Nextcloud
-- Open-Xchange
-- XWiki
-
-## Database - PostgreSQL
-
-This services is used by:
-- Keycloak
-- OpenProject
-
-## Redis
-
-This service is used by:
-- Intercom-Service
-- Nextcloud
-
-## Postfix
-
-This service is used by:
-- Keycloak (e.g. new device login notification)
-- Nextcloud (e.g. share file notifictions)
-- Open-Xchange (emails)
-- OpenProject (general notifications)
-- UCS (e.g. password reset emails)
-- XWiki (e.g. change notifications)
-
-## TURN Server
-
-This services is used by:
-- Jitsi
-
-## NFS
-
-[remove this as it should be addressed by the RWX prerequsite!?]
-
-This service is used by
-- Dovecot
-- Nextcloud
-
-## ICAP
-
-This service is used by
-- Nextcloud
-- Open-Xchange
-
-## Objectstore - MinIO

CONTRIBUTING.md

@@ -5,72 +5,12 @@ SPDX-License-Identifier: Apache-2.0
 
 # Read me first
 
-Please read the [project's overall CONTRIBUTING.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/CONTRIBUTING.md) first.
+Please read the [project's overall CONTRIBUTING.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md) first.
 
 # How to contribute?
 
-When providing contributes to this project, please adhere to the standards and conventions described further down in this document. Doing so please feel free to create merge requests.
-
-# Standards and conventions
-
-## Branching
-
-We use [Github flow](https://docs.github.com/en/get-started/quickstart/github-flow).
-
-## Verified commits
-
-We only allow verified commits:
-- https://docs.gitlab.com/ee/user/project/repository/ssh_signed_commits/
-- https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/
-- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/
-
-## Approval
-
-MRs require one approval from the SouvAP devops team with security clearance.
-
-## Conventional Commits
-
-See https://www.conventionalcommits.org/en/v1.0.0/#summary for reference.
-
-Commits that do not adhere to the standard might be rejected.
-
-```text
-<type>(<scope>): [path/to/issue#1] <short summary>
-  │       │              │                │
-  │       │              |                └─> Summary in present tense, sentence case, with no period at the end
-  │       │              |
-  │       │              └─> Issue reference (optional)
-  │       │
-  │       └─> Commit Scope: helmfile, docs, collabora, intercom-service, ...
-  │
-  └─> Commit Type: chore, ci, docs, feat, fix
-```
-Valid commit scopes:
-- `helmfile`
-- `ci`
-- `docs`
-- `collabora`
-- `ìntercom-service`
-- `jitsi`
-- `keycloak`
-- `keycloak-bootstrap`
-- `nextcloud`
-- `open-xchange`
-- `openproject`
-- `provisioning`
-- `services`
-- `univention-corporate-container`
-- `xwiki`
-
-## Semantic Release
-
-See https://github.com/semantic-release/semantic-release for reference.
-
-## Linting
-
-Following linters must pass:
-- [yaml-lint](https://github.com/adrienverge/yamllint)
-- [helm-lint](https://helm.sh/docs/helm/helm_lint/)
+Please also read the [project's workflow documentation](./docs/workflow.md) for more details on standards like commit
+messages and branching.
 
 ## Helm vs. Operators vs. Manifests
 
@@ -80,10 +20,18 @@ Due to DVS requirements:
 - we should avoid stand alone Manifests.
 - we do not use Operators and CRDs.
 
-In order to align the Helm files from various sources into an unified deployment of the SWP we make use of [Helmfile](https://github.com/helmfile/helmfile).
+In order to align the Helm files from various sources into the unified deployment of openDesk we make use of
+[Helmfile](https://github.com/helmfile/helmfile).
 
 ## Tooling
 
-We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should be used.
+We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should
+be used.
 
 We should avoid adding unnecessary complexity.
+
+## In doubt? Ask!
+
+We are always happy about contributions, but also like to discuss technical approaches to solve a problem to ensure
+a contribution fits the openDesk platform strategy or clarify that specific topics might be must ahead on our own
+roadmap. So when in doubt please [open an issue](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues/new) and start a discussion.

LICENSES/CC0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -1,508 +1,126 @@
 <!--
-SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
 SPDX-License-Identifier: Apache-2.0
 -->
-**Content / Quick navigation**
 
-[[_TOC_]]
+<h1>openDesk Deployment Automation</h1>
 
-# Disclaimer August 2023
+<!-- TOC -->
+* [Overview](#overview)
+* [Upgrades](#upgrades)
+* [Requirements](#requirements)
+* [Getting started](#getting-started)
+* [Advanced customization](#advanced-customization)
+* [Architecture](#architecture)
+* [Permissions](#permissions)
+* [Releases](#releases)
+* [Data Storage](#data-storage)
+* [Feedback](#feedback)
+* [Development](#development)
+* [License](#license)
+* [Copyright](#copyright)
+<!-- TOC -->
 
-The current state of the Sovereign Workplace contains components that are going to be
-replaced. Like for example the UCS dev container monolith will be substituted by
-multiple Univention Management Stack containers.
+# Overview
 
-In the next months we not only expect upstream updates of the functional
-components within their feature scope, but we are also going to address
-operational issues like monitoring and network policies.
+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*.
 
-Of course, further development also includes enhancing the documentation.
+openDesk currently features the following functional main components:
 
-The first release of the Sovereign Workplace is scheduled for December 2023.
-Before that release there will be breaking changes in the deployment.
+| Function             | Functional Component        | 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)                                                                          |
+| Diagram editor       | CryptPad ft. diagrams.net   | [5.6.0](https://github.com/cryptpad/cryptpad/releases/tag/5.6.0)                                     | [For the most recent release](https://docs.cryptpad.org/en/)                                                                          |
+| File management      | Nextcloud                   | [29.0.8](https://nextcloud.com/de/changelog/#29-0-8)                                                 | [Nextcloud 29](https://docs.nextcloud.com/)                                                                                           |
+| Groupware            | OX App Suite                | [8.30](https://documentation.open-xchange.com/appsuite/releases/8.30/)                               | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) |
+| Knowledge management | XWiki                       | [16.4.4](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.4.4/)                       | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation)                                                     |
+| Portal & IAM         | Nubus                       | [1.5.1](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html)                                             |
+| Project management   | OpenProject                 | [15.2.0](https://www.openproject.org/docs/release-notes/15-2-0/)                                     | [For the most recent release](https://www.openproject.org/docs/user-guide/)                                                           |
+| Videoconferencing    | Jitsi                       | [2.0.9823](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9823)                | [For the most recent  release](https://jitsi.github.io/handbook/docs/category/user-guide/)                                            |
+| Weboffice            | Collabora                   | [24.04.9.2](https://www.collaboraoffice.com/code-24-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
+align the applications with best practices regarding container design and operations.
 
-# The Sovereign Workplace (SWP)
+This documentation aims to give you all that is needed to set up your own instance of the openDesk.
 
-The Sovereign Workplace's runtime environment is [Kubernetes](https://kubernetes.io/), or "K8s" in
-short.
+Basic knowledge of Kubernetes and DevOps processes is required though.
 
-While not all components are still perfectly shaped for the execution inside
-containers, one of the projects objectives is it to align the applications
-with the best practises regarding container design and operations.
+# Upgrades
 
-This documentation aims to give you all that is needed to set up your own
-instance of the Sovereign Workplace. Basic knowledge of Kubernetes and Devops is
-required though.
+You want to upgrade an existing openDesk installation?
 
-To have an overview of what can be found at Open CoDE and the basic components
-of the Sovereign Workplace, please check out the
-[OVERVIEW.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md) in the [Info repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info).
+⟶ Visit our detailed documentation about [Updates & Upgrades](./docs/migrations.md).
 
-We love to get feedback from you! Related to the deployment / contents of this
-repository please use the [issues within this project](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace/-/issues).
+# Requirements
 
-If you want to address other topics, please check the section
-["Rückmeldungen und Beteiligung" of the Infos' project OVERVIEW.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung).
+You want to understand what is required to install openDesk yourself?
+
+⟶ Visit our [Requirements](./docs/requirements.md) overview.
+
+# Getting started
+
+You would like to install openDesk in your own infrastructure?
+
+⟶ Visit our detailed [Getting started guide](./docs/getting-started.md).
+
+# Advanced customization
+
+- [Enhanced Configuration](./docs/enhanced-configuration.md)
+- [External services](./docs/external-services.md)
+- [Security](./docs/security.md)
+- [Scaling](./docs/scaling.md)
+- [Monitoring](./docs/monitoring.md)
+- [Theming](./docs/theming.md)
+
+# Architecture
+
+More information on openDesk's architecture can be found in our [Architecture docs](./docs/architecture.md).
+
+# Permissions
+
+Find out more about the permission system in the[roles & permissions concept](./docs/permissions.md)
 
 # Releases
 
 All technical releases are created using [Semantic Versioning](https://semver.org/lang/de/).
 
-Gitlab provides an [overview on the releases](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace/-/releases) of this project.
+Gitlab provides an
+[overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases)
+of this project.
 
-The following release artefacts are provided beside the default source code assets:
-- `chart-index.json`: An overview of all Helm charts used by the release.
-- `image-index.json`: An overview of all container images used by the release.
-# Deployment
+Please find a list of the artifacts related to the release either in the source code archive attached to the release or
+in the files from the release's git-tag:
+- `./helmfile/environments/default/images.yaml.gotmpl`
+- `./helmfile/environments/default/charts.yaml.gotmpl`
 
-**Note for project members:** You can use the project's `dev` K8s cluster to set
-up your own instance for development purposes. Please see the project
-`sovereign-workplace-env` on the internal Gitlab for more details.
+Find more information in our [Workflow documentation](./docs/workflow.md).
 
-## Prerequisites
+# Data Storage
 
-### Mandatory technical prerequisites
+More information about different data storages used within openDesk are described in the
+[Data Storage documentation](./docs/data-storage.md).
 
-These are the requirements of the Sovereign Workplace deployment:
+# Feedback
 
-- Vanilla K8s cluster
-- Domain and DNS Service
-- Ingress controller (supported are nginx-ingress, ingress-nginx, HAProxy)
-- [Helm](https://helm.sh/), [HelmFile](https://helmfile.readthedocs.io/en/latest/) and
-[HelmDiff](https://github.com/databus23/helm-diff)
-- Volume provisioner supporting RWO (read-write-once)
-- Certificate handling with [cert-manager](https://cert-manager.io/)
-- [Istio](https://istio.io/) is currently required to deploy and operate OX AppSuite8, we are talking to Open-Xchange and will try to get rid of this dependency.
+We love to get feedback from you!
 
-#### TLS Certificate
+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).
 
-The setup will create a `cert-manager.io` Certificate resource.
+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).
 
-You can set the ClusterIssuer via `certificate.issuerRef.name`
+# Development
 
-### Required input variables
+If you want to join or contribute to the development of openDesk please read the [Development guide](./docs/development.md).
 
-You need to expose following environment variables in order to run the
-installation.
+# License
 
-| name                | default               | description                                       |
-|---------------------|-----------------------|---------------------------------------------------|
-| `DOMAIN`            | `souvap.cloud`        | External reachable domain                         |
-| `ISTIO_DOMAIN`      | `istio.souvap.cloud`  | External reachable domain for Istio Gateway       |
-| `MASTER_PASSWORD`   | `sovereign-workplace` | The password that seeds the autogenerated secrets |
+This project uses the following license: Apache-2.0
 
-Please ensure that you set the DNS records pointing to the loadbalancer/IP for
-`DOMAIN` and `ISTIO_DOMAIN`.
+# Copyright
 
-If you want inbound email you need to set the MX records that points to the
-public IP address of the Postfix-pods.
-
-More details on DNS options including SPF/DKIM and autodiscovery options
-are to come...
-
-### Optional or feature based prerequisites
-
-All of these requirements are optional as long as you do not want to use the
-related feature.
-
-| Feature                      | Component(s)   | Requirement                 |
-|------------------------------|----------------|-----------------------------|
-| Component Scalability        | Various[^1]    | Read-Write-Many Provisioner |
-| Sending outbound emails      | Various        | SMTP relay/gateway          |
-| S/MIME Support               | OX AppSuite8   | PKI / CI                    |
-| Improved videoconferencing   | Jitsi          | STUN/TURN server            |
-
-## CI based deployment
-
-The project includes a `.gitlab-ci.yml` that allows you to execute the
-deployment from a Gitlab instance of your choice.
-
-Please ensure to provide the environment variables listed at
-[Required input variables](#required-input-variables).
-
-When starting the pipeline through the Gitlab UI you will be queried for some
-of the variables plus the following ones:
-
-- `BASE_DOMAIN`: The base domain the SWP will use. For example: `souvap.cloud`
-- `NAMESPACE`: Defines into which namespace of your K8s cluster the SWP will be installed
-- `MASTER_PASSWORD_WEB_VAR`: Overwrites value of `MASTER_PASSWORD`
-
-Based on your input the following variables will be set:
-- `DOMAIN` = `NAMESPACE`.`BASE_DOMAIN`
-- `ISTIO_DOMAIN` = istio.`DOMAIN`
-- `MASTER_PASSWORD` = `MASTER_PASSWORD_WEB_VAR`. If `MASTER_PASSWORD_WEB_VAR`
-is not set, the default for `MASTER_PASSWORD` will be used, unless you set
-`MASTER_PASSWORD` as a masked CI/CD variable in Gitlab to supercede the default.
-
-You might want to set credential variables in the Gitlab project at
-`Settings` > `CI/CD` > `Variables`.
-
-## Local deployment
-
-Please ensure to provide the environment variables listed at
-[Required input variables](#required-input-variables).
-Also, please read [Helmfile](#helmfile) a little below in case of a non default
-configuration.
-
-Then go with
-
-```shell
-helmfile apply -n <NAMESPACE>
-```
-
-and wait a little. After the deployment is finished some bootstrapping is
-executed which might take some more minutes before you can log in your new
-instance.
-
-## Offline deployment
-
-Before executing a [local deployment](#local-deployment), you can set following
-environment variables to use your own container image and helm chart registry:
-
-| name                         | description                    |
-|------------------------------|--------------------------------|
-| PRIVATE_CHART_REPOSITORY_URL | Your helm chart repository url |
-| PRIVATE_IMAGE_REGISTRY_URL   | Your image registry url        |
-
-## Logging in
-
-When successfully deployed the SWP, all K8s jobs from the deployment should be
-in the status `Succeeded` and all pods should be `Running`.
-
-You should see the portal's login page at `https://portal.<DOMAIN>`.
-
-Off the shelf you get two accounts with passwords you can look up in the
-`univention-corporate-container-*` pod environment. You can use a shell on that
-container or a `kubectl describe`-command to get the credentials.
-
-| Username / Login   | Password environment variable  |
-|--------------------|--------------------------------|
-| default.user       | DEFAULT_ACCOUNT_USER_PASSWORD  |
-| default.admin      | DEFAULT_ACCOUNT_ADMIN_PASSWORD |
-
-If you do not see any tiles in the portal after the login you may want to wait a
-couple of minutes, as on the initial start some bootstrapping and cache building
-is done. This blocks the portal entries from showing up.
-
-# Helmfile
-
-## Custom Configuration
-
-### Deployment selection
-
-By default, all components are deployed. The components of type `Eval` are used
-for development and evaluation purposes only - they need to be replaced in
-production deployments. These components are grouped together in the
-subdirectory `/helmfile/apps/services`.
-
-| Component                   | Name                                | Default | Description                    | Type       |
-|-----------------------------|-------------------------------------|---------|--------------------------------|------------|
-| Certificates                | `certificates.enabled`              | `true`  | TLS certificates               | Eval       |
-| ClamAV (Distributed)        | `clamavDistributed.enabled`         | `false` | Antivirus engine               | Eval       |
-| ClamAV (Simple)             | `clamavSimple.enabled`              | `true`  | Antivirus engine               | Eval       |
-| Collabora                   | `collabora.enabled`                 | `true`  | Weboffice                      | Functional |
-| Dovecot                     | `dovecot.enabled`                   | `true`  | Mail backend                   | Functional |
-| Element                     | `element.enabled`                   | `true`  | Secure communications platform | Functional |
-| Intercom Service            | `intercom.enabled`                  | `true`  | Cross service data exchange    | Functional |
-| Jitsi                       | `jitsi.enabled`                     | `true`  | Videoconferencing              | Functional |
-| Keycloak                    | `keycloak.enabled`                  | `true`  | Identity Provider              | Functional |
-| MariaDB                     | `mariadb.enabled`                   | `true`  | Database                       | Eval       |
-| Nextcloud                   | `nextcloud.enabled`                 | `true`  | File share                     | Functional |
-| OpenProject                 | `openproject.enabled`               | `true`  | Project management             | Functional |
-| OX Appsuite                 | `oxAppsuite.enabled`                | `true`  | Groupware                      | Functional |
-| Provisioning                | `oxConnector.enabled`               | `true`  | Backend provisioning           | Functional |
-| Postfix                     | `postfix.enabled`                   | `true`  | MTA                            | Eval       |
-| PostgreSQL                  | `postgresql.enabled`                | `true`  | Database                       | Eval       |
-| Redis                       | `redis.enabled`                     | `true`  | Cache Database                 | Eval       |
-| Univention Corporate Server | `univentionCorporateServer.enabled` | `true`  | Identity Management & Portal   | Functional |
-| Univention Management Stack | `univentionManagementStack.enabled` | `false` | Identity Management & Portal   | Eval       |
-| XWiki                       | `xwiki.enabled`                     | `true`  | Knowledgebase                  | Functional |
-
-
-#### Cluster capabilities
-| Capability                          | Default         | Options                                 | Notes                                                                                                                                                             |
-|-------------------------------------|-----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `cluster.service.type`              | `LoadBalancer`  | `ClusterIP`, `NodePort`, `LoadBalancer` | External access to TCP/UDP services. [Additional Information](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) |
-| `cluster.persistence.readWriteMany` | `false`         | `true`, `false`                         | Enable if ReadWriteMany (RWX) storage is available (f.e. CephFS, NFS, ...).                                                                                       |
-| `cluster.networking.domain`         | `cluster.local` |                                         | Kubernetes cluster domain.                                                                                                                                        |
-| `cluster.networking.cidr`           | `10.0.0.0/8`    |                                         | Kubernetes internal network                                                                                                                                       |
-
-
-#### Databases
-
-In case you don't got for a develop or evaluation environment you want to point
-the application to your own database instances.
-
-| Component   | Name               | Type       | Parameter | Key                                    | Default                    |
-|-------------|--------------------|------------|-----------|----------------------------------------|----------------------------|
-| Element     | Synapse            | PostgreSQL |           |                                        |                            |
-|             |                    |            | Name      | `databases.synapse.name`               | `matrix`                   |
-|             |                    |            | Host      | `databases.synapse.host`               | `postgresql`               |
-|             |                    |            | Port      | `databases.synapse.port`               | `5432`                     |
-|             |                    |            | Username  | `databases.synapse.username`           | `matrix_user`              |
-|             |                    |            | Password  | `databases.synapse.password`           |                            |
-| Keycloak    | Keycloak           | PostgreSQL |           |                                        |                            |
-|             |                    |            | Name      | `databases.keycloak.name`              | `keycloak`                 |
-|             |                    |            | Host      | `databases.keycloak.host`              | `postgresql`               |
-|             |                    |            | Port      | `databases.keycloak.port`              | `5432`                     |
-|             |                    |            | Username  | `databases.keycloak.username`          | `keycloak_user`            |
-|             |                    |            | Password  | `databases.keycloak.password`          |                            |
-|             | Keycloak Extension | PostgreSQL |           |                                        |                            |
-|             |                    |            | Name      | `databases.keycloakExtension.name`     | `keycloak_extensions`      |
-|             |                    |            | Host      | `databases.keycloakExtension.host`     | `postgresql`               |
-|             |                    |            | Port      | `databases.keycloakExtension.port`     | `5432`                     |
-|             |                    |            | Username  | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
-|             |                    |            | Password  | `databases.keycloakExtension.password` |                            |
-| Nextcloud   | Nextcloud          | MariaDB    |           |                                        |                            |
-|             |                    |            | Name      | `databases.nextcloud.name`             | `nextcloud`                |
-|             |                    |            | Host      | `databases.nextcloud.host`             | `mariadb`                  |
-|             |                    |            | Username  | `databases.nextcloud.username`         | `nextcloud_user`           |
-|             |                    |            | Password  | `databases.nextcloud.password`         |                            |
-| OpenProject | Keycloak           | PostgreSQL |           |                                        |                            |
-|             |                    |            | Name      | `databases.openproject.name`           | `openproject`              |
-|             |                    |            | Host      | `databases.openproject.host`           | `postgresql`               |
-|             |                    |            | Port      | `databases.openproject.port`           | `5432`                     |
-|             |                    |            | Username  | `databases.openproject.username`       | `openproject_user`         |
-|             |                    |            | Password  | `databases.openproject.password`       |                            |
-| OX Appsuite | OX Appsuite        | MariaDB    |           |                                        |                            |
-|             |                    |            | Name      | `databases.oxAppsuite.name`            | `CONFIGDB`                 |
-|             |                    |            | Host      | `databases.oxAppsuite.host`            | `mariadb`                  |
-|             |                    |            | Username  | `databases.oxAppsuite.username`        | `root`                     |
-|             |                    |            | Password  | `databases.oxAppsuite.password`        |                            |
-| XWiki       | XWiki              | MariaDB    |           |                                        |                            |
-|             |                    |            | Name      | `databases.xwiki.name`                 | `xwiki`                    |
-|             |                    |            | Host      | `databases.xwiki.host`                 | `mariadb`                  |
-|             |                    |            | Username  | `databases.xwiki.username`             | `xwiki_user`               |
-|             |                    |            | Password  | `databases.xwiki.password`             |                            |
-
-### Scaling
-
-The Replicas of components can be increased, while we still have to look in the
-actual scalability of the components (see column `Scaling (verified)`).
-
-| Component   | Name                   | Scaling (effective) | Scaling (verified) |
-|-------------|------------------------|:-------------------:|:------------------:|
-| ClamAV      | `replicas.clamav`      | :white_check_mark:  | :white_check_mark: |
-|             | `replicas.clamd`       | :white_check_mark:  | :white_check_mark: |
-|             | `replicas.freshclam`   |         :x:         |        :x:         |
-|             | `replicas.icap`        | :white_check_mark:  | :white_check_mark: |
-|             | `replicas.milter`      | :white_check_mark:  | :white_check_mark: |
-| Collabora   | `replicas.collabora`   | :white_check_mark:  |       :gear:       |
-| Dovecot     | `replicas.dovecot`     |         :x:         |       :gear:       |
-| Element     | `replicas.element`     | :white_check_mark:  | :white_check_mark: |
-|             | `replicas.synapse`     |         :x:         |       :gear:       |
-|             | `replicas.synapseWeb`  | :white_check_mark:  | :white_check_mark: |
-|             | `replicas.wellKnown`   | :white_check_mark:  | :white_check_mark: |
-| Jitsi       | `replicas.jibri`       | :white_check_mark:  |       :gear:       |
-|             | `replicas.jicofo`      | :white_check_mark:  |       :gear:       |
-|             | `replicas.jitsi `      | :white_check_mark:  |       :gear:       |
-|             | `replicas.jvb `        |         :x:         |        :x:         |
-| Keycloak    | `replicas.keycloak`    | :white_check_mark:  |       :gear:       |
-| Nextcloud   | `replicas.nextcloud`   | :white_check_mark:  |       :gear:       |
-| OpenProject | `replicas.openproject` | :white_check_mark:  |       :gear:       |
-| Postfix     | `replicas.postfix`     |         :x:         |       :gear:       |
-| XWiki       | `replicas.xwiki`       | :white_check_mark:  |       :gear:       |
-
-
-### Mail/SMTP configuration
-
-To use the full potential of the openDesk, you need to set up a STMP Smarthost/Relay which allows to send emails from 
-the whole subdomain.
-
-```yaml
-smtp:
-  host:     # your SMTP host or IP-address
-  username: # username/email for authentication
-  password: # password for authentication, or via environment variable SMTP_PASSWORD
-```
-
-### TURN configuration
-
-Some components (Jitsi, Element) use for direct communication a TURN server.
-You can configure your own TURN server with these options:
-
-```yaml
-turn:
-  transport:   # "udp" or "tcp"
-  credentials: # turn credential string
-  server:      # configuration for unsecure connections
-    host:      # your TURN host or IP-address
-    port:      # server port
-  tls:         # configuration for secure connections
-    host:      # your TURN host or IP-address
-    port:      # server port
-```
-
-## Security
-
-This list gives you an overview of default security settings and if they comply with security standards:
-
-
-| Component  | Process                  |         =          | allowPrivilegeEscalation (`false`) |                                                           capabilities (`drop: ALL`)                                                           | seccompProfile (`RuntimeDefault`) | readOnlyRootFilesystem (`true`) | runAsNonRoot (`true`) | runAsUser | runAsGroup | fsGroup |
-|------------|--------------------------|:------------------:|:----------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------:|:-------------------------------:|:---------------------:|:---------:|:----------:|:-------:|
-| ClamAV     | clamd                    | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    100    |    101     |   101   |
-|            | freshclam                | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    100    |    101     |   101   |
-|            | icap                     | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    100    |    101     |   101   |
-|            | milter                   | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    100    |    101     |   101   |
-| Collabora  | collabora                |        :x:         |                :x:                 | :x: (`CHOWN`, `DAC_OVERRIDE`, `FOWNER`, `FSETID`, `KILL`, `SETGID`, `SETUID`, `SETPCAP`, `NET_BIND_SERVICE`, `NET_RAW`, `SYS_CHROOT`, `MKNOD`) |        :white_check_mark:         |               :x:               |  :white_check_mark:   |    100    |    101     |   100   |
-| Element    | element                  | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    101    |    101     |   101   | 
-|            | synapse                  | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   10991   |     -      |  10991  | 
-|            | synapseWeb               | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    101    |    101     |   101   | 
-|            | wellKnown                | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |    101    |    101     |   101   | 
-| Jitsi      | jibri                    |        :x:         |                :x:                 |                                                               :x: (`SYS_ADMIN`)                                                                |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |    -    |
-|            | jicofo                   |        :x:         |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |    -    |
-|            | jitsiKeycloakAdapter     | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1993    |    1993    |    -    |
-|            | jvb                      |        :x:         |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |    -    |
-|            | prosody                  |        :x:         |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |    -    |
-|            | web                      |        :x:         |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |    -    |
-| Keycloak   | keycloak                 |        :x:         |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |               :x:               |  :white_check_mark:   |   1001    |    1001    |  1001   |
-|            | keycloakConfigCli        | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1001    |    1001    |  1001   |
-|            | keycloakExtensionHandler | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1000    |    1000    |    -    |
-|            | keycloakExtensionProxy   | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1000    |    1000    |    -    |
-| MariaDB    | mariadb                  | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1001    |    1001    |  1001   |
-| Postfix    | postfix                  |        :x:         |                :x:                 |                                                                      :x:                                                                       |        :white_check_mark:         |               :x:               |          :x:          |     -     |     -      |   101   |
-| PostgreSQL | postgresql               | :white_check_mark: |         :white_check_mark:         |                                                               :white_check_mark:                                                               |        :white_check_mark:         |       :white_check_mark:        |  :white_check_mark:   |   1001    |    1001    |  1001   |
-
-
-# Component integration
-
-## Functional use cases
-
-### Overview
-
-Some use cases require inter component integration.
-
-```mermaid
-flowchart TD
-  OXAppSuiteFrontend-->|SilentLogin, Filepicker, CentralNavigation|IntercomService
-  IntercomService-->|SilentLogin, TokenExchange|Keycloak
-  IntercomService-->|Filepicker|Nextcloud
-  IntercomService-->|CentralNavigation|Portal
-  OXAppSuiteBackend-->|Filepicker|Nextcloud
-  Nextcloud-->|CentralNavigation|Portal
-  OpenProject-->|CentralNavigation|Portal
-  XWiki-->|CentralNavigation|Portal
-  Nextcloud-->|CentralContacts|OXAppSuiteBackend
-  OXAppSuiteFrontend-->|Filepicker|OXAppSuiteBackend
-```
-
-#### Intercom Service (ICS)
-
-The UCS Intercom Service's role is to enable cross application integration based
-on browser interaction. Handling authentication when the frontend of an
-application is using the API from another application is often a challenge.
-For more details on the ICS please refer to its own [README.md](./helmfile/apps/intercom-service/README.md).
-
-In order to establish a session with the Intercom Service, the application that
-wants to use the ICS must initiate a silent login.
-
-Currently only OX AppSuite is using the frontend based integration, and
-therefore it is right now the only consumer of the ICS API.
-
-### Filepicker
-
-The Nextcloud filepicker which is integrated into the OX AppSuite allows you to
-add attachments or links to files from and saving attachments to Nextcloud.
-
-The filepicker is using frontend and backend based integration. Frontend based
-integration means that OX AppSuite in the browser is communicating with ICS.
-While using backend based integration, OX AppSuite middleware is communicating
-with Nextcloud, which is especially used when adding a file to an email or
-storing a file into Nextcloud.
-
-### Central Navigation
-
-Central navigation is based on an API endpoint in the portal that provides the
-contents of the portal for a user in order to allow components to render the
-menu showing all available SWP applications for the user.
-
-### (Read & write) Central contacts
-
-Open-Xchange App Suite is used to manage contacts within the Sovereign
-Workplace. There is an API in the AppSuite that is being used by
-Nextcloud to lookup contacts as well as to create contacts. This is maybe done
-when a file is shared with a not yet available personal contact.
-
-# Identity data flows
-
-An overview of
-- components that consume the LDAP service. Mostly by using a dedicated LDAP search account.
-- components using Keycloak as identity provider. If not otherwise denoted based on the OAuth2 / OIDC flows.
-
-Some components trust others to handle authentication for them.
-
-```mermaid
-flowchart TD
-    K[Keycloak]-->L[LDAP]
-    N[Nextcloud]-->L
-    A[OX AppSuite]-->L
-    D[OX Dovecot]-->L
-    P[Portal/Admin]-->L
-    O[OpenProject]-->L
-    X[XWiki]-->|in 2023|L
-    A-->K
-    N-->K
-    D-->K
-    O-->K
-    X-->K
-    P-->|SAML|K
-    E[Element]-->K
-    J[Jitsi]-->K
-    I[IntercomService]-->K
-    C[Collabora]-->N
-    F[Postfix]-->D
-```
-
-# Provisioning
-
-Currently active provisioning is only done for OX AppSuite. The OX-Connector
-synchronizes creates, modifies and deletes activities for the following objects
-to the OX AppSuite using the AppSuite's SOAP API:
-
-- Contexts
-- Users
-- Groups
-- Functional Mailboxes
-- Resources
-
-# Component specific documentation
-
-We want to provide more information per component in separate, component
-specific `README.md` files. In order to establish a common view on the
-components we are going to cover various aspects:
-
-- **Component overview**: Shall provide a quick introduction including the components prerequisites and subcomponents (f.e. pods).
-- **Resources**: Will contain a link to the components upstream documentation, the helm chart and image locations.
-- **Operational Capabilities**
-  - **Install**: The components installs within the SWP.
-  - **Restart**: Deleting and restarting pods works seamlessly.
-  - **Update**: Redeploying the component with a different configuration works as expected. The component makes use of the updates configuration afterwards.
-  - **Upgrade**: Component allows to upgrade existing deployments with more current versions of itself.
-  - **Secrets**: The component uses K8s secrets.
-  - **Logging**: Only logging to STDOUT, no logs inside the container.
-  - **Monitoring**: Application provides based on kube-prometheus-stack CRD: ServiceMonitor and PrometheusRule. Optional: Grafana Dashboard.
-  - **Scale**: If supported (as we use community products) the component should be manually scalable. Optional: Autoscaling.
-  - **Network policies**: Deny by default, allow application related traffic.
-  - **Uninstall**: Documented and working complete uninstallation of the component.
-- **Debugging**: Some helpful information when it comes to debugging a component, e.g. setting log level.
-
-## Links to component README.mds
-
-- [Intercom-Service](./helmfile/apps/intercom-service/README.md)
-
-## Tests
-
-The gitlab-ci pipeline contains a job named `run-tests` that can trigger a test suite pipeline on another gitlab project.
-The `DEPLOY_`-variables are used to determine which components should be tested.
-In order for the trigger to work, the variable `TESTS_PROJECT_URL` has to be set on this gitlab project's CI variables
-that can be found at `Settings` -> `CI/CD` -> `Variables`. The variable should have this format:
-`<domain of gitlab>/api/v4/projects/<id>`.
-
-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.
-
-
-# Footnotes
-
-[^1] Required for scaling components Nextcloud, Dovecot and ClamAV Distributed.
+Copyright (C) 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH

REUSE.toml

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+
+version = 1
+
+[[annotations]]
+path = "cspell.json"
+SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
+SPDX-License-Identifier = "Apache-2.0"
+
+[[annotations]]
+path = "helmfile/files/gpg-pubkeys/*"
+SPDX-FileCopyrightText = "2023 Bundesministerium des Innern und für Heimat, PG ZenDiS \"Projektgruppe für Aufbau ZenDiS\""
+SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = "helmfile/files/theme/**"
+SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
+SPDX-License-Identifier = "Apache-2.0"
+
+[[annotations]]
+path = "docs/architecture/apis_images/*"
+SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
+SPDX-License-Identifier = "Apache-2.0"
+
+[[annotations]]
+path = "helmfile/files/portal-tiles/*"
+SPDX-FileCopyrightText = "2024 Google LLC"
+SPDX-License-Identifier = "Apache-2.0"

cspell.json

@@ -0,0 +1,86 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [],
+    "dictionaries": [],
+    "words": [
+        "Addressbooks",
+        "AppSuite",
+        "Arbeitsplatz",
+        "Aufbau",
+        "bootstrap",
+        "Bundesministerium",
+        "Ceph",
+        "clamav",
+        "CNCF",
+        "Collabora",
+        "commandline",
+        "configurability",
+        "containerd",
+        "Coturn",
+        "cryptpad",
+        "databasename",
+        "Digitale",
+        "DMARC",
+        "explorative",
+        "Filepicker",
+        "filestore",
+        "Gitflow",
+        "gotmpl",
+        "Grundschutz",
+        "hadolint",
+        "Heimat",
+        "helmfile",
+        "helmfiles",
+        "homeserver",
+        "IBAC",
+        "ICAP",
+        "IMAPS",
+        "Innern",
+        "Jitsi",
+        "kcadmin",
+        "Keycloak",
+        "Kubescape",
+        "kubespray",
+        "Kyverno",
+        "letsencrypt",
+        "localpart",
+        "Minio",
+        "NATS",
+        "Nextcloud",
+        "nindent",
+        "Nordeck",
+        "Nubus",
+        "Öffentlichen",
+        "OIDC",
+        "opencode",
+        "openDesk",
+        "OpenProject",
+        "Otterize",
+        "Projektgruppe",
+        "psql",
+        "pubkeys",
+        "RDBMS",
+        "seccomp",
+        "selfsigned",
+        "slapadd",
+        "slapcat",
+        "SMTPS",
+        "Souveräne",
+        "Souveränität",
+        "templating",
+        "trashbin",
+        "truststore",
+        "Univention",
+        "Velero",
+        "Verwaltung",
+        "Videokonferenz",
+        "Weboffice",
+        "Xchange",
+        "xwiki",
+        "Zentrum",
+        "analysed"
+    ],
+    "ignoreWords": [],
+    "import": []
+}

dev/README.md

@@ -0,0 +1,36 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Tools for local development</h1>
+
+* [charts-local.py](#charts-localpy)
+  * [Commandline parameter](#commandline-parameter)
+    * [`--branch`](#--branch)
+    * [`--revert`](#--revert)
+
+# charts-local.py
+
+This script helps you on cloning the platform development Helm charts and referencing them directly in the openDesk
+Helmfile deployment for comfortable local test and development. The charts will be cloned into a directory
+parallel created next to the `opendesk` repo containing this documentation and the `charts-local.py` script.
+The name of the chart directory is derived from the branch name you are working with in this `opendesk` repo.
+
+The script will create `.bak` copies of the helmfiles that have been touched.
+
+Run the script with `-h` to get information about the script's parameter on commandline.
+
+## Commandline parameter
+
+### `--branch`
+
+Optional parameter: Defines a branch for the `opendesk` repo to work with. The script will create the branch if it
+does not exist yet. Otherwise it will switch to defined branch.
+
+If parameter is omitted the current branch of the `opendesk` repo will be used.
+
+### `--revert`
+
+Reverts the changes in the helmfiles pointing to the local Helm charts by copying the backup files created by the
+scripts itself back to their original location.

dev/charts-local.py

@@ -0,0 +1,195 @@
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+# SPDX-License-Identifier: Apache-2.0
+
+import os.path
+import logging
+import yaml
+import sys
+import shutil
+import subprocess
+import configargparse
+
+from pathlib import Path
+from git import Repo
+
+p = configargparse.ArgParser()
+p.add('--branch', env_var='CHART_DEV_BRANCH', help='The branch you want to work with. Will be created by the script if it does not exist yet.')
+p.add('--git_hostname', env_var='GIT_HOSTNAME', default='git@gitlab.opencode.de', help='Set the hostname for the chart git checkouts.')
+p.add('--revert', default=False, action='store_true', help='Set this parameter if you want to revert the referencing of the local helm chart checkout paths in the helmfiles.')
+p.add('--match', default='', help="Clone/pull only charts that contain the given string in their name.")
+p.add('--pull', default=False, action='store_true', help='Will also pull and unpack Helm charts that are not developed by product development.')
+p.add('--loglevel', env_var='LOGLEVEL', default='DEBUG', help='Set the loglevel: DEBUG, INFO, WARNING, ERROR, CRITICAL-')
+options = p.parse_args()
+
+script_path = os.path.dirname(os.path.realpath(__file__))
+# some static definitions
+log_path = script_path+'/../logs'
+charts_yaml = script_path+'/../helmfile/environments/default/charts.yaml.gotmpl'
+base_repo_path = script_path+'/..'
+base_helmfile = base_repo_path+'/helmfile_generic.yaml.gotmpl'
+helmfile_backup_extension = '.bak'
+
+Path(log_path).mkdir(parents=True, exist_ok=True)
+
+logFormatter = logging.Formatter("%(asctime)s %(levelname)-5.5s %(message)s")
+rootLogger = logging.getLogger()
+rootLogger.setLevel(options.loglevel)
+
+fileHandler = logging.FileHandler("{0}/{1}.log".format(log_path, os.path.basename(__file__)))
+fileHandler.setFormatter(logFormatter)
+rootLogger.addHandler(fileHandler)
+
+consoleHandler = logging.StreamHandler()
+consoleHandler.setFormatter(logFormatter)
+rootLogger.addHandler(consoleHandler)
+
+logging.debug(f"Working with relative paths from script location: {script_path}")
+logging.debug(f"Log directory:      {log_path}")
+logging.debug(f"charts.yaml.gotmpl: {charts_yaml}")
+
+
+def create_or_switch_branch_base_repo():
+    base_repo = Repo(path=base_repo_path)
+    current_branch = base_repo.active_branch.name
+    if not options.branch:
+        branch = current_branch
+        logging.debug(f"No branch specified on commandline, working with current branch: {current_branch}")
+    else:
+        branch = options.branch
+        if branch in base_repo.branches:
+            if branch != current_branch:
+                logging.debug(f"Selected {branch} already exists, switching.")
+                # ToDo: Graceful handle: "Please commit your changes or stash them before you switch branches."
+                base_repo.git.switch(branch)
+            else:
+                logging.debug(f"Already on selected brach {branch}")
+        else:
+            logging.debug(f"Creating branch {branch} and switching")
+            base_repo.git.branch(branch)
+            base_repo.git.switch(branch)
+    return branch
+
+def create_path_if_not_exists(path):
+    if os.path.isdir(path):
+        logging.warning(f"Path {path} already exists.")
+    else:
+        logging.debug(f"creating directory {path}.")
+        Path(path).mkdir(parents=True, exist_ok=True)
+
+def clone_charts_locally(branch, charts):
+    charts_clone_path = script_path+'/../../chart-repo/'+branch.replace('/', '_')
+    charts_pull_path = script_path+'/../../chart-pull/'+branch.replace('/', '_')
+    charts_dict = {}
+    doublette_dict = {}
+    create_path_if_not_exists(charts_clone_path)
+    if options.pull:
+        create_path_if_not_exists(charts_pull_path)
+
+    for chart in charts['charts']:
+        tag = charts['charts'][chart]['version']
+        repository = charts['charts'][chart]['repository']
+        registry = charts['charts'][chart]['registry']
+        name = charts['charts'][chart]['name']
+        logging.debug(f"Working on {chart} / tag {tag} / repo {repository}")
+        if not options.match in name:
+            logging.info(f"Chart name {name} does not match {options.match} - skipping...")
+        elif registry == '':
+            logging.info("Empty registry definition - skipping...")
+        elif 'opendesk/components/platform-development/charts' in repository:
+            logging.info("Cloning the charts repo")
+            git_url = options.git_hostname+':'+repository
+            chart_repo_path = charts_clone_path+'/'+charts['charts'][chart]['name']
+            if git_url in doublette_dict:
+                logging.debug(f"{chart} located at {git_url} is already checked out to {doublette_dict[git_url]}")
+                charts_dict[chart] = doublette_dict[git_url]
+            else:
+                if os.path.isdir(chart_repo_path):
+                    logging.debug(f"Already exists {chart_repo_path} leaving it unmodified")
+                else:
+                    logging.debug(f"Cloning into {chart_repo_path}")
+                    Repo.clone_from(git_url, chart_repo_path)
+                    chart_repo = Repo(path=chart_repo_path)
+                    chart_repo.git.checkout('v'+charts['charts'][chart]['version'])
+                doublette_dict[git_url] = chart_repo_path
+                charts_dict[chart] = chart_repo_path
+        elif options.pull:
+            logging.info("Pulling the chart")
+            helm_command = f"helm pull oci://{registry}/{repository}/{name} --version {tag} --untar --destination {charts_pull_path}"
+            logging.debug(f"CLI command: {helm_command}")
+            try:
+                output = subprocess.check_output(helm_command, shell = True)
+            except subprocess.CalledProcessError:
+                sys.exit(f"! CLI command '{helm_command}' failed")
+        else:
+            logging.debug("Not a product development chart and `--pull` option not enabled - skipping...")
+
+    return charts_dict
+
+
+def grep_yaml(file):
+    with open(file, 'r') as file:
+        content = ''
+        for line in file.readlines():
+            if not ': {{' in line and not '- {{' in line:
+                content += line
+    return yaml.safe_load(content)
+
+
+def get_child_helmfiles():
+    child_helmfiles = []
+    root_helmfile = grep_yaml(base_helmfile)
+    for entry in root_helmfile['helmfiles']:
+        child_helmfiles.append(base_repo_path+'/'+entry['path'])
+    return child_helmfiles
+
+
+def process_the_helmfiles(charts_dict, charts):
+    chart_def_prefix = '    chart: "'
+    child_helmfiles = get_child_helmfiles()
+    for child_helmfile in child_helmfiles:
+        child_helmfile_updated = False
+        output = []
+        with open(child_helmfile, 'r') as file:
+            for line in file:
+                if chart_def_prefix in line:
+                    for chart_ident in charts_dict:
+                        if '.Values.charts.'+chart_ident+'.name' in line:
+                            logging.debug(f"found match with {chart_ident} in {line.strip()}")
+                            line = chart_def_prefix+charts_dict[chart_ident]+'/charts/'+charts['charts'][chart_ident]['name']+'" # replaced by local-dev script'+"\n"
+                            child_helmfile_updated = True
+                            break
+                output.append(line)
+        if child_helmfile_updated:
+            child_helmfile_backup = child_helmfile+helmfile_backup_extension
+            if os.path.isfile(child_helmfile_backup):
+                logging.debug("backup {child_helmfile_backup} already exists, will not create a new one.")
+            else:
+                logging.debug(f"creating backup {child_helmfile_backup}.")
+                shutil.copy2(child_helmfile, child_helmfile_backup)
+            logging.debug(f"Updating {child_helmfile}")
+            with open(child_helmfile, 'w') as file:
+                file.writelines(output)
+
+
+def revert_the_helmfiles():
+    child_helmfiles = get_child_helmfiles()
+    for child_helmfile in child_helmfiles:
+        child_helmfile_backup = child_helmfile+helmfile_backup_extension
+        if os.path.isfile(child_helmfile_backup):
+            logging.debug(f"Reverting {child_helmfile} from backup {child_helmfile_backup}")
+            os.rename(child_helmfile_backup, child_helmfile)
+        else:
+            logging.debug(f"Did not found the backup file {child_helmfile_backup}")
+
+##
+## Main program
+##
+if options.revert:
+    revert_the_helmfiles()
+else:
+    branch = create_or_switch_branch_base_repo()
+    with open(charts_yaml, 'r') as file:
+        charts = yaml.safe_load(file)
+    charts_dict = clone_charts_locally(branch, charts)
+    process_the_helmfiles(charts_dict, charts)

dev/requirements.txt

@@ -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
+
+configargparse
+pyyaml
+GitPython

docs/architecture.md

@@ -0,0 +1,450 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Architecture</h1>
+
+<!-- TOC -->
+* [Overview](#overview)
+* [Nubus (IAM)](#nubus-iam)
+* [Authentication](#authentication)
+  * [Identity data flows](#identity-data-flows)
+  * [OpenID Connect (OIDC)](#openid-connect-oidc)
+  * [Keycloak](#keycloak)
+  * [Keycloak Extensions](#keycloak-extensions)
+  * [OpenLDAP](#openldap)
+* [Authorization](#authorization)
+  * [LDAP Group Synchronization](#ldap-group-synchronization)
+* [Provisioning](#provisioning)
+  * [OX Connector](#ox-connector)
+  * [SCIM](#scim)
+* [Component integration](#component-integration)
+  * [Intercom Service / Silent Login](#intercom-service--silent-login)
+  * [Central Contacts](#central-contacts)
+  * [Central Navigation](#central-navigation)
+  * [Filepicker](#filepicker)
+  * [Newsfeed](#newsfeed)
+  * [(OpenProject) File Store](#openproject-file-store)
+* [Applications vs. Services](#applications-vs-services)
+  * [Collabora (Office)](#collabora-office)
+  * [CryptPad Online (Diagrams)](#cryptpad-online-diagrams)
+  * [Element/Synapse (Chat \& Call)](#elementsynapse-chat--call)
+  * [Jitsi (Video Conferencing)](#jitsi-video-conferencing)
+  * [Nextcloud (Files)](#nextcloud-files)
+  * [Nubus (Identity and Access Management / Portal)](#nubus-identity-and-access-management--portal)
+  * [OpenProject (Project management)](#openproject-project-management)
+  * [OX App Suite (Groupware) with OX Dovecot (Mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend)
+  * [XWiki (Knowledge management)](#xwiki-knowledge-management)
+* [Application specific user accounts](#application-specific-user-accounts)
+* [Footnotes](#footnotes)
+<!-- TOC -->
+
+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).
+
+openDesk includes the 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
+these services yourself.
+
+# Overview
+
+The following diagram shows a high-level overview of openDesk.
+
+```mermaid
+flowchart TD
+    A(User) -->|Log In| B[Keycloak]
+    subgraph Nubus
+        B -->C[Portal]
+        B -->|User Directory| OpenLDAP
+    end
+    C -->|Manage Files| NC[fa:fa-file Nextcloud]
+    C -->|Chat & Call| EL[fa:fa-comments Element]
+    C -->|Send/Receive E-Mails| OXE[fa:fa-envelope OX App Suite]
+    C -->|Manage Appointments| OXC[fa:fa-calendar OX App Suite]
+    NC -->|Edit Office Documents| CO[fa:fa-file-word Collabora Online]
+    NC -->|Edit diagram.net Documents| CP[fa:fa-chart-diagram CryptPad]
+    C -->|Manage Tasks| OP[fa:fa-diagram-project OpenProject]
+    C -->|Store Knowledge| XW[fa:fa-book XWiki]
+    C -->|Meet People| JI[fa:fa-video Jitsi]
+```
+
+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
+for storing users, groups, and permissions, and Keycloak for single sign-on with LDAP user federation
+configured to the aforementioned OpenLDAP.
+
+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
+applications again. This is implemented using the OpenID Connect (OIDC) protocol.
+
+# Nubus (IAM)
+
+[Nubus](https://www.univention.de/products/nubus/) is a specialized IAM platform developed by Univention GmbH
+to centralize and simplify identity management in IT environments. It is typically used in contexts where
+user authentication, role-based access control, and integration with multiple systems are essential.
+
+In openDesk, Nubus serves the following purposes:
+
+1. Identity Provider (IdP)
+
+    Nubus acts as the central IdP in a federated authentication system, issuing and managing authentication tokens for applications.
+
+2. Access Control Layer
+
+    As a gateway, Nubus ensures that only authorized users can access specific systems, services, or APIs, enforcing RBAC policies.
+
+3. Integration Hub
+
+    Links applications by synchronizing identity and access data across them, ensuring consistency.
+
+4. User Provisioning
+
+    Automates the process of creating, updating, and deactivating user accounts across integrated systems based on organizational workflows.
+
+5. IAM Administration
+
+    The user, group and permission information which is stored in Nubus' OpenLDAP service is managed by IAM Admin(s)
+    using a stripped down version of the [UMC (Univention Management Console)](https://docs.software-univention.de/manual/5.0/de/central-management-umc/umc.html).
+
+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.
+
+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.
+
+For additional information, refer to the [Nubus for Kubernetes Architecture Manual](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/index.html).
+
+# Authentication
+
+openDesk uses the OpenID Connect (OIDC) protocol for authentication and authorization.
+
+## Identity data flows
+
+An overview of
+- components that consume the LDAP service.
+  - The components access the LDAP using a component-specific LDAP search account.
+- components using Univention Keycloak as an identity provider (IdP).
+  - The components should use OAuth2 / OIDC flows if not otherwise denoted.
+  - All components have a client configured in Keycloak.
+
+Some components trust others to handle authentication for them.
+
+```mermaid
+flowchart TD
+ K[IdP]-->L[LDAP]
+ N[Nextcloud]-->L
+ O[OpenProject] --> L
+ A[OX AppSuite]-->L
+ D[OX Dovecot]-->L
+ P[Portal/Admin]-->L
+ X[XWiki]-->L
+ A-->K
+ N-->K
+ D-->K
+ O-->K
+ X-->K
+ P-->|SAML|K
+ E[Element]-->K
+ J[Jitsi]-->K
+ I[IntercomService]-->K
+ C[Collabora]-->N
+ R[CryptPad]-->N
+ F[Postfix]-->D
+```
+
+## OpenID Connect (OIDC)
+
+[OIDC](https://openid.net/developers/how-connect-works/) is an identity layer on top of the OAuth 2.0 protocol, allowing clients (Relying Party (RP)) to verify the identity of end-users based on the authentication performed by an authorization server (OpenID Provider (OP)). In openDesk, Keycloak serves as the OIDC provider, managing user authentication and issuing tokens for secure access to applications.
+
+The following sequence diagram shows an OIDC flow of a user logging into openDesk's project management application. In openDesk, applications such as OpenProject take the role of the OIDC Relying Party, whereas Keycloak acts as the OIDC provider and OpenLDAP as the IdP.
+
+```mermaid
+sequenceDiagram
+    autonumber
+    participant Browser as Browser
+    participant OpenProject as OpenProject<br/>OIDC Relying Party
+    participant Keycloak as Keycloak<br>OIDC Provider
+    participant LDAP as OpenLDAP<br>IdP
+    Browser->>OpenProject: GET https://projects.domain.tld
+    OpenProject-->>Browser: Redirect to OIDC provider authentication form (with request)
+    Browser->>Keycloak: Authenticate with username/password, optionally 2FA
+    Keycloak->>LDAP: Retrieve/update user information
+    LDAP->>Keycloak: Return user info
+    Keycloak-->>Browser: 302 Redirect https://projects.domain.tld/callback?[...]
+    Browser->>OpenProject: GET https://projects.domain.tld/callback?[...]
+    OpenProject->>Keycloak: POST https://id.domain.tld/oauth/token
+    Keycloak-->>OpenProject: Return JSON with token, signature
+    OpenProject->>OpenProject: Verify token signature valid, signed by Provider
+    OpenProject-->>Browser: 302 Redirect https://projects.domain.tld
+    Note over Browser: User is authenticated
+```
+
+> **Note:**<br>
+> Nubus' Portal and UMC still use [SAML 2.0](https://www.oasis-open.org/standard/saml/) to authenticate users. However, Nubus will switch to OIDC in an upcoming release, eliminating the use of SAML in openDesk altogether.
+
+## Keycloak
+
+[Keycloak](https://www.keycloak.org/) is an open-source identity and access management solution for web based applications and services. It provides features such as single sign-on, multi-factor authentication, user federation, and centralized user management.
+
+In openDesk, Keycloak serves as the [OIDC provider](#openid-connect-oidc), handling user authentication and issuing tokens for secure access to applications.
+
+For more information, see the [Keycloak Documentation](https://www.keycloak.org/documentation).
+
+## 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
+
+- 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.
+- New device notification: Sending the use an email after successful login from a new device.
+
+To address these use cases the Keycloak Extensions act as a proxy to Keycloak.
+
+## 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.
+
+# Authorization
+
+## 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.
+
+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.
+- 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.
+- 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`.
+- 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.
+
+# 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).
+
+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.
+
+## 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).
+
+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
+- Functional Mailboxes
+- Groups
+- (Managed) Resources
+- Users
+
+To find out more, see [Roles & Permissions](permissions.md).
+
+## 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.
+
+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.
+
+> **Note:**<br>
+> SCIM support is planned in openDesk for 2025.
+
+# Component integration
+
+Important, especially from the end user perspective are the functional integrations between the different openDesk applications.
+
+```mermaid
+flowchart TD
+ OX-AppSuite_Frontend-->|Silent Login, Filepicker, Central Navigation|Intercom_Service
+ Element-->|Silent Login, Central Navigation|Intercom_Service
+ Intercom_Service-->|Silent Login, Token Exchange|IdP
+ Intercom_Service-->|Filepicker|Nextcloud
+ Intercom_Service-->|Central Navigations|Portal
+ Intercom_Service-->|Newsfeed|XWiki
+ OX-AppSuite_Backend-->|Filepicker|Nextcloud
+ OX-AppSuite_Backend-->|Videoconferences|Element
+ Nextcloud-->|Central Navigation|Portal
+ OpenProject-->|Central Navigation|Portal
+ OpenProject-->|File Store|Nextcloud
+ XWiki-->|Central Navigation|Portal
+ Nextcloud-->|Central Contacts|OX-AppSuite_Backend
+ OX-AppSuite_Frontend-->|Filepicker|OX-AppSuite_Backend
+ Portal-->|Newsfeed|Intercom_Service
+```
+
+Details can be found in the upstream documentation that is linked in the respective sections.
+
+## Intercom Service / Silent Login
+
+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
+the API from another application is often a challenge.
+
+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.
+
+**Links**
+- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
+
+## 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
+- 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.
+
+**Links:**
+- 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.
+
+## Central Navigation
+
+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.
+
+The API can be called by
+- frontend services through the Intercom Service's `/navigation.json` endpoint or
+- 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
+contents should be returned for.
+
+A `curl` based request returning the navigation contents looks like this:
+
+```
+curl 'https://portal.<DOMAIN>/univention/portal/navigation.json?base=https%3A//portal.<DOMAIN>&language=de-DE' -u "<USERNAME>:<SHARED_SECRET>"
+```
+
+## Filepicker
+
+The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the following use cases against the respective openDesk instance's Nextcloud:
+- Attach files from Nextcloud to emails.
+- Create and add links to Nextcloud files into emails.
+- Save attachments from emails into Nextcloud.
+- Attach files from Nextcloud to calendar entries.
+
+The Filepicker uses frontend and backend-based integration:
+- 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
+when adding a file to an email or storing a file into Nextcloud to avoid passing these files through the user's browser.
+
+**Links**
+- [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation).
+
+## Newsfeed
+
+The portal renders a newsfeed based on entries of a predefined openDesk blog in XWiki. It accesses the required XWiki
+service through the Intercom Service's `/wiki` endpoint, in combination with the previously described silent login.
+
+**Links:**
+- [XWiki Blog feature](https://extensions.xwiki.org/xwiki/bin/view/Extension/Blog%20Application)
+
+## (OpenProject) File Store
+
+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.
+
+Therefore, openDesk pre-configures the trust between the openDesk instance's OpenProject and Nextcloud during the `openproject-boostrap` deployment step. As a prerequisite for that, openDesk's Nextcloud contains the `integration_openproject` app.
+
+The file store must still be enabled per project in OpenProject's project admin section.
+
+**Links:**
+- [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)
+
+# Applications vs. Services
+
+openDesk consists of a variety of open-source projects, please find an overview below:
+
+| Name                  | Description                      | Type        |
+| --------------------- | -------------------------------- | ----------- |
+| Certificates          | TLS certificates                 | Service     |
+| ClamAV (Distributed)  | Antivirus engine                 | Service     |
+| ClamAV (Simple)       | Antivirus engine                 | Service     |
+| Collabora             | Weboffice                        | Application |
+| CryptPad              | diagrams.net editor              | Application |
+| dkimpy-milter         | DKIM milter for Postfix          | Service     |
+| Element               | Secure communications platform   | Application |
+| Jitsi                 | Videoconferencing                | Application |
+| MariaDB               | Database                         | Service     |
+| Memcached             | Cache Database                   | Service     |
+| MinIO                 | Object Storage                   | Service     |
+| Nextcloud             | File share                       | Application |
+| Nubus (UMS)           | Identity Management & Portal     | Application |
+| OpenProject           | Project management               | Application |
+| OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application |
+| Postfix               | MTA                              | Service     |
+| PostgreSQL            | Database                         | Service     |
+| Redis                 | Cache Database                   | Service     |
+| 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.
+
+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).
+
+## Collabora (Office)
+
+[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.
+
+## CryptPad Online (Diagrams)
+
+[CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption..
+
+In openDesk, CryptPad is for editing diagrams.net documents.
+
+## 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).
+
+In openDesk, Element is used for chat and direct audio & video calling.
+
+## Jitsi (Video Conferencing)
+
+[Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings.
+
+In openDesk, Jitsi is used for video conferencing and online meetings. It integrates with other applications to provide seamless communication capabilities.
+
+## Nextcloud (Files)
+
+[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](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
+
+## OpenProject (Project management)
+
+[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](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.
+
+## XWiki (Knowledge management)
+
+[XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration.
+
+# Application specific user accounts
+
+While the IAM managed users centrally, some applications come with local accounts for administrative purposes.
+
+| Application  | Account name                                  | Purpose                                                                                                                 | Password                                         |
+| ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| Collabora    | `collabora-internal-admin`                    | To access the Collabora admin dashboard                                                                                 | `secrets.collabora.adminPassword`                |
+| 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`           |
+| 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`               |
+| 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`               |
+
+# Footnotes
+
+[^1]: We are working on a new approach to provision the OpenProject filestore, therefore the accounts are planned to be deactivated/removed with openDesk 1.2.

docs/architecture/apis.md

@@ -0,0 +1,941 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>openDesk APIs</h1>
+
+This chapter presents APIs available in openDesk grouped by applications.
+
+* [IAM - Nubus](#iam---nubus)
+  * [UMC Python API](#umc-python-api)
+  * [UMC store API](#umc-store-api)
+  * [IntercomService (ICS) API](#intercomservice-ics-api)
+  * [High-level Listener modules API](#high-level-listener-modules-api)
+  * [UDM Simple API](#udm-simple-api)
+  * [UDM REST API](#udm-rest-api)
+  * [UCR Python API](#ucr-python-api)
+  * [LDAP](#ldap)
+  * [Nubus Provisioning Service (**TBD**)](#nubus-provisioning-service-tbd)
+  * [Nubus Authorization Service (**TBD**)](#nubus-authorization-service-tbd)
+* [Groupware - OX AppSuite / OX Dovecot](#groupware---ox-appsuite--ox-dovecot)
+  * [Usage of APIs within openDesk](#usage-of-apis-within-opendesk)
+  * [HTTP API](#http-api)
+  * [SOAP API](#soap-api)
+  * [REST API](#rest-api)
+  * [CardDAV](#carddav)
+  * [CalDAV](#caldav)
+  * [IMAP](#imap)
+  * [POP3](#pop3)
+* [Files - Nextcloud](#files---nextcloud)
+  * [Usage of APIs within openDesk](#usage-of-apis-within-opendesk-1)
+  * [OCS API](#ocs-api)
+  * [Notifications API](#notifications-api)
+  * [Activity API](#activity-api)
+  * [Remote wipe API](#remote-wipe-api)
+  * [WebDAV](#webdav)
+  * [CalDAV / CardDAV](#caldav--carddav)
+* [Weboffice - Collabora](#weboffice---collabora)
+  * [PostMessage API](#postmessage-api)
+  * [Conversion API](#conversion-api)
+* [Project management - OpenProject](#project-management---openproject)
+  * [HATEOAS API](#hateoas-api)
+  * [BCF API](#bcf-api)
+* [Video Conferencing - Jitsi](#video-conferencing---jitsi)
+  * [IFrame API](#iframe-api)
+  * [Lib-jitsi-meet API](#lib-jitsi-meet-api)
+  * [Jitsi Meet React SDK](#jitsi-meet-react-sdk)
+* [Chat - Element](#chat---element)
+  * [Matrix Application Service API](#matrix-application-service-api)
+  * [Matrix Client-Server API](#matrix-client-server-api)
+  * [Matrix Server-Server API](#matrix-server-server-api)
+  * [Matrix Push Gateway API](#matrix-push-gateway-api)
+  * [Matrix Identity Service API](#matrix-identity-service-api)
+  * [Matrix React SDK Module API](#matrix-react-sdk-module-api)
+  * [Matrix Widget API](#matrix-widget-api)
+  * [NeoBoard Data Model API](#neoboard-data-model-api)
+  * [NeoDateFix REST API](#neodatefix-rest-api)
+* [Knowledge management - XWiki](#knowledge-management---xwiki)
+  * [REST API](#rest-api-1)
+  * [Scripting API](#scripting-api)
+  * [Java API](#java-api)
+  * [JavaScript API](#javascript-api)
+
+# IAM - Nubus
+
+![High-level architecture of Univention part withAPIs/interfaces highlighted](./apis_images/IAM-overview.png)
+
+## UMC Python API
+
+![Composition of UMC component with APIs highlighted](./apis_images/IAM-umc-architecture.png)
+
+| Name                           | UMC Python API                                                                                                                                                                                                                                 |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        |                                                                                                                                                                                                                                                |
+| Versioning                     |                                                                                                                                                                                                                                                |
+| Authentication                 |                                                                                                                                                                                                                                                |
+| In openDesk provided by        | Nubus UMC                                                                                                                                                                                                                                      |
+| Transport protocol             |                                                                                                                                                                                                                                                |
+| Usage within component         |                                                                                                                                                                                                                                                |
+| Usage within openDesk          |                                                                                                                                                                                                                                                |
+| Usage for external integration |                                                                                                                                                                                                                                                |
+| Parallel access                | Allowed                                                                                                                                                                                                                                        |
+| Message protocol               | [Univention Management Console Protocol (UMCP)](https://docs.software-univention.de/ucs-python-api/univention.management.console.protocol.html). Format consisting of a single header line, one empty line and the body. The body can be JSON. |
+| Supported standards            |                                                                                                                                                                                                                                                |
+| Documentation                  | https://docs.software-univention.de/ucs-python-api/modules.html                                                                                                                                                                                |
+
+## UMC store 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                                            |
+| Versioning                     |                                                                                                           |
+| Authentication                 |                                                                                                           |
+| In openDesk provided by        | Nubus UMC                                                                                                 |
+| Transport protocol             |                                                                                                           |
+| Usage within component         |                                                                                                           |
+| Usage within openDesk          |                                                                                                           |
+| Usage for external integration |                                                                                                           |
+| Parallel access                | Allowed                                                                                                   |
+| Message protocol               |                                                                                                           |
+| Supported standards            |                                                                                                           |
+| Documentation                  | https://docs.software-univention.de/developer-reference/5.0/en/umc/local-system-module.html#umc-store-api |
+
+## IntercomService (ICS) API
+
+| Name                           | IntercomService API                                                                                                                                                                                                                 |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Encapsulate and ease the access to module data from JavaScript                                                                                                                                                                      |
+| Versioning                     |                                                                                                                                                                                                                                     |
+| Authentication                 | IdP based SSO                                                                                                                                                                                                                       |
+| In openDesk provided by        | Nubus UMC                                                                                                                                                                                                                           |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                                             |
+| 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 for external integration |                                                                                                                                                                                                                                     |
+| Parallel access                | Allowed                                                                                                                                                                                                                             |
+| Message protocol               | Depends on the integration use case.                                                                                                                                                                                                |
+| Supported standards            |                                                                                                                                                                                                                                     |
+| Documentation                  | https://docs.software-univention.de/intercom-service/latest/architecture.html                                                                                                                                                       |
+
+## High-level Listener modules API
+
+| Name                           | High-level Listener modules API                                                                                                                                                                                                     |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Dispatching of LDAP events.                                                                                                                                                                                                         |
+| Versioning                     |                                                                                                                                                                                                                                     |
+| Authentication                 |                                                                                                                                                                                                                                     |
+| In openDesk provided by        | Univention Event Processing                                                                                                                                                                                                         |
+| 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 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 |                                                                                                                                                                                                                                     |
+| Parallel access                | Allowed                                                                                                                                                                                                                             |
+| Message protocol               | Depends on the integration use case.                                                                                                                                                                                                |
+| Supported standards            |                                                                                                                                                                                                                                     |
+| Documentation                  | https://docs.software-univention.de/developer-reference/5.0/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
+
+## UDM Simple API
+
+![Composition of UMC component with APIs highlighted](./apis_images/IAM-udm.png)
+
+| Name                           | UDM Simple API                                                    |
+| ------------------------------ | ----------------------------------------------------------------- |
+| Purpose                        | Allows to use capability and objects directly in Python programs. |
+| Versioning                     |                                                                   |
+| Authentication                 |                                                                   |
+| In openDesk provided by        | Univention Directory Manager                                      |
+| Transport protocol             |                                                                   |
+| Usage within component         |                                                                   |
+| Usage within openDesk          |                                                                   |
+| Usage for external integration |                                                                   |
+| Parallel access                | Allowed                                                           |
+| Message protocol               | Depends on the integration use case.                              |
+| Supported standards            |                                                                   |
+| Documentation                  |                                                                   |
+
+## UDM REST API
+
+| Name                           | UDM REST API                                                                                                                               |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| Purpose                        | Inspect, modify, create and delete objects through HTTP requests.                                                                          |
+| Versioning                     |                                                                                                                                            |
+| Authentication                 | Basic Auth                                                                                                                                 |
+| In openDesk provided by        | Univention Directory Manager                                                                                                               |
+| Transport protocol             | HTTP(S)                                                                                                                                    |
+| Usage within component         | The Nubus bootstrapping makes use of the API.                                                                                               |
+| 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. |
+| Parallel access                | Allowed                                                                                                                                    |
+| Message protocol               | Depends on the integration use case.                                                                                                       |
+| Supported standards            |                                                                                                                                            |
+| Documentation                  | https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html                                                           |
+
+## UCR Python API
+
+![Composition of UCR component with APIs/interfaces highlighted](./apis_images/IAM-ucr.png)
+
+| Name                           | UCR Python API                                                                                      |
+| ------------------------------ | --------------------------------------------------------------------------------------------------- |
+| Purpose                        | Offers a programming interface for components and other Python programs.                            |
+| Versioning                     |                                                                                                     |
+| Authentication                 |                                                                                                     |
+| In openDesk provided by        | Nubus                                                                                               |
+| Transport protocol             |                                                                                                     |
+| Usage within component         | The Nubus bootstrapping makes use of the API.                                                       |
+| Usage within openDesk          |                                                                                                     |
+| Usage for external integration |                                                                                                     |
+| Parallel access                | Allowed                                                                                             |
+| Message protocol               |                                                                                                     |
+| Supported standards            |                                                                                                     |
+| Documentation                  | https://docs.software-univention.de/developer-reference/5.0/en/ucr/usage.html#using-ucr-from-python |
+
+## LDAP
+
+| Name                           | LDAP                                                                                                                   |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Read access to Nubus LDAP                                                                                              |
+| Versioning                     | n/a                                                                                                                    |
+| Authentication                 | LDAP user auth                                                                                                         |
+| In openDesk provided by        | Nubus openLDAP                                                                                                         |
+| Transport protocol             | LDAP                                                                                                                   |
+| 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 for external integration | No recommended                                                                                                         |
+| Parallel access                | Allowed                                                                                                                |
+| Message protocol               | LDAP                                                                                                                   |
+| Supported standards            | LDAP                                                                                                                   |
+| Documentation                  | https://docs.software-univention.de/manual/5.0/en/domain-ldap/ldap-directory.html                                      |
+
+## Nubus Provisioning Service (**TBD**)
+
+To be delivered.
+
+## Nubus Authorization Service (**TBD**)
+
+To be delivered.
+
+# Groupware - OX AppSuite / OX Dovecot
+
+![OX AppSuite APIs overview](./apis_images/Groupware-apis.png)
+
+![Use of OX AppSuite APIs by other components](./apis_images/Groupware-api-usage.png)
+
+## Usage of APIs within openDesk
+
+Following are APIs used by the Groupware application:
+
+| Used by                        | Accessed component | Service            | Purpose                                                     | Message format                   |
+| ------------------------------ | ------------------ | ------------------ | ----------------------------------------------------------- | -------------------------------- |
+| AppSuite Middleware            | Keycloak           | Authentication     | Single sign-on / sign-out                                   | 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   | 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   | Filepicker         | Read/write contents from/to Nextcloud or create share links | WebDAV & Nextcloud API           |
+| AppSuite Middleware            | Nextcloud          | Filepicker         | Read/write files from/to Nextcloud                          | WebDAV & Nextcloud API           |
+| AppSuite Middleware            | Element Bot        | Element Bot        | Update/delete meetings in Element                            | Custom JSON (based on iCalender) |
+| AppSuite Middleware            | LDAP               | Address book       | Search for global contacts and retrieve contact details     | LDAP                             |
+| Dovecot                        | LDAP               | Data retrieval     | Retrieve necessary user details to handle mailboxes         | LDAP                             |
+
+## HTTP API
+
+![Use of HTTP API in openDesk](./apis_images/Groupware-api-http-usage.png)
+
+| 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. |
+| 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.                                                        |
+| Authentication                 |                                                                                                                                                                                                                 |
+| In openDesk provided by        | OX AppSuite Middleware                                                                                                                                                                                          |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                         |
+| 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 for external integration | Not used at the moment, but recommended way to integrate with OX AppSuite.                                                                                                                                      |
+| Parallel access                | Allowed                                                                                                                                                                                                         |
+| Message protocol               | JSON based, AppSuite specific format                                                                                                                                                                            |
+| Supported standards            | iCal, defined by RFC, fully implemented                                                                                                                                                                         |
+| Documentation                  | https://documentation.open-xchange.com/components/middleware/http/8/index.html                                                                                                                                  |
+
+## SOAP API
+
+| Name                           | SOAP API                                                                                  |
+| ------------------------------ | -------------------------------------------------------------------------------------------- |
+| Purpose                        | Management of users, groups, contexts, resources.                                            |
+| Versioning                     | n/a                                                                                          |
+| Authentication                 | Basic Auth                                                                                   |
+| In openDesk provided by        | OX AppSuite Middleware                                                                       |
+| Transport protocol             | HTTP(S)                                                                                      |
+| Usage within component         | none                                                                                         |
+| Usage within openDesk          | OX-Connector synchronizes the state of the objects (users, groups etc.) managed in the LDAP. |
+| Usage for external integration | none                                                                                         |
+| Parallel access                | Allowed                                                                                      |
+| Message protocol               | XML based, exactly following the format of Java RMI.                                         |
+| Supported standards            | SOAP                                                                                         |
+| Documentation                  | https://software.open-xchange.com/products/appsuite/doc/SOAP/admin/OX-Admin-SOAP.html        |
+
+> **Note**:
+> You will find a catalogue of the available services including links to the respective URLs at `/webservices/` within the AppSuite host of your openDesk installation, e.g. https://webmail.myopendesk.tld/webservices/
+
+## 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 |
+| 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.                                                                                                                                                                                                                                                                                                                                        |
+| Authentication                 | Basic Auth                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| In openDesk provided by        | OX AppSuite Middleware                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Usage within component         | Push module is used by OX Frontend.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| Usage within openDesk          | none                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Usage for external integration | none                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Parallel access                | Allowed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Message protocol               | - Email Body RFC 822 is used by Push<br>- Prometheus format is used by Metrics API<br>- API iCal format is used by InternetFreeBusy                                                                                                                                                                                                                                                                                                                                                             |
+| Supported standards            | SOAP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Documentation                  | https://documentation.open-xchange.com/components/middleware/rest/8/index.html                                                                                                                                                                                                                                                                                                                                                                                                                  |
+## 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 |
+| Versioning                     | Yes, API version is specific to the version of underlying protocol                                                                                                         |
+| Authentication                 |                                                                                                                                                                            |
+| In openDesk provided by        | OX AppSuite Middleware                                                                                                                                                     |
+| Transport protocol             | HTTP(S)                                                                                                                                                                    |
+| Usage within component         | none                                                                                                                                                                       |
+| Usage within openDesk          | none                                                                                                                                                                       |
+| Usage for external integration | none                                                                                                                                                                       |
+| Parallel access                | Allowed                                                                                                                                                                    |
+| Message protocol               | vCard, defined by RFC, fully implemented                                                                                                                                   |
+| Supported standards            |                                                                                                                                                                            |
+| Documentation                  | https://documentation.open-xchange.com/8/middleware/miscellaneous/caldav_carddav.html                                                                                      |
+
+## 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 |
+| Versioning                     | Yes, API version is specific to the version of underlying protocol                                                                                                         |
+| Authentication                 |                                                                                                                                                                            |
+| In openDesk provided by        | OX AppSuite Middleware                                                                                                                                                     |
+| Transport protocol             | HTTP(S)                                                                                                                                                                    |
+| Usage within component         | none                                                                                                                                                                       |
+| Usage within openDesk          | none                                                                                                                                                                       |
+| Usage for external integration | none                                                                                                                                                                       |
+| Parallel access                | Allowed                                                                                                                                                                    |
+| Message protocol               | iCal, defined by RFC, fully implemented                                                                                                                                    |
+| Supported standards            | iTIP, iMIP                                                                                                                                                                 |
+| Documentation                  | https://documentation.open-xchange.com/8/middleware/miscellaneous/caldav_carddav.html                                                                                      |
+
+## IMAP
+
+| Name                           | IMAP                                                               |
+| ------------------------------ | ------------------------------------------------------------------ |
+| Purpose                        | Used for retrieval of emails, designed for rich clients            |
+| Versioning                     | Yes, API version is specific to the version of underlying protocol |
+| Authentication                 |                                                                    |
+| In openDesk provided by        | OX Dovecot                                                         |
+| Transport protocol             | TCP                                                                |
+| Usage within component         | Used by OX AppSuite middleware to read/write mail and folders      |
+| Usage within openDesk          | none                                                               |
+| Usage for external integration | Can be used by local IMAP clients (e.g. Thunderbird)               |
+| Parallel access                | Allowed                                                            |
+| Message protocol               | RFC 9051                                                           |
+| Supported standards            | IMAP                                                               |
+| Documentation                  | https://www.rfc-editor.org/rfc/rfc9051                             |
+
+## POP3
+
+| Name                           | POP3                                                               |
+| ------------------------------ | ------------------------------------------------------------------ |
+| Purpose                        | Used for retrieval of emails, designed for rich clients            |
+| Versioning                     | Yes, API version is specific to the version of underlying protocol |
+| Authentication                 |                                                                    |
+| In openDesk provided by        | OX Dovecot                                                         |
+| Transport protocol             | TCP                                                                |
+| Usage within component         | none                                                               |
+| Usage within openDesk          | none                                                               |
+| Usage for external integration | Can be used by local POP3 clients (e.g. Thunderbird)               |
+| Parallel access                | Allowed                                                            |
+| Message protocol               | RFC 1939                                                           |
+| Supported standards            | IMAP                                                               |
+| Documentation                  | https://www.rfc-editor.org/rfc/rfc1939                             |
+
+# Files - Nextcloud
+
+![Nextcloud APIs](./apis_images/Files-api.png)
+
+## Usage of APIs within openDesk
+
+Following are APIs used by the Files application:
+
+| Used by          | Accessed component     | Service                | Purpose                                            | Message format |
+| ---------------- | ---------------------- | ---------------------- | -------------------------------------------------- | -------------- |
+| Nextcloud Server | Keycloak               | Authentication         | Single sign-on / sign-out                          | OIDC           |
+| Nextcloud Server | Nubus Portal           | Central Navigation     | Retrieve content for openDesk Navigation drop-down | JSON           |
+| Nextcloud Server | OX AppSuite Middleware | OX HTTP API (Contacts) | Reading/writing personal contacts                  | JSON           |
+| Nextcloud Server | Nubus                  | LDAP                   | Read users and groups data                         | LDAP           |
+
+## 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 |
+| Versioning                     | Identical with component release version                                                                                                                                                                                               |
+| Authentication                 | Basic Auth or by passing a set of valid session cookies                                                                                                                                                                                |
+| In openDesk provided by        | Nextcloud Server                                                                                                                                                                                                                       |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                                                |
+| Usage within component         | none                                                                                                                                                                                                                                   |
+| Usage within openDesk          | Filepicker is using the API to create share links.                                                                                                                                                                                     |
+| Usage for external integration | none                                                                                                                                                                                                                                   |
+| Parallel access                | Allowed                                                                                                                                                                                                                                |
+| Message protocol               | Requests in JSON, responses in JSON or XML                                                                                                                                                                                             |
+| Supported standards            |                                                                                                                                                                                                                                        |
+| Documentation                  | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/index.html                                                                                                                                                   |
+
+## Notifications API
+
+| Name                           | Notifications API                                                                                                           |
+| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Fetch notifications                                                                                                         |
+| Versioning                     | See linked documentation (which also names the version), address via URL path, e.g. `/ocs/v2.php/apps/notifications/api/v2` |
+| Authentication                 |                                                                                                                             |
+| In openDesk provided by        | Nextcloud Server                                                                                                            |
+| Transport protocol             | HTTP(S)                                                                                                                     |
+| Usage within component         | none                                                                                                                        |
+| Usage within openDesk          | none                                                                                                                        |
+| Usage for external integration | none                                                                                                                        |
+| Parallel access                | Allowed                                                                                                                     |
+| Message protocol               | Requests in JSON, responses in JSON or XML                                                                                  |
+| Supported standards            |                                                                                                                             |
+| Documentation                  | https://github.com/nextcloud/notifications/blob/master/docs/ocs-endpoint-v2.md                                              |
+|                                |                                                                                                                             |
+
+## 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) |
+| Versioning                     | Identical with 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`                                 |
+| In openDesk provided by        | Nextcloud Server                                                                                                                                       |
+| Transport protocol             | HTTP(S)                                                                                                                                                |
+| Usage within component         | none                                                                                                                                                   |
+| Usage within openDesk          | none                                                                                                                                                   |
+| Usage for external integration | none                                                                                                                                                   |
+| Parallel access                | Allowed                                                                                                                                                |
+| Message protocol               | Requests in JSON, responses in JSON or XML                                                                                                             |
+| Supported standards            |                                                                                                                                                        |
+| Documentation                  | https://github.com/nextcloud/activity/blob/master/docs/endpoint-v2.md                                                                                  |
+
+## Remote wipe API
+
+| Name                           | Remote wipe API                                                                             |
+| ------------------------------ | ------------------------------------------------------------------------------------------- |
+| Purpose                        | Used to wipe storage remotely (e.g. on a lost device)                                       |
+| Versioning                     | Identical with component release version                                                    |
+| Authentication                 | Login flow token                                                                            |
+| In openDesk provided by        | Nextcloud Server                                                                            |
+| Transport protocol             | HTTP(S)                                                                                     |
+| Usage within component         | none                                                                                        |
+| Usage within openDesk          | none                                                                                        |
+| Usage for external integration | none                                                                                        |
+| Parallel access                | Allowed                                                                                     |
+| Message protocol               | JSON                                                                                        |
+| Supported standards            |                                                                                             |
+| Documentation                  | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/RemoteWipe/index.html |
+
+## WebDAV
+
+| Name                           | WebDAV                                                                                  |
+| ------------------------------ | --------------------------------------------------------------------------------------- |
+| Purpose                        | Accessing files and folders, conducting search                                          |
+| Versioning                     | Identical with component release version                                                |
+| Authentication                 | Basic Auth or by passing a set of valid session cookies                                 |
+| In openDesk provided by        | Nextcloud Server                                                                        |
+| Transport protocol             | HTTP(S)                                                                                 |
+| Usage within component         | none                                                                                    |
+| Usage within openDesk          | Used by OX AppSuite to put/retrieve files (attachments)                                 |
+| Usage for external integration | none                                                                                    |
+| Parallel access                | Allowed                                                                                 |
+| Message protocol               | Requests in JSON, responses in JSON or XML                                              |
+| Supported standards            | RFC4918                                                                                 |
+| Documentation                  | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/index.html |
+
+## CalDAV / CardDAV
+
+CalDAV and CardDAV APIs are available in Nextcloud, but as openDesk uses OX AppSuite for Calendar and Contacts these Nextcloud APIs do not provide relevant data in openDesk.
+
+# Weboffice - Collabora
+
+Following are APIs used by the Weboffice application:
+
+| Used by   | Accessed component | Service           | Purpose                                     | Message format |
+| --------- | ------------------ | ----------------- | ------------------------------------------- | -------------- |
+| Collabora | Nextcloud          | Document handling | Retrieve, store and manage office documents | WOPI           |
+
+Collabora is integrated with Nextcloud to read/write Office documents from/to Nextcloud. The integration uses the Web
+Application Open Interface ([WOPI](https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b)) protocol.
+
+Nextcloud acts as the WOPI server whereas Collabora Online is the WOPI client.
+
+```mermaid
+sequenceDiagram
+    autonumber
+    Browser->>Nextcloud: Open document "digital-strategy.odt"<br>(which is fileid=123456)
+    Nextcloud-->>Browser: "Use COOL server to open document online<br>URL is https://office.domain.tld/?open"
+    Browser->>Collabora: GET "https://office.domain.tld/?open&file=https://files.domain.tld/index.php/apps/richdocuments/wopi/files/123456"
+    Collabora-->>Nextcloud: GET https://files.domain.tld/index.php/apps/richdocuments/wopi/files
+    Nextcloud-->>Browser: Edit document "digital-strategy.odt" (fileid=123456)
+```
+
+
+## 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 |
+| 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.    |
+| In openDesk provided by        | Collabora                                                                                                                                       |
+| Transport protocol             | HTTP                                                                                                                                            |
+| 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 for external integration | In openDesk Collabora Online is integrated with Nextcloud but other integrations exist and are possible, see the documentation.                 |
+| Parallel access                | Allowed                                                                                                                                         |
+| Message protocol               | JSON                                                                                                                                            |
+| Supported standards            | [WOPI](https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b)                               |
+| Documentation                  | https://sdk.collaboraonline.com/docs/postmessage_api.html                                                                                       |
+
+## Conversion API
+
+| Name                           | Conversion API                                                                                          |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Convert files between various file formats (e.g. to pdf, png, txt, or between OOXML and ODF etc.)       |
+| Versioning                     | N/A                                                                                                     |
+| Authentication                 | The `convert-to` endpoint is restricted to allowed host addresses that can be set in the configuration. |
+| In openDesk provided by        | Collabora                                                                                               |
+| Transport protocol             | HTTP (REST API)                                                                                         |
+| Usage within component         | N/A                                                                                                     |
+| 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.                      |
+| Parallel access                | Allowed                                                                                                 |
+| Message protocol               | text based, see the documentation                                                                                                        |
+| Supported standards            | N/A                                                                                                     |
+| Documentation                  | https://sdk.collaboraonline.com/docs/conversion_api.html                                                |
+
+# Project management - OpenProject
+
+Following are APIs used by the Project management application:
+
+| Used by         | Accessed component | Service            | Purpose                                            | Message format |
+| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
+| OpenProject-web | Keycloak           | Authentication     | Single sign-on / sign-out                          | OIDC           |
+| OpenProject-web | Nubus Portal       | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON           |
+| OpenProject-web | Nextcloud          | Various            | Integration of Nextcloud as OpenProject filestore  | JSON           |
+| OpenProject-web | Nubus              | LDAP               | Read users and groups data                         | LDAP           |
+
+## HATEOAS API
+
+| Name                           | HATEOAS (Hyperimages as the Engine of Application State) API                                                                                                                                                                                                                                                                                      |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Provides access for the frontend client of OpenProject and for third party use, i.e.:<br>- CRUD work packages, projects, time logging, users, queries (work package filters), and all related objects<br>- READ notifications, activities per work package<br>- READ capabilities (allowed actions of users throughout projects) does not address |
+| Versioning                     | URL based versioning scheme, e.g. `/api/v3/spec.json`                                                                                                                                                                                                                                                                                             |
+| Authentication                 | OAuth2, session based authentication, and basic auth                                                                                                                                                                                                                                                                                              |
+| In openDesk provided by        | OpenProject                                                                                                                                                                                                                                                                                                                                       |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                                                                                                                                                           |
+| Usage within component         | OpenProject Web-UI                                                                                                                                                                                                                                                                                                                                |
+| Usage within openDesk          | none                                                                                                                                                                                                                                                                                                                                              |
+| Usage for external integration | none                                                                                                                                                                                                                                                                                                                                              |
+| Parallel access                | Allowed                                                                                                                                                                                                                                                                                                                                           |
+| Message protocol               | [HAL](https://en.wikipedia.org/wiki/Hypertext_Application_Language) + JSON                                                                                                                                                                                                                                                                        |
+| Supported standards            | REST, [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS)                                                                                                                                                                                                                                                                                            |
+| Documentation                  | https://www.openproject.org/docs/api/introduction/                                                                                                                                                                                                                                                                                                |
+
+**Additional Information:**
+
+*What does it not do that developers should know about?*
+- CRUD custom fields, time reports, wikis and wiki pages
+- Aggregated filterable activities/changes
+
+*What are the typical use cases?*
+- It powers all angular frontend components in OpenProject, mainly the work package table/view, boards, team planner etc., and supports all common use cases
+
+*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 contains action links depending on the user’s permissions, allows to derive allowed actions from object keys in json
+
+*What knowledge prerequisites for the developer before using the API?*
+- Knowledge of REST
+- (Optional) Knowledge of HAL standard
+
+*Any extensions or APIs in development or in planning users should know about?*
+- Signaling to receive only selected attributes/nested resources from the API for performance improvements
+
+## 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 |
+| Versioning                     | URL based versioning scheme, e.g. `/api/bcf/2.1`                                                                                                                                   |
+| Authentication                 | OAuth2                                                                                                                                                                             |
+| In openDesk provided by        | OpenProject                                                                                                                                                                        |
+| Transport protocol             | HTTP(S)                                                                                                                                                                            |
+| Usage within component         | none                                                                                                                                                                               |
+| Usage within openDesk          | none                                                                                                                                                                               |
+| Usage for external integration | none                                                                                                                                                                               |
+| Parallel access                | Allowed                                                                                                                                                                            |
+| Message protocol               | JSON                                                                                                                                                                               |
+| Supported standards            | [BCF 2.1](https://github.com/buildingSMART/BCF-API/blob/release_2_1/README.md)                                                                                                     |
+| Documentation                  | https://www.openproject.org/docs/api/bcf-rest-api/                                                                                                                                 |
+
+# Video Conferencing - Jitsi
+
+## IFrame API
+
+| Name                           | IFrame API                                                             |
+| ------------------------------ | ---------------------------------------------------------------------- |
+| Purpose                        | Embed Jitsi video conferencing features into existing application/site |
+| Versioning                     | Identical to the Jitsi release version                                 |
+| Authentication                 | Optional (JWT-based authentication in openDesk context)                |
+| In openDesk provided by        | Jitsi-Web                                                              |
+| Transport protocol             | HTTP(S)                                                                |
+| Usage within component         | none                                                                   |
+| Usage within openDesk          | Used by Element (Chat Web-UI)                                          |
+| Usage for external integration | none                                                                   |
+| Parallel access                | Allowed                                                                |
+| Message protocol               |                                                                        |
+| Supported standards            |                                                                        |
+| Documentation                  | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe/      |
+
+## lib-jitsi-meet API
+
+| Name                           | lib-jitsi-meet API                                                     |
+| ------------------------------ | ---------------------------------------------------------------------- |
+| Purpose                        | Create Jitsi video conferences with a custom GUI                       |
+| Versioning                     | Identical to the Jitsi release                                         |
+| Authentication                 | not required                                                           |
+| In openDesk provided by        | Jitsi-Web                                                              |
+| Transport protocol             | none (it works as a library)                                           |
+| Usage within component         | Used by Jitsi itself                                                   |
+| Usage within openDesk          | Used by Jitsi itself                                                   |
+| Usage for external integration | none                                                                   |
+| Parallel access                | Allowed                                                                |
+| Message protocol               |                                                                        |
+| Supported standards            |                                                                        |
+| Documentation                  | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm-api/     |
+
+## Jitsi Meet React SDK
+
+> **Note**<br>
+> Additional SDKs can be found at https://jitsi.github.io/handbook/docs/category/sdks/
+
+| Name                           | Meet React SDK                                                      |
+| ------------------------------ | ------------------------------------------------------------------- |
+| Purpose                        | Embed Jitsi video conferencing into apps using React                |
+| Versioning                     | https://github.com/jitsi/jitsi-meet-react-sdk/releases              |
+| Authentication                 | not required                                                        |
+| In openDesk provided by        | Jitsi                                                               |
+| Transport protocol             | none (it works as a module)                                         |
+| Usage within component         | none                                                                |
+| Usage within openDesk          | none                                                                |
+| Usage for external integration | none                                                                |
+| Parallel access                | Allowed                                                             |
+| Message protocol               |                                                                     |
+| Supported standards            |                                                                     |
+| Documentation                  | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-react-sdk |
+
+# Chat - Element
+
+While Jitsi is available as standalone videoconferencing in openDesk, it is also used in [Element as videoconferencing backend](https://github.com/element-hq/element-web/blob/develop/docs/jitsi.md).
+
+```mermaid
+---
+  config:
+    class:
+      hideEmptyMembersBox: true
+---
+classDiagram
+    class CommunicationService["Communication Service"] {
+        <<interface>>
+    }
+
+    class MxChat["Element Matrix Chat"] {
+        <<interface>>
+    }
+    class JitsiVideoConference["Jitsi Video Conference"] {
+        <<interface>>
+    }
+
+    CommunicationService <|.. MxChat
+    CommunicationService <|.. JitsiVideoConference
+    MxChat <-- JitsiVideoConference
+
+    class MxAppServiceApi["Matrix Application Service API"]
+    class MxClientServerApi["Matrix Client Server API"]
+    class MxServerServerApi["Matrix Server Server API"]
+    class MxPushGatewayApi["Matrix Push Gateway API"]
+    class MxIdentityServiceApi["Matrix Identity Service API"]
+    class MxRtc["Matrix RTC"]
+    class MxElementWebModuleApi["Matrix React SDK Module API"]
+    class MxWidgetApi["Matrix Widget API"]
+    class NeoBoardDataModelApi["NeoBoard Data Model API"]
+    class NeoDateFixRestApi["NeoDateFix REST API"]
+
+    MxChat *-- MxAppServiceApi
+    MxChat *-- MxClientServerApi
+    MxChat *-- MxServerServerApi
+    MxChat *-- MxPushGatewayApi
+    MxChat *-- MxIdentityServiceApi
+    MxChat *-- MxRtc
+    MxChat *-- MxElementWebModuleApi
+    MxChat *-- MxWidgetApi
+
+    class JitsiIframeApi["Jitsi iFrame API"]
+    class JitsiMeetApi["Jitsi Meet API"]
+    class JitsiMeetReactSdk["Jitsi Meet React SDK"]
+
+    JitsiVideoConference *-- JitsiIframeApi
+    JitsiVideoConference *-- JitsiMeetApi
+    JitsiVideoConference *-- JitsiMeetReactSdk
+```
+
+Following are APIs used by the Chat application:
+
+| Used by         | Accessed component | Service            | Purpose                                            | Message format |
+| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
+| Element/Synapse | Keycloak           | Authentication     | Single sign-on / sign-out                          | OIDC           |
+| OpenProject-web | Intercom Service   | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON           |
+
+## Matrix Application Service API
+
+| Name                           | Matrix Application Service API                                                                                                               |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Implementation of custom server-side behavior in Matrix (e.g. gateways, filters, extensible hooks)                                           |
+| Versioning                     | URL based with version bumps on breaking changes (e.g. `/_matrix/app/v1`)                                                                    |
+| Authentication                 | HTTP-Authorization header with Bearer token                                                                                                  |
+| In openDesk provided by        | Synapse                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                      |
+| Usage within component         | none                                                                                                                                         |
+| Usage within openDesk          | Nordeck Widgets                                                                                                                              |
+| Usage for external integration | none                                                                                                                                         |
+| Parallel access                | Allowed                                                                                                                                      |
+| Message protocol               | JSON                                                                                                                                         |
+| Supported standards            | [Matrix](https://spec.matrix.org/latest/application-service-api/)                                                                            |
+| Documentation                  | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
+
+## Matrix Client-Server API
+
+| Name                           | Matrix Client-Server API                                                                                                                     |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Send messages, control rooms and synchronize conversation history, JSON objects over HTTP                                                    |
+| Versioning                     | URL based with version bumps on breaking changes (e.g. `/_matrix/client/v3`)                                                                 |
+| Authentication                 | HTTP-Authorization header with Bearer token                                                                                                  |
+| In openDesk provided by        | Synapse                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                      |
+| Usage within component         | none                                                                                                                                         |
+| Usage within openDesk          | Used by Element (Chat Web-UI)                                                                                                                |
+| Usage for external integration | none                                                                                                                                         |
+| Parallel access                | Allowed                                                                                                                                      |
+| Message protocol               | JSON                                                                                                                                         |
+| Supported standards            | [Matrix](https://spec.matrix.org/latest/client-server-api/)                                                                                  |
+| Documentation                  | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
+
+## Matrix Server-Server API
+
+| Name                           | Matrix Server-Server API                                                                                                                     |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Communication between Matrix server (also known as FederationAPIs)                                                                           |
+| Versioning                     | URL based with version bumps on breaking changes (e.g. `/_matrix/federation/v2`)                                                             |
+| Authentication                 | HTTP-Authorization header with Bearer token                                                                                                  |
+| In openDesk provided by        | Synapse                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                      |
+| Usage within component         | none                                                                                                                                         |
+| Usage within openDesk          | none                                                                                                                                         |
+| Usage for external integration | Used when federation with other Matrix instances is enabled                                                                                  |
+| Parallel access                | Allowed                                                                                                                                      |
+| Message protocol               | JSON                                                                                                                                         |
+| Supported standards            | [Matrix](https://spec.matrix.org/latest/client-server-api/)                                                                                  |
+| Documentation                  | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
+
+## Matrix Push Gateway API
+
+| Name                           | Matrix Push Gateway API                                                                                                                      |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Distribute notifications from the homeserver to clients (push)                                                                               |
+| Versioning                     | URL based with version bumps on breaking changes (e.g. `/_matrix/push/v2`)                                                                   |
+| Authentication                 |                                                                                                                                              |
+| In openDesk provided by        | Synapse                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                      |
+| Usage within component         | none                                                                                                                                         |
+| Usage within openDesk          | Used by Element (Chat Web-UI)                                                                                                                |
+| Usage for external integration | none                                                                                                                                         |
+| Parallel access                | Allowed                                                                                                                                      |
+| Message protocol               | JSON                                                                                                                                         |
+| Supported standards            | [Matrix](https://spec.matrix.org/latest/push-gateway-api/)                                                                                   |
+| Documentation                  | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
+
+## Matrix Identity Service API
+
+| Name                           | Matrix Identity Service API                                                                                                                  |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Validate, store, and answer questions about the identities of users                                                                          |
+| Versioning                     | URL based with version bumps on breaking changes (e.g. `/_matrix/identity/v2`)                                                               |
+| Authentication                 | HTTP-Authorization header with Bearer token                                                                                                  |
+| In openDesk provided by        | Synapse                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                      |
+| Usage within component         | none                                                                                                                                         |
+| Usage within openDesk          |                                                                                                                                              |
+| Usage for external integration | none                                                                                                                                         |
+| Parallel access                | Allowed                                                                                                                                      |
+| Message protocol               | JSON                                                                                                                                         |
+| Supported standards            | [Matrix](https://spec.matrix.org/latest/identity-service-api/)                                                                               |
+| Documentation                  | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
+
+## Matrix React SDK Module API
+
+| Name                           | Matrix React SDK Module API                                                                                                                                                                                                        |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | The module system in Element Web is a way to add or modify functionality of Element Web itself, bundled at compile time for the app.                                                                                               |
+| Versioning                     | [Releases in the Git repository](https://github.com/matrix-org/matrix-react-sdk-module-api/releases); [Dependency in `package.json` in Element (Chat Web-UI)](https://github.com/element-hq/element-web/blob/develop/package.json) |
+| Authentication                 | n/a - used as a library                                                                                                                                                                                                            |
+| In openDesk provided by        | Element (Chat Web-UI)                                                                                                                                                                                                              |
+| Transport protocol             | n/a - used as a library                                                                                                                                                                                                            |
+| Usage within component         | [Element (Chat-Web-UI) Modules](https://github.com/nordeck/element-web-modules/)                                                                                                                                                   |
+| Usage within openDesk          | none                                                                                                                                                                                                                               |
+| Usage for external integration | n/a - uses as a library                                                                                                                                                                                                            |
+| Parallel access                | Allowed                                                                                                                                                                                                                            |
+| Message protocol               | n/a - used as a library                                                                                                                                                                                                            |
+| Supported standards            | n/a - Element (Chat Web-UI) specific                                                                                                                                                                                               |
+| Documentation                  | [Element (Chat Web-UI) Documentation](https://github.com/element-hq/element-web/blob/develop/docs/modules.md); [matrix-react-sdk-module-api Git repository](https://github.com/matrix-org/matrix-react-sdk-module-api)             |
+
+## Matrix Widget API
+
+| Name                           | Matrix Widget API                                                                                                                                                                                                    |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Matrix Widgets are HTML and Javascript content / applications that can be embedded within, and communicate with Matrix clients.                                                                                      |
+| Versioning                     | n/a                                                                                                                                                                                                                  |
+| Authentication                 | Widgets request capabilities. They must be confirmed by a user or by the [Widget Lifecycle Module](https://github.com/nordeck/element-web-modules/blob/main/packages/element-web-widget-lifecycle-module/README.md). |
+| In openDesk provided by        | Element (Chat Web-UI)                                                                                                                                                                                                |
+| Transport protocol             | [HTML window.postMessage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)                                                                                                                   |
+| Usage within component         | [NeoDateFix](https://github.com/nordeck/matrix-meetings/), [NeoBoard](https://github.com/nordeck/matrix-neoboard), [NeoChoice](https://github.com/nordeck/matrix-poll)                                                                                                    |
+| Usage within openDesk          | none                                                                                                                                                                                                                 |
+| Usage for external integration | none                                                                                                                                                                                                                 |
+| Parallel access                | Allowed                                                                                                                                                                                                              |
+| Message protocol               | JSON                                                                                                                                                                                                                 |
+| Supported standards            | [Matrix - MSC2764](https://github.com/matrix-org/matrix-spec-proposals/pull/2764)                                                                                                                                    |
+| Documentation                  | [Matrix - MSC2764](https://github.com/matrix-org/matrix-spec-proposals/pull/2764)                                                                                                                                    |
+
+## NeoBoard Data Model API
+
+| Name                           | NeoBoard Data Model API                                                                                                               |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | The NeoBoard data model can be used to generate whiteboard documents.                                                                 |
+| Versioning                     | `version` field in the [NeoBoard data model](https://github.com/nordeck/matrix-neoboard/blob/main/docs/model/export-format.md#fields) |
+| Authentication                 | n/a                                                                                                                                   |
+| In openDesk provided by        | [NeoBoard](https://github.com/nordeck/matrix-neoboard)                                                                                |
+| Transport protocol             | n/a                                                                                                                                   |
+| Usage within component         | [NeoBoard](https://github.com/nordeck/matrix-neoboard)                                                                                |
+| Usage within openDesk          | none                                                                                                                                  |
+| Usage for external integration | none                                                                                                                                  |
+| Parallel access                | n/a                                                                                                                                   |
+| Message protocol               | JSON                                                                                                                                  |
+| Supported standards            | n/a                                                                                                                                   |
+| Documentation                  | [NeoBoard data model](https://github.com/nordeck/matrix-neoboard/tree/main/docs/model)                                                |
+
+## NeoDateFix REST API
+
+| Name                           | NeoDateFix REST API                                                                                                                                |
+| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Can be used to query and set up NeoDateFix Matrix meetings.                                                                                        |
+| Versioning                     | Path segment in the [Meetings Bot API](https://github.com/nordeck/matrix-meetings/blob/main/docs/data-model.md#http-api)                           |
+| Authentication                 | n/a                                                                                                                                                |
+| In openDesk provided by        | [NeoDateFix](https://github.com/nordeck/matrix-meetings)                                                                                           |
+| Transport protocol             | HTTP(S)                                                                                                                                            |
+| Usage within component         | [NeoDateFix](https://github.com/nordeck/matrix-meetings)                                                                                           |
+| Usage within openDesk          | Used by OX to sync calendar entries to NeoDateFix                                                                                                  |
+| Usage for external integration | none                                                                                                                                               |
+| Parallel access                | n/a                                                                                                                                                |
+| Message protocol               | JSON                                                                                                                                               |
+| Supported standards            | n/a                                                                                                                                                |
+| Documentation                  | [NeoDateFix ADR001](https://github.com/nordeck/matrix-meetings/blob/main/docs/adrs/adr001-use-the-widget-api-to-interact-with-the-meetings-bot.md) |
+
+# Knowledge management - XWiki
+
+Following are APIs used by the Knowledge management application:
+
+| Used by | Accessed component | Service            | Purpose                                            | Message format |
+| ------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
+| Xwiki   | Keycloak           | Authentication     | Single sign-on / sign-out                          | OIDC           |
+| Xwiki   | Nubus Portal       | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON           |
+| Xwiki   | Nubus              | LDAP               | Read users and groups data                         | LDAP           |
+
+## REST API
+
+| Name                           | REST API                                                                                                                                                                                                                                                   |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Purpose                        | Perform low level action, e.g. interact with XWiki stored data                                                                                                                                                                                             |
+| Versioning                     |                                                                                                                                                                                                                                                            |
+| Authentication                 | Anonymous or username/password on each request (stateless)                                                                                                                                                                                                 |
+| In openDesk provided by        | XWiki                                                                                                                                                                                                                                                      |
+| Transport protocol             | HTTP(S)                                                                                                                                                                                                                                                    |
+| Usage within component         |                                                                                                                                                                                                                                                            |
+| Usage within openDesk          | none                                                                                                                                                                                                                                                       |
+| Usage for external integration | none                                                                                                                                                                                                                                                       |
+| Parallel access                | Allowed                                                                                                                                                                                                                                                    |
+| Message protocol               | JSON/XML                                                                                                                                                                                                                                                   |
+| Supported standards            |                                                                                                                                                                                                                                                            |
+| Documentation                  | - https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiRESTfulAPI<br>- https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd |
+
+## Scripting API
+
+| Name                           | 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 Java API |
+| Versioning                     |                                                                                                                                                                               |
+| Authentication                 | Executed in context of (authenticated) user or anonymous - permissions (scripting rights, programming rights) of that context apply                                           |
+| In openDesk provided by        | XWiki                                                                                                                                                                         |
+| Transport protocol             |                                                                                                                                                                               |
+| Usage within component         |                                                                                                                                                                               |
+| Usage within openDesk          | none                                                                                                                                                                          |
+| Usage for external integration | Not supported                                                                                                                                                                 |
+| Parallel access                | Allowed                                                                                                                                                                       |
+| Message protocol               |                                                                                                                                                                               |
+| Supported standards            |                                                                                                                                                                               |
+| Documentation                  | https://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting%20Documentation%20Application                                                                                 |
+
+## Java API
+
+| Name                           | 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 Scripting API |
+| Versioning                     |                                                                                                                                                                                    |
+| Authentication                 | Executed in context of (authenticated) user or anonymous - but without the permission check (in opposite to the Scripting API)                                                     |
+| In openDesk provided by        | XWiki                                                                                                                                                                              |
+| Transport protocol             |                                                                                                                                                                                    |
+| Usage within component         |                                                                                                                                                                                    |
+| Usage within openDesk          | none                                                                                                                                                                               |
+| Usage for external integration | none                                                                                                                                                                               |
+| Parallel access                | Allowed                                                                                                                                                                            |
+| Message protocol               |                                                                                                                                                                                    |
+| Supported standards            |                                                                                                                                                                                    |
+| Documentation                  | https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/API/                                                                                                                   |
+
+## JavaScript API
+
+| Name                           | JavaScript API                                                                               |
+| ------------------------------ | -------------------------------------------------------------------------------------------- |
+| Purpose                        | Include dynamic components in XWiki/web pages                                                |
+| Versioning                     |                                                                                              |
+| Authentication                 | Executed in context of (authenticated) user or anonymous                                     |
+| In openDesk provided by        | Jitsi                                                                                        |
+| Transport protocol             |                                                                                              |
+| Usage within component         |                                                                                              |
+| Usage within openDesk          | none                                                                                         |
+| Usage for external integration | none                                                                                         |
+| Parallel access                | Allowed                                                                                      |
+| Message protocol               |                                                                                              |
+| Supported standards            |                                                                                              |
+| Documentation                  | https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/FrontendResources/JavaScriptAPI/ |

docs/ci.md

@@ -0,0 +1,39 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>CI/CD</h1>
+
+This page covers openDesk deployment automation via Gitlab CI.
+
+<!-- TOC -->
+* [Deployment](#deployment)
+* [Tests](#tests)
+<!-- TOC -->
+
+# Deployment
+
+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:
+
+- `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`.
+- `MATRIX_DOMAIN` (optional): The domain for the users' Matrix IDs; it defaults to `DOMAIN`.
+- `NAMESPACE`: Namespace of your K8s cluster openDesk will be installed.
+- `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`.
+
+# Tests
+
+The GitLab CI pipeline contains a job named `run-tests` that can trigger a test suite pipeline on another GitLab project.
+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:
+`<domain of gitlab>/api/v4/projects/<id>`.
+To select the current test set, 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
+`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.

docs/data-storage.md

@@ -0,0 +1,117 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Application Data Storages</h1>
+
+To provide a feasible backup and restore concept, a thorough overview of all openDesk
+applications and their related data storages (ephemeral & persistent) is provided in the
+following subsection.
+
+<!-- TOC -->
+* [Overview](#overview)
+* [Details](#details)
+<!-- TOC -->
+
+# Overview
+
+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
+application refer to the table show in Section [Details](#details)
+
+```mermaid
+---
+config:
+  sankey:
+    showValues: false
+    linkColor: target
+---
+sankey-beta
+
+ClamAV,PersistentVolume,1
+
+Dovecot,PersistentVolume,1
+
+Element/Synapse,PostgreSQL,1
+Element/Synapse,PersistentVolume,1
+
+Intercom-Service,Redis,1
+
+Jitsi,PersistentVolume,1
+
+Nextcloud,MariaDB,1
+Nextcloud,S3,1
+Nextcloud,Redis,1
+
+Nubus,PostgreSQL,1
+Nubus,S3,1
+Nubus,PersistentVolume,1
+Nubus,Memcached,1
+
+OpenProject,PostgreSQL,1
+OpenProject,S3,1
+OpenProject,PersistentVolume,1
+OpenProject,Memcached,1
+
+Open-Xchange,MariaDB,1
+Open-Xchange,PersistentVolume,1
+Open-Xchange,Redis,1
+
+Postfix,PersistentVolume,1
+
+XWiki,MariaDB,1
+XWiki,PersistentVolume,1
+```
+
+# Details
+
+| Application          | Data Storage | Backup   | Content                                                                                    | Identifier                                     | Details                                               |
+| -------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------- | ----------------------------------------------------- |
+| **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`                                           |
+| **Element/Synapse**  | PostgreSQL   | Yes      | Application's main database                                                                | `matrix`                                       |                                                       |
+|                      | PVC          | Yes      | Attachments                                                                                | `media-opendesk-synapse-0`                     | `/media`                                              |
+|                      |              | Yes      | Sync and state data                                                                        | `matrix-neodatefix-bot`                        | `/app/storage`                                        |
+| **Intercom-Service** | Redis        | No       | Shared session 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`                                    |                                                       |
+|                      | S3           | Yes      | The Nextcloud managed user files                                                           | `nextcloud`                                    |                                                       |
+|                      | Redis        | No       | Distributed caching, as well as transactional file locking                                 |                                                |                                                       |
+| **Nubus**            | PostgreSQL   | Yes      | Main database for Nubus' IdP Keycloak                                                      | `keycloak`                                     |                                                       |
+|                      |              | Yes      | Login actions and device-fingerprints                                                      | `keycloak_extensions`                          |                                                       |
+|                      |              | Optional | Store of the temporary password reset token                                                | `selfservice`                                  |                                                       |
+|                      |              | No       | Notification features are not used in openDesk 1.1                                         | `notificationsapi`                             |                                                       |
+|                      |              | No       | Guardian features are currently not used in openDesk 1.1                                   | `guardianmanagementapi`                        |                                                       |
+|                      | S3           | No       | Static files for Portal                                                                    | `ums`                                          |                                                       |
+|                      | PVC          | Yes      | openLDAP database (primary R/W Pods), when restore select the one from the leader          | `shared-data-ums-ldap-server-primary-0`        | `/var/lib/univention-ldap`                            |
+|                      |              | 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 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                  |
+|                      |              | 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`                                               |
+|                      | Memcached    | No       | Cache for UMC Server                                                                       |                                                |                                                       |
+| **OpenProject**      | PostgreSQL   | Yes      | Application's main database                                                                | `openproject`                                  |                                                       |
+|                      | S3           | Yes      | Attachments, custom styles                                                                 | `openproject`                                  |                                                       |
+|                      | Memcached    | No       | Cache                                                                                      |                                                |                                                       |
+|                      | PVC          | No       | PVC backed `emptyDir` as K8s cannot set the sticky bit on standard emptyDirs               | `openproject-<web/worker>-*-tmp`               | `/tmp`                                                |
+|                      |              | No       | PVC backed `emptyDir` as K8s cannot set the sticky bit on standard emptyDirs               | `openproject-<web/worker>-app-*-tmp`           | `/app/tmp`                                            |
+| **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      | OX Guard related settings                                                                  | `oxguard*`                                     |                                                       |
+|                      | 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`     |
+|                      |              | 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`                                  |
+| **XWiki**            | Database     | Yes      | Application's main database                                                                | `xwiki`                                        |                                                       |
+|                      | 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.
+
+| Service    | Pod              | Volume Name  | PVC                         | MountPath             |
+| ---------- | ---------------- | ------------ | --------------------------- | --------------------- |
+| MariaDB    | `mariadb-*`      | `data`       | `data-mariadb-0`            | `/var/lib/mysql`      |
+| 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`               |

docs/debugging.md

@@ -0,0 +1,216 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Debugging</h1>
+
+<!-- TOC -->
+* [Disclaimer](#disclaimer)
+* [Enable debugging](#enable-debugging)
+* [Adding containers to a pod for debugging purposes](#adding-containers-to-a-pod-for-debugging-purposes)
+  * [Adding a container to a pod/deployment - Dev/Test only](#adding-a-container-to-a-poddeployment---devtest-only)
+  * [Temporary/ephemeral containers](#temporaryephemeral-containers)
+* [Components](#components)
+  * [Helmfile](#helmfile)
+  * [MariaDB](#mariadb)
+  * [Nextcloud](#nextcloud)
+  * [OpenProject](#openproject)
+  * [PostgreSQL](#postgresql)
+  * [Keycloak](#keycloak)
+<!-- TOC -->
+
+# Disclaimer
+
+This document collects information on how to deal with debugging an openDesk deployment.
+
+It will be extended over time as we deal with debugging cases.
+
+We for sure do not want to reinvent the wheel, so we might link to external sources that contain helpful
+information where available.
+
+> **Warning**<br>
+> You should never enable the debug option in production environments! By looking up `debug.enabled` in the deployment, you
+will find the various places changes are applied when enabling debugging. So, outside of development and test
+environments, you should use them thoughtfully and carefully if needed.
+
+# Enable debugging
+
+Check the openDesk [`debug.yaml.gotmpl`](../helmfile/environments/default/debug.yaml.gotmpl) and set for your deployment
+```
+debug:
+  enabled: true
+```
+
+This will result in:
+- setting most component's log level to debug
+- making the Keycloak admin console available by default at `https://id.<your_domain>/admin/`
+- configured the ingress for `http://minio-console.<your_domain>`
+
+> **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.
+
+> **Note**<br>
+> All containers should write their log output to STDOUT; if you find (valuable) logs inside a container, please let us know!
+
+# Adding containers to a pod for debugging purposes
+
+During testing or development, you may need to execute tools, browse, or even change things in the filesystem of another container.
+
+This can be a challenge the more security-hardened the container images are because there are no debugging tools available, and sometimes, there is not even a shell.
+
+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.
+
+## 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/).
+
+- 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`.
+- Ensure the `shareProcessNamespace` option is enabled for the Pod.
+- 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.
+- Save & update the deployment.
+
+The following example can be used to debug the `openDesk-Nextcloud-PHP` container; if you want to modify files, remember to set `readOnlyRootFilesystem` to `true` on the PHP container.
+
+```yaml
+      shareProcessNamespace: true
+      containers:
+        - name: debugging
+          image: registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest
+          command: ["/bin/bash", "-c", "while true; do echo 'This is a temporary container for debugging'; sleep 5 ; done"]
+          securityContext:
+            capabilities:
+              drop:
+                - ALL
+            privileged: false
+            runAsUser: 65532
+            runAsGroup: 65532
+            runAsNonRoot: true
+            readOnlyRootFilesystem: false
+            allowPrivilegeEscalation: false
+            seccompProfile:
+              type: RuntimeDefault
+```
+
+- 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`.
+- 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
+
+An interesting read 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/).
+
+For the commands further down this section, we set some environment variables first:
+- `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.
+- `POD_NAME`: The name of the Pod you want to inspect within the pre-mentioned namespace.
+- `EPH_CONTAINER_NAME`: Choose the name for the container, and "debugging" seems obvious.
+- `DEBUG_IMAGE`: The image you want to use for debugging purposes.
+
+e.g.
+
+```shell
+export EPH_CONTAINER_NAME=debugging
+export NAMESPACE=my_test_deployment
+export DEPLOYMENT_NAME=opendesk-nextcloud-php
+export POD_NAME=opendesk-nextcloud-php-6686d47cfb-7642f
+export DEBUG_IMAGE=registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest
+```
+
+You still need to ensure that your deployment supports process namespace sharing:
+
+```shell
+kubectl -n ${NAMESPACE} patch deployment ${DEPLOYMENT_NAME} --patch '
+spec:
+  template:
+    spec:
+      shareProcessNamespace: true'
+```
+
+Now, you can add the ephemeral container with:
+```shell
+kubectl -n ${NAMESPACE} debug -it --attach=false -c ${EPH_CONTAINER_NAME} --image={DEBUG_IMAGE} ${POD_NAME}
+```
+and open its interactive terminal with
+```shell
+kubectl -n ${NAMESPACE} attach -it -c ${EPH_CONTAINER_NAME} ${POD_NAME}
+```
+
+# Components
+
+## Helmfile
+
+When refactoring the Helmfile structure you want to ensure that there are not unintended mistakes by e.g. `diff`
+comparing the output of Helmfile from before and after the change by calling:
+
+```shell
+helmfile template -e dev >output_to_compare.yaml
+```
+
+## 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.
+
+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:
+
+- `help`: Get help on the psql command set
+- `show databases`: Lists all databases
+- `use <databasename>`: Connect to `<databasename>`
+- `show tables`: Lists tables within the currently connected database
+- `quit`: Quit the client
+
+## Nextcloud
+
+`occ` is the CLI for Nextcloud; all the details can be found in the [upstream documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html).
+
+You can run occ commands in the `opendesk-nextcloud-php` pod like this: `php /var/www/html/occ config:list`
+
+## OpenProject
+
+OpenProject is a Ruby on Rails application. Therefore, you can make use of the Rails console from the Pod's command line `bundle exec rails console`
+and run debug code like this:
+
+```
+uri = URI('https://nextcloud.url/apps/integration_openproject/check-config')
+Net::HTTP.start(uri.host, uri.port,
+ :use_ssl => uri.scheme == 'https') do |http|
+ request = Net::HTTP::Get.new uri
+ response = http.request request # Net::HTTPResponse object
+end
+```
+
+## PostgreSQL
+
+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:
+
+- `\?`: Get help on the psql command set
+- `\l`: Lists all databases
+- `\c <databasename>`: Connect to `<databasename>`
+- `\dt`: List (describe) tables within the currently connected database
+- `\q`: Quit the client
+
+## Keycloak
+
+Keycloak is the gateway to integrate other authentication management systems or applications. It can be desired to
+avoid enabling debug mode for the whole platform when you just need to look into Keycloak.
+
+That can easily be achieved in two steps:
+
+1. Updating the value for `KC_LOG_LEVEL` in the related configmap `ums-keycloak`.
+```shell
+export NAMESPACE=<your_namespace>
+export CONFIGMAP_NAME=ums-keycloak
+kubectl patch -n ${NAMESPACE} configmap ${CONFIGMAP_NAME} --type merge -p '{"data":{"KC_LOG_LEVEL":"DEBUG"}}'
+```
+
+2. Restart the Keycloak Pod(s).
+
+> **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.

docs/development.md

@@ -0,0 +1,166 @@
+<!--
+SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Developing openDesk deployment automation</h1>
+
+Active development on the deployment is currently only available for project members.
+However, contributions are possible using the [CLA](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md?ref_type=heads) process.
+
+<!-- TOC -->
+* [Overview](#overview)
+* [Default branch, `develop` and other branches](#default-branch-develop-and-other-branches)
+* [External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`](#external-artifacts---chartsyamlgotmpl-and-imagesyamlgotmpl)
+  * [Linting](#linting)
+    * [Disable linting selectively](#disable-linting-selectively)
+  * [Renovate](#renovate)
+  * [Mirroring](#mirroring)
+    * [Get new artifacts mirrored](#get-new-artifacts-mirrored)
+* [Creating new charts/images](#creating-new-chartsimages)
+<!-- TOC -->
+
+# Overview
+
+The following sketch provides a high-level overview to get a basic understanding of the deployment-relevant
+structure of this repository. Understanding that structure is vital if you want to contribute to
+developing the openDesk platform.
+
+```mermaid
+flowchart TD
+ 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]
+ 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`]
+ A-->D[./helmfile/environments/default/*\nwith just some examples below]
+ D-->F[charts.yaml.gotmpl]
+ D-->G[images.yaml.gotmpl]
+ D-->H[global.*]
+ D-->I[secrets.yaml.gotmpl\nreplicas.yaml.gotmpl\nresources.yaml.gotmpl\n...]
+ A-->|overwrite defaults with your\ndeployment/environment specific values|E[./helmfile/environments/default/values.yaml.gotmpl]
+```
+
+The `helmfile.yaml.gotmpl` file in the root folder is the foundation
+for the entire deployment. It references the `helmfile_generic.yaml.gotmpl`
+file, which includes app-specific `helmfile.yaml.gotmpl` files and
+global values files located in `./environments/default`.
+
+`helmfile.yaml.gotmpl` also refers to three predefined environments: `dev`,
+`test`, and `prod`.
+
+The `helmfile_generic.yaml.gotmpl` file is designed to be referenced from
+external repositories, where custom environments may be defined. An
+example is demonstrated in the `helmfile.yaml.gotmpl` file.
+
+Before you investigate any app-specific configuration, it is recommended that you review the contents of `./helmfile/environments/default` to understand what configuration details are set there, as the app deployments reference them.
+
+# 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
+branch by default.
+
+Please use the `develop` branch to diverge your branch(es) from. See the [workflow guide](./workflow.md)
+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`
+
+The `charts.yaml.gotmpl` and `images.yaml.gotmpl` files are the central place to reference external artifacts used for the deployment.
+
+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.
+- **Renovate**: Automatically create MRs that update the components to their latest version.
+- **Mirror**: Mirror artifacts to Open CoDE.
+
+Please find details on these tools below.
+
+## Linting
+
+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
+- in a 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
+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.
+
+> **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
+with the many available examples in the yaml files.
+
+Example:
+```yaml
+ synapse:
+ # providerCategory: "Supplier"
+ # providerResponsible: "Element"
+ # upstreamRegistry: "https://registry-1.docker.io"
+ # upstreamRepository: "matrixdotorg/synapse"
+ # upstreamMirrorTagFilterRegEx: '^v(\d+)\.(\d+)\.(\d+)$'
+ # upstreamMirrorStartFrom: ["1", "91", "2"]
+ registry: "registry.opencode.de"
+ repository: "BMI/opendesk/components/supplier/element/images-mirror/synapse"
+ tag: "v1.91.2@sha256:1d19508db417bb2b911c8e086bd3dc3b719ee75c6f6194d58af59b4c32b11322"
+```
+
+### Disable linting selectively
+
+If you follow the "push early, push often" paradigm to save your work to the central Git instance, or you just fix a typo in
+existing documentation, you can avoid the CI and its linting being executed, as it might not offer additional value.
+
+GitLab offers two options to skip the CI on a commit/push:
+- Add `[ci skip]` to your commit message ([details](https://docs.gitlab.com/ee/ci/pipelines/#skip-a-pipeline)).
+**Note:** The string has to be removed before merging your feature branch into `develop`.
+- Use the related git push option `git push -o ci.skip` ([details](https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-gitlab-cicd)).
+
+## Renovate
+
+Uses a regular expression to match the values of the following attributes:
+
+- `# upstreamRegistry` *required*: Attribute's value must be prefixed with `https://` for Renovate.
+- `# upstreamRepository` *required*
+- `tag` *required*
+
+Checks for newer versions of the given artifact and creates an MR containing the newest version's tag (and digest).
+
+## Mirroring
+
+- See also: https://gitlab.opencode.de/bmi/opendesk/tooling/oci-pull-mirror
+
+> **Note:**<br>
+> 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
+configured to pull artifacts that do not originate from Open CoDE into projects called `*-Mirror` within the
+[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:
+- `# 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:
+  - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_USERNAME`
+  - `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_PASSWORD`
+- `# 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`.
+- `# 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
+ element here to define the version the mirror should start with.
+
+### Get new artifacts mirrored
+
+If you want new images or charts mirrored that are not yet included in one of the yaml files, you can add them in your branch, including the aforementioned mirror annotations, and ask somebody from the platform development team to trigger the mirror's CI based on your branch.
+
+Once your branch is merged into develop, your artifacts are mirrored hourly.
+
+# Creating new charts/images
+
+When you create new Helm charts, please check out the
+[openDesk Best Practices](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-best-practises)
+for Helm charts.
+
+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.
+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.

docs/enhanced-configuration.md

@@ -0,0 +1,17 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Enhanced configuration use cases for openDesk</h1>
+
+# Overview
+
+The following enhanced configuration use cases are described in separate documents.
+
+- [Separate mail & Matrix domain](./enhanced-configuration/separate-mail-matrix-domain.md)
+- [Federation with external identity provider](./enhanced-configuration/idp-federation.md)
+- [Matrix federation](./enhanced-configuration/matrix-federation.md)
+- [Groupware migration from M365 to openDesk](./enhanced-configuration/groupware-migration.md)
+- [Self-signed certificate and custom Certificate Authority (CA)](./enhanced-configuration/self-signed-certificates.md)
+- [GitOps deployments using Argo CD](./enhanced-configuration/gitops.md)

docs/enhanced-configuration/gitops.md

@@ -0,0 +1,60 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>GitOps Deployment</h1>
+
+<!-- TOC -->
+* [Considerations](#considerations)
+* [ArgoCD](#argocd)
+  * [Option 1: Use YAML manifests](#option-1-use-yaml-manifests)
+  * [Option 2: Helmfile plugin](#option-2-helmfile-plugin)
+<!-- TOC -->
+
+The recommended deployment method for openDesk is via Helmfile. This can be done "by hand", via CI/CD (Gitlab) or using
+the [GitOps](https://about.gitlab.com/topics/gitops/) approach with tools like [Argo CD](https://argoproj.github.io/cd/).
+
+This documentation will use Argo CD to explain how to deploy openDesk GitOps-style.
+
+# Considerations
+
+- openDesk consists of multiple applications which have to be deployed in order.
+- During upgrades, migrations have to run before and after applications.
+
+# ArgoCD
+
+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).
+
+There are two options to deploy openDesk via Argo CD described in the following sections.
+
+## Option 1: Use YAML manifests
+
+This option requires a preprocessing step before using Argo CD. This step requires you to compile the Helmfile based
+deployment into Kubernetes YAML manifest, to do so you need to execute the helmfile binary:
+
+```shell
+helmfile template > opendesk.yaml
+```
+
+References:
+- [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)
+
+Afterwards, you can use the resulting manifests within an standard Argo CD workflow.
+
+> **Note**<br>
+> 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.
+
+## Option 2: Helmfile plugin
+
+It is possible to deploy openDesk via Argo CD with community developed
+[Helmfile plugin](https://github.com/travisghansen/argo-cd-helmfile).
+
+You can find an example for this approach in the
+[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`)
+according to `app of apps pattern` and is using sync waves to ensure to required deployment and update sequence
+for openDesk is met.

docs/enhanced-configuration/groupware-migration.md

@@ -0,0 +1,184 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Migration from M365 with audriga migration service and master authentication</h1>
+
+<!-- TOC -->
+* [Prerequisites](#prerequisites)
+  * [Prepare M365 tenant for access](#prepare-m365-tenant-for-access)
+  * [Provisioning user accounts in openDesk](#provisioning-user-accounts-in-opendesk)
+  * [Deploy openDesk with master authentication](#deploy-opendesk-with-master-authentication)
+* [Migration configuration](#migration-configuration)
+  * [Select the source provider and configure your openDesk instance](#select-the-source-provider-and-configure-your-opendesk-instance)
+  * [Adding accounts](#adding-accounts)
+    * [Add user accounts individually](#add-user-accounts-individually)
+    * [Add multiple user accounts via CSV file](#add-multiple-user-accounts-via-csv-file)
+  * [Start the migration](#start-the-migration)
+  * [Monitor migration status](#monitor-migration-status)
+<!-- 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.
+
+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 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).
+
+# Prerequisites
+
+## Prepare M365 tenant for access
+
+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:
+
+***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).
+
+> **Notes**<br>
+> 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***
+
+To register the audriga app in your tenant, log into your admin account and access the following URL:
+
+ 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"
+- You will be redirected to an audriga page, which you can close without requiring additional interaction.
+
+> **Note**<br>
+> The audriga application is created under the "Enterprise application" tab in the AzureAD console.
+
+***3. Create a "secret" group in the M365 tenant***
+
+Create a "secret" group in the customer tenant.
+
+- Go to <https://aad.portal.azure.com> > Azure Active Directory > Groups > New Group
+- Choose a group name and group email address that includes the word "audriga" in lowercase ("Audriga" will not work), like *audriga-migration@your-maildomain.tld*
+- Choose the group type "Microsoft 365"
+- Appoint your service account (see 1.) as the owner of this group
+
+
+## Provisioning user accounts in openDesk
+
+In openDesk, you have to have all user accounts with mailboxes pre-defined before running the migration. You can either manually create your accounts using an IAM administrator or use the [user import tool](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import) to batch import user accounts to your openDesk deployment.
+
+## 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:
+
+```
+secrets:
+  oxAppSuite:
+    adminPassword: "your_temporary_master_password"
+functional:
+  migration:
+    oxAppSuite:
+      enabled: true
+```
+
+1. You must specify the master password referenced in the document's following sections.
+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.
+
+> **Note**<br>
+> For the changes to take effect, it is sufficient to deploy the `open-xchange` component.
+
+> **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.
+
+# Migration configuration
+
+The migration is configured in 3 steps using the [audriga migration self-service](https://umzug.audriga.com/SMESwitchWebApp/?client=groupware).
+
+Ensure you meet the prerequisites. For example, this document does not support using the standard username/password-based authentication option for M365.
+
+## Select the source provider and configure your openDesk instance
+
+Choose [Microsoft 365 / Exchange Online (Admin)](https://umzug.audriga.com/SMESwitchWebApp/?client=groupware#src=onmicrosoft.com) as your current provider.
+
+> **Note**<br>
+> You may need to start typing in "Microsoft Office 365/Exchange Online" for it to appear in the list.
+
+Configure openDesk as your destination server:
+- Select "Configure provider or server" in the provider selection box of the migration application.
+- In the following dialog, select "Open-Xchange" as protocol.
+- On the tab "IMAP"
+  - 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.
+  - Press check.
+- On the tab "Open-Xchange"
+  - Set the hostname of your OX AppSuite installation, e.g. "webmail.your-opendesk-domain.tld".
+  - Press check.
+- If you receive a green checkmark on both tabs, click "Save". Otherwise, check your settings until you get the green checkmark.
+
+## Adding accounts
+
+You can add accounts one by one, which seems only feasible for test scenarios, or when you migrate a handful of mailboxes, or you can add accounts using CSV upload. Both options are described in the following subsections.
+
+### Add user accounts individually
+
+By default, you will enter the "Add Mailbox" tab where you can add individual accounts for M365:
+
+```
+Username:             enter the username of the service account, e.g. eva@your-maildomain.tld
+Password:             enter the particular group email address, e.g. audriga-migration@your-maildomain.tld
+Details -> mailbox:   enter the user's mailbox you want to migrate, e.g. pia@your-maildomain.tld
+```
+
+On the openDesk site, please provide:
+```
+Username:             enter the username of the mailbox you want to migrate to, e.g. pia@your-maildomain.tld
+Password:             enter the master password
+```
+
+Click on check to verify the credentials. If the data is correct, a green checkmark will appear. A red cross will be displayed if the credentials need to be corrected.
+
+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.
+
+### Add multiple user accounts via CSV file
+
+Prepare a CSV file with all necessary information. Unsurprisingly, this is the same information as described in the "Add User Accounts Individually" section above.
+
+The CSV requires the following column order with a closing semicolon after the last value - but no headline is expected; the first line must be your migration data already:
+```
+M365ServiceAccount;M365GroupEmailAddress;M365Mailbox;openDeskMailbox;openDeskMasterPassword;
+```
+
+Example CSV:
+```
+eva@your-maildomain.tld;audriga-migration@your-maildomain.tld;eva@your-maildomain.tld;eva;YourMasterPassword;
+eva@your-maildomain.tld;audriga-migration@your-maildomain.tld;max@your-maildomain.tld;max;YourMasterPassword;
+eva@your-maildomain.tld;audriga-migration@your-maildomain.tld;pia@your-maildomain.tld;pia;YourMasterPassword;
+eva@your-maildomain.tld;audriga-migration@your-maildomain.tld;ida@your-maildomain.tld;ida;YourMasterPassword;
+```
+
+Select the "Add multiple accounts" tab to configure up to 50 user accounts by uploading a CSV file. If you need to migrate more accounts, you can execute the migration multiple times.
+
+Click "Check" and save afterwards.
+
+## Start the migration
+
+You will see a summary of the migration, including the number of accounts and the amount of data. Even if the analysis of the source accounts has not yet been completed, you can proceed.
+
+Ensure you have a valid voucher; otherwise, you must complete the payment process.
+
+Press "Start Migration" to proceed.
+
+## Monitor migration status
+
+The migration process may take some time to start. For large amounts of data, it may take a couple of hours.
+
+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 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.

docs/enhanced-configuration/idp-federation.md

@@ -0,0 +1,163 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Federation with external identity provider (IdP)</h1>
+
+<!-- TOC -->
+* [References](#references)
+* [Prerequisites](#prerequisites)
+  * [User accounts](#user-accounts)
+  * [External IdP with OIDC](#external-idp-with-oidc)
+* [Example configuration](#example-configuration)
+  * [Versions](#versions)
+  * [Example values](#example-values)
+  * [Keycloak admin console access](#keycloak-admin-console-access)
+  * [Your organizations IdP](#your-organizations-idp)
+    * [Separate realm](#separate-realm)
+    * [OIDC Client](#oidc-client)
+  * [openDesk IdP](#opendesk-idp)
+<!-- 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.
+
+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.
+
+# References
+
+We would like to list successful IdP federation scenarios, so we are also happy about input from the community:
+
+| External IdP                                                        | last openDesk version tested |
+| ------------------------------------------------------------------- | ---------------------------- |
+| [EU Login](https://webgate.ec.europa.eu/cas/userdata/myAccount.cgi) | v0.9.0                       |
+| [ProConnect](https://www.proconnect.gouv.fr/)                       | v0.9.0                       |
+
+# Prerequisites
+
+## User accounts
+
+In addition to the configuration, it is required that user accounts with the same name exist within openDesk. While this prerequisite is outside the scope of this document, the following approaches are feasible:
+
+- Manual user management
+  - A lightweight option to test your IdP federation setup or if you have only a small number of users to manage.
+  - Create and maintain your user(s) in openDesk and ensure the username in your IAM and openDesk is identical.
+- User import
+  - If you need to create more than just a couple of test accounts, you can use the [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import) that utilizes the UDM REST API for user account creation.
+  - Downsides: Managing groups and deleting accounts needs to be done manually.
+- Automated Pre-provisioning:
+  - Pre-provisioning users and groups, including de-provisioning (deleting) accounts, is the best practice to ensure that openDesk is in sync with your organization's IAM.
+  - There are at least two ways of implementing the pre-provisioning:
+  - UDM REST API:
+    - Build a provisioning solution using the [UDM REST API](https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html).
+    - The API gives you complete control over the contents of the IAM to create, update, or delete users and groups.
+  - Nubus Directory Importer:
+    - It is based on a Python one-way directory synchronization for users and groups.
+    - Please find more details in the [upstream product's documentation](https://docs.software-univention.de/nubus-kubernetes-operation/latest/en/howto-connect-external-iam.html).
+- Ad-hoc provisioning (AHP)
+  - 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.
+  - 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.
+    - A user account would never be deactivated or deleted in openDesk.
+    - Group memberships are not transferred.
+
+## External IdP with OIDC
+
+This document focuses on the OIDC federation between an external IdP and the openDesk IdP. It uses the OpenID Connect (OIDC) protocol, so your external IdP must support OIDC.
+
+# Example configuration
+
+## 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.
+
+## Example values
+
+The following values are used in this example documentation. Please ensure when you come across such a value, even if it is part of a URL hostname or path, that you adapt it where needed to your setup:
+
+- `idp.organization.tld`: hostname for your organization's IdP.
+- `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.
+- `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.
+- `auto-federate-flow`: Identifier of the required additional login flow to be created and referenced in the openDesk Keycloak.
+
+## 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.
+
+The admin console will be available at:
+- Organization's IdP: https://idp.organization.tld/admin/master/console/
+- openDesk IdP: https://id.opendesk.tld/admin/master/console/
+
+For the following configuration steps, log in with user `kcadmin` and grab the password from the `ums-keycloak` pod's `KEYCLOAK_ADMIN_PASSWORD` variable.
+
+## Your organizations IdP
+
+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.
+
+### Separate realm
+
+To not interfere with an existing configuration for our test scenario, we create a separate realm:
+
+- `Create realm` (from the realm selection drop-down menu in the left upper corner)
+- *Realm name*: `fed-test-idp-realm`
+- `Create`
+
+### OIDC Client
+
+If you just created the `fed-test-idp-realm`, you are already in the admin screen for the realm; if not, use the realm selection drop-down menu in the upper left corner to switch to the realm.
+
+- *Clients* > *Create Client*
+  - Client create wizard page 1:
+    - *Client type*: `OpenID Connect`
+    - *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)
+  - Client create wizard page 2:
+    - *Client authentication*: `On`
+    - *Authorization*: `Off` (default)
+    - *Authentication flow*: leave defaults
+      - `Standard flow`
+      - `Direct access grants`
+  - Client create wizard page 3:
+    - *Valid Redirect URLs*: `https://id.opendesk.tld/realms/opendesk/broker/auto-federate-idp/endpoint`
+  - When completed with *Save*, you get to the detailed client configured that also needs some updates:
+    - Tab *Settings* > Section *Logout settings*
+      - *Front channel logout*: `Off`
+      - *Back channel logout URL*: `https://id.opendesk.tld/realms/opendesk/protocol/openid-connect/logout/backchannel-logout`
+    - Tab *Credentials*
+      - Copy the *Client Secret* and the *Client-ID* as we need them to configure the openDesk IdP.
+
+## openDesk IdP
+
+The following configuration is taking place in the Keycloak realm `opendesk`.
+
+- *Authentication* > *Create flow*
+  - *Name*: `auto-federate-flow`
+  - *Flow type*: `Basic flow`
+  - *Create*
+  - *Add execution*: Add `Detect existing broker 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*
+  - *Alias*: `auto-federate-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.
+  - *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
+    - You will get an error if the IdP metadata cannot be auto-discovered.
+    - If everything is fine, you can review the discovered metadata for your IdP by clicking on *Show metadata*.
+  - *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 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:
+    - *First login flow override*: `auto-federate-flow`
+    - Depending on your organizations IdP and process preferences additional setting may be required
+
+- In case you want to forcefully redirect all users to your organization's IdP (disabling login with local openDesk accounts):
+  - *Authentication* > `2fa-browser`
+    - Click on the cogwheel next to the *Identity Provider Re-director*
+      - *Alias*: `auto-federate-idp`
+      - *Default Identity Provider*: `auto-federate-idp`

docs/enhanced-configuration/matrix-federation.md

@@ -0,0 +1,60 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Matrix federation</h1>
+
+<!-- TOC -->
+* [Context](#context)
+* [Example configuration](#example-configuration)
+  * [Disable federation](#disable-federation)
+  * [Separate Matrix domain](#separate-matrix-domain)
+<!-- TOC -->
+
+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.
+
+By default, you can chat with users who have an account within your openDesk installation and federate with other
+matrix-based servers.
+Federation support can be turned off.
+
+# Example configuration
+
+The following values are used in this example documentation.
+Please ensure when you come across such a value,
+even if it is part of a URL hostname or path, that you adapt it where needed to your setup:
+
+- `opendesk.domain.tld`: the mandatory `DOMAIN` setting for your deployment resulting in
+`https://chat.opendesk.domain.tld` for access to the Element chat.
+- `my_organization.tld`: an optional alternative domain used for mail and/or Matrix.
+It is also set to `opendesk.domain.tld` if not used.
+
+## Disable federation
+
+The following setting can turn off federation:
+
+```yaml
+functional:
+  externalServices:
+    matrix:
+      federation:
+        enabled: false
+```
+
+## 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
+the Matrix domain to use delegation. It is not part of your openDesk deployment.
+
+Domain path: `https://my_organization.tld/.well-known/matrix/server`
+
+Content:
+```JSON
+{
+    "m.server": "matrix-federation.opendesk.domain.tld:443"
+}
+```
+
+More detailed information can be found in Matrix/Synapse documentation:
+[Matrix Delegation](https://element-hq.github.io/synapse/latest/delegate.html)

docs/enhanced-configuration/self-signed-certificates.md

@@ -0,0 +1,107 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Self-signed certificate and custom Certificate Authority (CA)</h1>
+
+<!-- TOC -->
+* [Configuration](#configuration)
+  * [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 2b: Use cert-manager.io with pre-defined/shared root-certificate](#option-2b-use-cert-managerio-with-pre-definedshared-root-certificate)
+<!-- TOC -->
+
+Deploying openDesk into an environment with custom public key infrastructure (PKI) that is usually not part of
+public certificate authority chains or deploying openDesk into a local cluster without ACME challenge.
+
+# Configuration
+
+There are two options to address the use case.
+
+## 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
+access openDesk.
+
+1. Disable cert-manager.io certificate resource creation:
+
+    ```yaml
+    certificates:
+      enabled: false
+    ```
+
+1. Enable mount of self-signed certificates:
+
+    ```yaml
+    certificate:
+      selfSigned: true
+    ```
+
+1. 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)
+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
+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
+trust store password.
+
+## 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
+Let’s 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:
+    ```yaml
+    apiVersion: "cert-manager.io/v1"
+    kind: "ClusterIssuer"
+    metadata:
+      name: "selfsigned-issuer"
+    spec:
+      selfSigned: {}
+    ```
+
+1. Enable mount and creation of self-signed certificates:
+    ```yaml
+    certificate:
+      issuerRef:
+        name: "selfsigned-issuer"
+      selfSigned: true
+    ```
+
+## Option 2b: Use cert-manager.io with pre-defined/shared root-certificate
+
+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.
+
+1. Create self-signed cert-manager.io Cluster Issuer root certificate the same was 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`.
+    ```yaml
+    apiVersion: cert-manager.io/v1
+    kind: Certificate
+    metadata:
+      name: opendesk-root
+      namespace: cert-manager
+    spec:
+      isCA: true
+      commonName: opendesk.eu
+      secretName: opendesk-root-cert-secret
+      subject:
+        organizations: [ "openDesk cluster root certificate organization" ]
+      privateKey:
+        algorithm: ECDSA
+        size: 256
+      issuerRef:
+        name: selfsigned-issuer
+        kind: ClusterIssuer
+        group: cert-manager.io
+    ```
+
+1. Copy this cert's secret into the/each namespace you want to make use of the cert.
+
+1. Create issuer in the/each namespace you want to make use of the cert.
+
+The latter two steps are part of the `env-start:` section within [`.gitlab-ci.yml`](../../.gitlab-ci.yml).

docs/enhanced-configuration/separate-mail-matrix-domain.md

@@ -0,0 +1,99 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Separate domains for mail and or Matrix </h1>
+
+<!-- TOC -->
+* [Context](#context)
+* [Example configuration](#example-configuration)
+  * [Mail domain](#mail-domain)
+  * [Matrix domain](#matrix-domain)
+    * [DNS](#dns)
+    * [Webserver](#webserver)
+      * [Content Security Policy](#content-security-policy)
+      * [.well-known](#well-known)
+<!-- TOC -->
+
+As communication over mail and chat can go beyond the borders of your openDesk installation, you may want to use different domains for the mail and/or Matrix.
+
+# Example configuration
+
+The following values are used in this example documentation. Please ensure when you come across such a value, even if it is part of a URL hostname or path, that you adapt it where needed to your setup:
+
+- `opendesk.domain.tld`: the mandatory `DOMAIN` setting for your deployment resulting in `https://mail.opendesk.domain.tld` to access emails and `https://chat.opendesk.domain.tld` to access the Element chat that is based on the Matrix protocol.
+- `my_organization.tld`: the alternative domain used for mail and/or Matrix.
+
+## Mail domain
+
+By default, all email addresses in openDesk are created based on the `DOMAIN` you specified for your deployment. In our example, the users have `<username>@opendesk.domain.tld` as their mail addresses. In case you prefer the users to send and receive emails with another domain, you can set that one using the optional `MAIL_DOMAIN` in the deployment:
+
+```yaml
+global:
+  mailDomain: "my_organization.tld"
+```
+
+or via environment variable
+
+```shell
+export MAIL_DOMAIN=my_organization.tld
+```
+
+Of course, this requires the domain's MX record to point to the mail host for your openDesk deployment. You can optionally add the SPF and DMARC records.
+
+| Record name                | Type | Value                                            |
+| -------------------------- | ---- | ------------------------------------------------ |
+| my_organization.tld        | MX   | `10 mail.opendesk.domain.tld` |
+| my_organization.tld        | TXT  | `v=spf1 +a +mx +a:mail.opendesk.domain.tld ~all` |
+| _dmarc.my_organization.tld | TXT  | `v=DMARC1; p=quarantine` |
+
+## Matrix domain
+
+Similar to the specific domain for email addresses, you may want to specify a domain that differs from your deployment's default `DOMAIN` to define your user's Matrix IDs. Use the `MATRIX_DOMAIN` to do so:
+
+```yaml
+global:
+  matrixDomain: "my_organization.tld"
+```
+
+or via environment variable
+
+```shell
+export MATRIX_DOMAIN=my_organization.tld
+```
+
+### DNS
+
+The following changes apply to the standard DNS:
+
+| Record name                      | Type | Value                                  | Comment                                                                                |
+| -------------------------------- | ---- | -------------------------------------- | -------------------------------------------------------------------------------------- |
+| _matrix._tcp.my_organization.tld | SRV  | `1 10 PORT matrix.opendesk.domain.tld` | `PORT` is your NodePort/LoadBalancer port of the `opendesk-synapse-federation` service |
+
+*Note:* `matrix.opendesk.domain.tld` in the "Value" column can also be the IP address synapse TLS port listens to.
+
+### Webserver
+
+#### Content Security Policy
+
+The `my_organization.tld` webserver should add `*.opendesk.domain.tld` to its CSP header.
+
+#### .well-known
+
+If you want to use other Matrix clients,
+e.g., Element Messenger for [iOS](https://apps.apple.com/de/app/element-messenger/id1083446067)
+or [Android](https://play.google.com/store/apps/details?id=im.vector.app),
+you need to create a JSON file with the following contents that is served from
+`https://my_organization.tld/.well-known/matrix/client`:
+
+```json
+{
+  "m.homeserver": {
+    "base_url": "https://matrix.opendesk.domain.tld"
+  }
+}
+```
+
+The above configuration ensures clients know where to find the Matrix protocol endpoint when users specify `my_organization.tld`
+as their homeserver.

docs/external-services.md

@@ -0,0 +1,152 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>External services</h1>
+
+This document will cover the additional configuration for external services like databases, caches, or buckets.
+
+<!-- TOC -->
+* [Database](#database)
+* [Object storage](#object-storage)
+* [Cache](#cache)
+* [Footnotes](#footnotes)
+<!-- TOC -->
+
+# Database
+
+When deploying this suite to production, you need to configure the applications to use your production-grade database
+service.
+
+> **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.
+
+| Component        | Name               | Parameter | Key                                           | Default                      |
+| ---------------- | ------------------ | --------- | --------------------------------------------- | ---------------------------- |
+| Element          | Synapse            |           |                                               |                              |
+|                  |                    | Type      | `databases.synapse.type`                      | `postgresql`                 |
+|                  |                    | Name      | `databases.synapse.name`                      | `matrix`                     |
+|                  |                    | Host      | `databases.synapse.host`                      | `postgresql`                 |
+|                  |                    | Port      | `databases.synapse.port`                      | `5432`                       |
+|                  |                    | Username  | `databases.synapse.username`                  | `matrix_user`                |
+|                  |                    | Password  | `databases.synapse.password`                  |                              |
+| Nubus            | Guardian Mgmt API  |           |                                               |                              |
+|                  |                    | Type      | `databases.umsGuardianManagementApi.type`     | `postgresql`                 |
+|                  |                    | Name      | `databases.umsGuardianManagementApi.name`     | `guardianmanagementapi`      |
+|                  |                    | Host      | `databases.umsGuardianManagementApi.host`     | `postgresql`                 |
+|                  |                    | Port      | `databases.umsGuardianManagementApi.port`     | `5432`                       |
+|                  |                    | Username  | `databases.umsGuardianManagementApi.username` | `guardianmanagementapi_user` |
+|                  |                    | Password  | `databases.umsGuardianManagementApi.password` |                              |
+|                  | Keycloak           |           |                                               |                              |
+|                  |                    | Type      | `databases.keycloak.type`                     | `postgresql`                 |
+|                  |                    | Name      | `databases.keycloak.name`                     | `keycloak`                   |
+|                  |                    | Host      | `databases.keycloak.host`                     | `postgresql`                 |
+|                  |                    | Port      | `databases.keycloak.port`                     | `5432`                       |
+|                  |                    | Username  | `databases.keycloak.username`                 | `keycloak_user`              |
+|                  |                    | Password  | `databases.keycloak.password`                 |                              |
+|                  | Keycloak Extension |           |                                               |                              |
+|                  |                    | Type      | `databases.keycloakExtension.type`            | `postgresql`                 |
+|                  |                    | Name      | `databases.keycloakExtension.name`            | `keycloak_extensions`        |
+|                  |                    | Host      | `databases.keycloakExtension.host`            | `postgresql`                 |
+|                  |                    | Port      | `databases.keycloakExtension.port`            | `5432`                       |
+|                  |                    | Username  | `databases.keycloakExtension.username`        | `keycloak_extensions_user`   |
+|                  |                    | Password  | `databases.keycloakExtension.password`        |                              |
+|                  | Notifications API  |           |                                               |                              |
+|                  |                    | Type      | `databases.umsNotificationsApi.type`          | `postgresql`                 |
+|                  |                    | Name      | `databases.umsNotificationsApi.name`          | `notificationsapi`           |
+|                  |                    | Host      | `databases.umsNotificationsApi.host`          | `postgresql`                 |
+|                  |                    | Port      | `databases.umsNotificationsApi.port`          | `5432`                       |
+|                  |                    | Username  | `databases.umsNotificationsApi.username`      | `notificationsapi_user`      |
+|                  |                    | Password  | `databases.umsNotificationsApi.password`      |                              |
+|                  | Self Service       |           |                                               |                              |
+|                  |                    | Type      | `databases.umsSelfservice.type`               | `postgresql`                 |
+|                  |                    | Name      | `databases.umsSelfservice.name`               | `selfservice`                |
+|                  |                    | Host      | `databases.umsSelfservice.host`               | `postgresql`                 |
+|                  |                    | Port      | `databases.umsSelfservice.port`               | `5432`                       |
+|                  |                    | Username  | `databases.umsSelfservice.username`           | `selfservice_user`           |
+|                  |                    | Password  | `databases.umsSelfservice.password`           |                              |
+| Nextcloud        | Nextcloud          |           |                                               |                              |
+|                  |                    | Type      | `databases.nextcloud.type`                    | `mariadb`                    |
+|                  |                    | Name      | `databases.nextcloud.name`                    | `nextcloud`                  |
+|                  |                    | Host      | `databases.nextcloud.host`                    | `mariadb`                    |
+|                  |                    | Port      | `databases.nextcloud.port`                    | `3306`                       |
+|                  |                    | Username  | `databases.nextcloud.username`                | `nextcloud_user`             |
+|                  |                    | Password  | `databases.nextcloud.password`                |                              |
+| Notes            | Notes              |           |                                               |                              |
+|                  |                    | Type      | `databases.notes.type`                        | `postgresql`                 |
+|                  |                    | Name      | `databases.notes.name`                        | `notes`                      |
+|                  |                    | Host      | `databases.notes.host`                        | `postgresql`                 |
+|                  |                    | Port      | `databases.notes.port`                        | `5432`                       |
+|                  |                    | Username  | `databases.notes.username`                    | `notes_user`                 |
+|                  |                    | Password  | `databases.notes.password`                    |                              |
+| OpenProject      | OpenProject        |           |                                               |                              |
+|                  |                    | Type      | `databases.openproject.type`                  | `postgresql`                 |
+|                  |                    | Name      | `databases.openproject.name`                  | `openproject`                |
+|                  |                    | Host      | `databases.openproject.host`                  | `postgresql`                 |
+|                  |                    | Port      | `databases.openproject.port`                  | `5432`                       |
+|                  |                    | Username  | `databases.openproject.username`              | `openproject_user`           |
+|                  |                    | Password  | `databases.openproject.password`              |                              |
+| OX App Suite[^2] | OX App Suite       |           |                                               |                              |
+|                  |                    | Type      | `databases.oxAppSuite.type`                   | `mariadb`                    |
+|                  |                    | Name      | `databases.oxAppSuite.name`                   | `openxchange`                |
+|                  |                    | Host      | `databases.oxAppSuite.host`                   | `mariadb`                    |
+|                  |                    | Port      | `databases.oxAppSuite.port`                   | `3306`                       |
+|                  |                    | Username  | `databases.oxAppSuite.username`               | `root`                       |
+|                  |                    | Password  | `databases.oxAppSuite.password`               |                              |
+| XWiki[^3]        | XWiki              |           |                                               |                              |
+|                  |                    | Type      | `databases.xwiki.type`                        | `mariadb`                    |
+|                  |                    | Name      | `databases.xwiki.name`                        | `xwiki`                      |
+|                  |                    | Host      | `databases.xwiki.host`                        | `mariadb`                    |
+|                  |                    | Port      | `databases.xwiki.port`                        | `3306`                       |
+|                  |                    | Username  | `databases.xwiki.username`                    | `root`                       |
+|                  |                    | Password  | `databases.xwiki.password`                    |                              |
+
+# Object storage
+
+When deploying this suite to production, you need to configure the applications to use your production-grade object
+storage service.
+
+| Component   | Name        | Parameter       | Key                                      | Default            |
+|-------------|-------------|-----------------|------------------------------------------|--------------------|
+| OpenProject | OpenProject |                 |                                          |                    |
+|             |             | Backend         | `objectstores.openproject.backend`       | `minio`            |
+|             |             | Bucket          | `objectstores.openproject.bucket`        | `openproject`      |
+|             |             | Endpoint        | `objectstores.openproject.endpoint`      |                    |
+|             |             | Provider        | `objectstores.openproject.provider`      | `AWS`              |
+|             |             | Region          | `objectstores.openproject.region`        |                    |
+|             |             | Secret          | `objectstores.openproject.secret`        |                    |
+|             |             | Username        | `objectstores.openproject.username`      | `openproject_user` |
+|             |             | Use IAM profile | `objectstores.openproject.useIAMProfile` |                    |
+
+# Cache
+
+When deploying this suite to production, you need to configure the applications to use your production-grade cache
+service.
+
+| Component        | Name             | Type      | Parameter | Key                          | Default          |
+|------------------|------------------|-----------|-----------|------------------------------|------------------|
+| Intercom Service | Intercom Service | Redis     |           |                              |                  |
+|                  |                  |           | Host      | `cache.intercomService.host` | `redis-headless` |
+|                  |                  |           | Port      | `cache.intercomService.port` | `6379`           |
+| Nextcloud        | Nextcloud        | Redis     |           |                              |                  |
+|                  |                  |           | Host      | `cache.nextcloud.host`       | `redis-headless` |
+|                  |                  |           | Port      | `cache.nextcloud.port`       | `6379`           |
+| OpenProject      | OpenProject      | Memcached |           |                              |                  |
+|                  |                  |           | Host      | `cache.openproject.host`     | `memcached`      |
+|                  |                  |           | Port      | `cache.openproject.port`     | `11211`          |
+| UMS              | Self Service     | Memcached |           |                              |                  |
+|                  |                  |           | Host      | `cache.umsSelfservice.host`  | `memcached`      |
+|                  |                  |           | Port      | `cache.umsSelfservice.port`  | `11211`          |
+
+# Footnotes
+
+[^1] The upstream product provide some valuable information regarding database migrations:
+- Nextcloud: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/db_conversion.html
+- XWiki:
+  - https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature
+  - https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/ImportExport
+
+[^2] OX App Suite only supports MariaDB and requires root access, as it manages its databases itself.
+
+[^3] 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.

docs/getting-started.md

@@ -0,0 +1,489 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Getting started</h1>
+
+This documentation lets you create an openDesk evaluation instance on your Kubernetes cluster.
+
+<!-- TOC -->
+* [Requirements](#requirements)
+* [Customize environment](#customize-environment)
+  * [DNS](#dns)
+  * [Domain](#domain)
+    * [Apps](#apps)
+  * [Private registries](#private-registries)
+  * [Cluster capabilities](#cluster-capabilities)
+    * [Service](#service)
+    * [Networking](#networking)
+    * [Ingress](#ingress)
+    * [Container runtime](#container-runtime)
+    * [Volumes](#volumes)
+  * [Connectivity](#connectivity)
+    * [Ports](#ports)
+      * [Web-based user interface](#web-based-user-interface)
+      * [Mail clients](#mail-clients)
+    * [Mail/SMTP configuration](#mailsmtp-configuration)
+    * [TURN configuration](#turn-configuration)
+    * [Certificate issuer](#certificate-issuer)
+  * [Password seed](#password-seed)
+  * [Install](#install)
+  * [Install single app](#install-single-app)
+  * [Install single release/chart](#install-single-releasechart)
+* [Access deployment](#access-deployment)
+  * [Using from external repository](#using-from-external-repository)
+* [Uninstall](#uninstall)
+<!-- TOC -->
+
+Thanks for looking into the openDesk Getting Started guide. This document covers essential configuration steps to
+deploy openDesk onto your Kubernetes infrastructure.
+
+# Requirements
+
+Detailed system requirements are covered on the [requirements](./docs/requirements.md) page.
+
+# Customize environment
+
+Before deploying openDesk, you must configure the deployment to fit your environment.
+To keep your deployment up to date, we recommend customizing in `dev`, `test`, or `prod` and not in `default` environment
+files.
+
+> All configuration options and their default values can be found in files at [`helmfile/environments/default/`](../helmfile/environments/default/)
+
+For the following guide, we will use `dev` as environment where variables can be set in
+`helmfile/environments/dev/values.yaml.gotmpl`.
+
+## DNS
+
+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.
+
+| Record name                   | Type | Value                                              | Additional information                                           |
+| ----------------------------- | ---- | -------------------------------------------------- | ---------------------------------------------------------------- |
+| *.domain.tld                  | A    | IPv4 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               | 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                    | 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                                                         |
+| default._domainkey.domain.tld | TXT  | `v=DKIM1; k=rsa; h=sha256; ...`                    | Optional DKIM settings                                           |
+
+## Domain
+
+A list of all subdomains can be found in `helmfile/environments/default/global.gotmpl`.
+
+All subdomains can be customized. For example, _Nextcloud_ can be changed to `files.domain.tld` in `dev` environment:
+
+```yaml
+global:
+  hosts:
+    nextcloud: "files"
+```
+
+The domain has to be set either via `dev` environment
+
+```yaml
+global:
+  domain: "domain.tld"
+```
+
+or via environment variable
+
+```shell
+export DOMAIN=domain.tld
+```
+
+### Apps
+
+All available apps and their default value are in `helmfile/environments/default/opendesk_main.gotmpl`.
+
+| Component            | Name                        | Default | Description                    |
+| -------------------- | --------------------------- | ------- | ------------------------------ |
+| Certificates         | `certificates.enabled`      | `true`  | TLS certificates               |
+| ClamAV (Distributed) | `clamavDistributed.enabled` | `false` | Antivirus engine               |
+| ClamAV (Simple)      | `clamavSimple.enabled`      | `true`  | Antivirus engine               |
+| Collabora            | `collabora.enabled`         | `true`  | Weboffice                      |
+| CryptPad             | `cryptpad.enabled`          | `true`  | Weboffice                      |
+| dkimpy               | `dkimpy.enabled`            | `false` | Postfix milter for DKIM        |
+| Dovecot              | `dovecot.enabled`           | `true`  | Mail backend                   |
+| Element              | `element.enabled`           | `true`  | Secure communications platform |
+| Home                 | `home.enabled`              | `true`  | Base domain portal redirect    |
+| Jitsi                | `jitsi.enabled`             | `true`  | Videoconferencing              |
+| MariaDB              | `mariadb.enabled`           | `true`  | Database                       |
+| Memcached            | `memcached.enabled`         | `true`  | Cache Database                 |
+| MinIO                | `minio.enabled`             | `true`  | Object Storage                 |
+| Nextcloud            | `nextcloud.enabled`         | `true`  | File share                     |
+| Nubus                | `nubus.enabled`             | `true`  | Identity Management & Portal   |
+| OpenProject          | `openproject.enabled`       | `true`  | Project management             |
+| OX App Suite         | `oxAppSuite.enabled`        | `true`  | Groupware                      |
+| Postfix              | `postfix.enabled`           | `true`  | MTA                            |
+| PostgreSQL           | `postgresql.enabled`        | `true`  | Database                       |
+| Redis                | `redis.enabled`             | `true`  | Cache Database                 |
+| XWiki                | `xwiki.enabled`             | `true`  | Knowledge management           |
+
+Exemplary, Jitsi can be disabled like:
+
+```yaml
+jitsi:
+  enabled: false
+```
+
+## Private registries
+
+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).
+
+For untouched upstream artifacts that do not belong to a functional component's core, we use upstream registries
+like Docker Hub.
+
+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
+prefer the use of a private image registry, you can configure such for
+[your target environment](../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting
+- `global.imageRegistry` for a private image registry and
+- `global.helmRegistry` for a private Helm chart registry.
+
+```yaml
+global:
+  imageRegistry: "my_private_registry.domain.tld"
+```
+
+alternatively, you can use an environment variable:
+
+```shell
+export PRIVATE_IMAGE_REGISTRY_URL=my_private_registry.domain.tld
+```
+
+or control repository override fine-granular per registry:
+
+```yaml
+repositories:
+  image:
+    dockerHub: "my_private_registry.domain.tld/docker.io/"
+    registryOpencodeDe: "my_private_registry.domain.tld/registry.opencode.de/"
+```
+
+If authentication is required, you can reference `imagePullSecrets` as follows:
+
+```yaml
+global:
+  imagePullSecrets:
+    - "external-registry"
+```
+
+## Cluster capabilities
+
+### Service
+
+Some apps, like Jitsi or Dovecot, require HTTP and external TCP connections.
+These apps create a Kubernetes service object.
+You can configure whether `NodePort` (for on-premise), `LoadBalancer` (for cloud), or `ClusterIP` (to disable) should be
+used:
+
+```yaml
+cluster:
+  service:
+    type: "NodePort"
+```
+
+### Networking
+
+If your cluster has not the default `cluster.local` domain configured, you need to provide the domain via:
+
+```yaml
+cluster:
+  networking:
+    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:
+
+```yaml
+cluster:
+  networking:
+    cidr:
+      - "127.0.0.0/8"
+```
+
+If your load balancer / reverse proxy IPs are not already covered by the above `cidr` you need to
+explicitly configure the related IPs or IP ranges:
+
+```yaml
+cluster:
+  networking:
+    incomingCIDR:
+      - "172.16.0.0/12"
+```
+
+### Ingress
+
+By default, the `ingressClassName` is empty to select your default ingress controller. You may want to customize it by
+setting the following attribute to the name of the currently only supported ingress controller `ingress-nginx` (see
+[requirements.md](requirements.md)) for reference) within your deployment if that is not the cluster's default ingress.
+
+```yaml
+ingress:
+  ingressClassName: "name-of-my-nginx-ingress"
+```
+
+### Container runtime
+
+Some apps require specific configurations for the container runtime. You can set your container runtime like `cri-o`,
+`containerd` or `docker` by:
+
+```yaml
+cluster:
+  container:
+    engine: "containerd"
+```
+
+### Volumes
+The **StorageClass** must be set by:
+
+```yaml
+persistence:
+  storageClassNames:
+    RWX: "my-read-write-many-class"
+    RWO: "my-read-write-once-class"
+```
+
+`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.
+To enable `ReadWriteMany` you have to set:
+
+```yaml
+cluster:
+  persistence:
+    readWriteMany: true
+```
+
+
+
+## Connectivity
+
+### Ports
+
+**Note:** If you use `NodePort` for service exposure, you must check your deployment for the actual ports.
+
+#### Web-based user interface
+
+To use the openDesk functionality with its web-based user interface, you need to expose the following ports publicly:
+
+| Component          | Description             |  Port | Type |
+| ------------------ | ----------------------- | ----: | ---: |
+| openDesk           | Kubernetes Ingress      |    80 |  TCP |
+| openDesk           | Kubernetes Ingress      |   443 |  TCP |
+| Jitsi Video Bridge | ICE Port for video data | 10000 |  UDP |
+
+#### Mail clients
+
+To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need public exposure:
+
+| Component          | Description             |  Port | Type |
+| ------------------ | ----------------------- | ----: | ---: |
+| Dovecot            | IMAPS                   |   993 |  TCP |
+|                    | POP3S                   |   995 |  TCP |
+| Postfix            | SMTP                    |    25 |  TCP |
+|                    | SMTPS                   |   587 |  TCP |
+
+### Mail/SMTP configuration
+
+To use the full potential of the openDesk, you need to set up an SMTP relay that allows sending emails from
+the whole subdomain.
+
+```yaml
+smtp:
+  host: "mail.open.desk"
+  username: "openDesk"
+  password: "secret"
+```
+
+Enabling DKIM signing of emails helps to reduce spam and increases trust.
+openDesk ships dkimpy-milter as Postfix milter for signing emails.
+
+```yaml
+dkimpy:
+  enable: true
+  dkim:
+    key:
+      value: "HzZs08QF1O7UiAkcM9T3U7rePPECtSFvWZIvyKqdg8E="
+    selector: "default"
+    useED25519: true # when false, RSA is used
+```
+
+### TURN configuration
+
+Some components (Jitsi, Element) use a TURN server for direct communication. You can configure your own TURN server with
+these options:
+
+```yaml
+turn:
+  transport: "udp" # or tcp
+  credentials: "secret"
+  server:
+    host: "turn.open.desk"
+    port: "3478"
+  tls:
+    host: "turns.open.desk"
+    port: "5349"
+```
+
+### Certificate issuer
+
+As mentioned in [requirements](requirements.md#certificate-management), you can provide your own valid certificate. A TLS
+secret named `opendesk-certificates-tls` must be present in the application namespace. For deployment, you can
+turn off `Certificate` resource creation by:
+
+```yaml
+certificates:
+  enabled: false
+```
+
+If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the
+configured cluster issuer:
+
+```yaml
+certificate:
+  issuerRef:
+    name: "letsencrypt-prod"
+```
+
+Additionally, it is possible to request wildcard certificates by:
+
+```yaml
+certificate:
+  wildcard: true
+```
+
+## Password seed
+
+All secrets are generated from a master password via [Master Password (algorithm)](https://en.wikipedia.org/wiki/Master_Password_(algorithm)).
+To prevent others from using your openDesk instance, you must set your individual master password via:
+
+```shell
+export MASTER_PASSWORD="your_individual_master_password"
+```
+
+## Install
+
+After setting your environment-specific values in `dev` environment, you can start deployment by:
+
+```shell
+helmfile apply -e dev -n <NAMESPACE> [-l <label>] [--suppress-diff]
+```
+
+**Arguments:**
+
+- `-e <env>`: Environment name out of `default`, `dev`, `test`, `prod`
+- `-n <namespace>`: Kubernetes namespace
+- `-l <label>`: Label selector
+- `--suppress-diff`: Disable diff printing
+
+## Install single app
+
+You can also install or upgrade only a single app like Collabora, either by label selector:
+
+```shell
+helmfile apply -e dev -n <NAMESPACE> -l component=collabora
+```
+
+or by switching into the apps' directory (faster):
+
+```shell
+cd helmfile/apps/collabora
+helmfile apply -e dev -n <NAMESPACE>
+```
+
+## Install single release/chart
+
+Instead of iteration through all services, you can also deploy a single release like `mariadb` by:
+
+```shell
+helmfile apply -e dev -n <NAMESPACE> -l name=mariadb
+```
+
+# Access deployment
+
+When all apps are successfully deployed, and their Pod's status is `Running` or `Succeeded`, you can navigate to
+
+```text
+https://portal.domain.tld
+```
+
+If you change the subdomain of `nubus`, you must replace `portal` with the specified subdomain.
+
+**Credentials:**
+
+openDesk deploys with the standard user account `Administrator`, which password you get retrieved as follows:
+
+```shell
+# Set your namespace
+NAMESPACE=<your_namespace>
+
+# Get password for IAM "Administrator" account
+kubectl -n ${NAMESPACE} get secret ums-nubus-credentials -o jsonpath='{.data.administrator_password}' | base64 -d
+```
+
+Using the aforementioned account, you can either create new accounts manually or make use of the
+[openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import/)
+script or container.
+
+For example you get a `default` and `default-admin` account by running the following snippet, after settings the
+appropriate values in the first three lines.
+
+```shell
+ADMINISTRATOR_PASSWORD=<your_administrator_password_see_above>
+DOMAIN=<your_domain>
+DEFAULT_USERS_PASSWORD=<password_for_the_created_default_accounts>
+docker run --rm registry.opencode.de/bmi/opendesk/components/platform-development/images/user-import:3.0.0 \
+  ./user_import_udm_rest_api.py \
+    --import_domain ${DOMAIN} \
+    --udm_api_password ${ADMINISTRATOR_PASSWORD} \
+    --set_default_password ${DEFAULT_USERS_PASSWORD} \
+    --import_filename template.ods \
+    --create_admin_accounts True
+```
+
+## Using from external repository
+
+Referring to `./helmfile_generic.yaml.gotmpl` from an external
+directory or repository is possible. The `helmfile.yaml.gotmpl` that refers to
+`./helmfile_generic.yaml.gotmpl` may define custom environments. These custom
+environments may overwrite specific configuration values. These
+configuration values are:
+
+* `global.domain`
+* `global.helmRegistry`
+* `global.master_password`
+
+# Uninstall
+
+You can uninstall the deployment by:
+
+```shell
+helmfile destroy -n <NAMESPACE>
+```
+
+> **Note**<br>
+> Not all Jobs, PersistentVolumeClaims, or Certificates are deleted; you have to delete them manually
+
+**'Sledgehammer destroy'** - for fast development turn-around times (at your own risk):
+
+```shell
+NAMESPACE=your-namespace
+
+# Uninstall all Helm charts
+for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
+  helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
+done
+
+# Delete leftover resources
+kubectl delete pvc --all --namespace ${NAMESPACE};
+kubectl delete jobs --all --namespace ${NAMESPACE};
+kubectl delete configmaps --all --namespace ${NAMESPACE};
+```
+
+> **Warning**<br>
+> Without specifying or empty `--namespace` flag, cluster-wide components get deleted!

docs/migrations.md

@@ -0,0 +1,615 @@
+<!--
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Updates & Upgrades</h1>
+
+<!-- TOC -->
+* [Disclaimer](#disclaimer)
+* [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path)
+* [Manual checks/actions](#manual-checksactions)
+  * [From v1.1.0](#from-v110)
+    * [Pre-upgrade from v1.1.0](#pre-upgrade-from-v110)
+      * [Helmfile feature update: Component specific `storageClassName`](#helmfile-feature-update-component-specific-storageclassname)
+      * [Helmfile new secret: `secrets.nubus.masterpassword`](#helmfile-new-secret-secretsnubusmasterpassword)
+  * [From v1.0.0](#from-v100)
+    * [Pre-upgrade from v1.0.0](#pre-upgrade-from-v100)
+      * [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: 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: 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)
+      * [openDesk defaults (new): Enforce login](#opendesk-defaults-new-enforce-login)
+      * [openDesk defaults (changed): Jitsi room history enabled](#opendesk-defaults-changed-jitsi-room-history-enabled)
+      * [External requirements: Redis 7.4](#external-requirements-redis-74)
+    * [Post-upgrade from v1.0.0](#post-upgrade-from-v100)
+      * [XWiki fix-ups](#xwiki-fix-ups)
+  * [From v0.9.0](#from-v090)
+    * [Pre-upgrade from v0.9.0](#pre-upgrade-from-v090)
+      * [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)
+      * [Changed openDesk defaults: Matrix presence status disabled](#changed-opendesk-defaults-matrix-presence-status-disabled)
+      * [Changed openDesk defaults: Matrix ID](#changed-opendesk-defaults-matrix-id)
+      * [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: 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)
+      * [Configuration Improvement: Separate user permission for using Video Conference component](#configuration-improvement-separate-user-permission-for-using-video-conference-component)
+      * [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)
+  * [From v1.0.0 (automated)](#from-v100-automated)
+  * [From v0.9.0 (automated)](#from-v090-automated)
+  * [Related components and artifacts](#related-components-and-artifacts)
+  * [Development](#development)
+<!-- TOC -->
+
+# Disclaimer
+
+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).
+
+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>
+> Please be sure you read / follow the requirements before you update / upgrade thoroughly.
+
+> **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.
+
+# 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.
+
+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.
+
+| Mandatory version |
+| ----------------- |
+| v1.1.x            |
+| v1.0.0            |
+| v0.9.0            |
+| v0.8.1            |
+
+> **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.
+
+When interested in more details about the automated migrations, please read section [Automated migrations - Details](#automated-migrations---details).
+
+# Manual checks/actions
+
+Be sure you check all the sections for the releases your are going to update your current deployment from.
+
+## From v1.1.0
+
+### Pre-upgrade from v1.1.0
+
+#### 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.
+
+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:
+
+- We replaced `persistence.size` with `persistence.storages`.
+- 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.
+
+So a setting of:
+
+```yaml
+persistence:
+  size:
+    synapse: "1Gi"
+```
+
+needs to be changed to:
+
+```yaml
+persistence:
+  storages:
+    synapse:
+      size: "1Gi"
+```
+
+or for the Nubus related entries, the following:
+
+```yaml
+persistence:
+  size:
+    nubus:
+      ldapServerData: "1Gi"
+```
+
+needs to be changed to:
+
+```yaml
+persistence:
+  storages:
+    nubusLdapServerData:
+      size: "1Gi"
+```
+
+#### 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.
+
+## From v1.0.0
+
+### Pre-upgrade from v1.0.0
+
+#### 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.
+
+#### Helmfile cleanup: Consistent use of `*.yaml.gotmpl`
+
+In v1.0.0 the files in [`/helmfile/environments/default`](../helmfile/environments/default/) had mixed extensions,
+we have streamlined them to consistently use `*.yaml.gotmpl`.
+
+This change requires manual action likely 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.
+2. You have custom files containing configuration information that are named just `*.yaml`: Please rename them to `*.yaml.gotmpl`.
+
+#### 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
+provided by openDesk, we have prefixed these app directories with `opendesk-`.
+
+Affected are the following directories, here listed directly with the new prefix:
+
+- [`./helmfile/apps/opendesk-migrations-pre`](../helmfile/apps/opendesk-migrations-pre)
+- [`./helmfile/apps/opendesk-migrations-post`](../helmfile/apps/opendesk-migrations-post)
+- [`./helmfile/apps/opendesk-openproject-bootstrap`](../helmfile/apps/opendesk-openproject-bootstrap)
+
+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.
+
+#### Helmfile cleanup: Helmfile cleanup: Splitting external vs. 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.
+
+As some services that are actually part of openDesk snuck in there, so we had to split the directory into two separate ones:
+
+- [`./helmfile/apps/opendesk-services`](../helmfile/apps/opendesk-services)
+- [`./helmfile/apps/services-external`](../helmfile/apps/services-external)
+
+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.
+
+#### 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
+deployment and to aligning with the actual brand names as well as with our rule of thumb for brand based
+attribute names[^1].
+
+In case you are using any of the customizations below (`WAS`), please update as shown (`NOW`):
+
+```
+WAS: oxAppsuite: ...
+NOW: oxAppSuite: ...
+```
+
+```
+WAS: cache.oxAppsuite: ...
+NOW: cache.oxAppSuite: ...
+```
+
+```
+WAS: charts.openXchangeAppSuite: ...
+NOW: charts.oxAppSuite: ...
+```
+
+```
+WAS: charts.openXchangeAppSuiteBootstrap: ...
+NOW: charts.oxAppSuiteBootstrap: ...
+```
+
+```
+WAS: customization.release.openXchange: ...
+NOW: customization.release.openxchange: ...
+```
+
+```
+WAS: customization.release.opendeskOpenXchangeBootstrap: ...
+NOW: customization.release.opendeskOpenxchangeBootstrap: ...
+```
+
+```
+WAS: databases.oxAppsuite: ...
+NOW: databases.oxAppSuite: ...
+```
+
+```
+WAS: ingress.parameters.openXchangeAppSuite: ...
+NOW: ingress.parameters.oxAppSuite: ...
+```
+
+```
+WAS: ingress.bodyTimeout.openXchangeAppSuite: ...
+NOW: ingress.bodyTimeout.oxAppSuite: ...
+```
+
+```
+WAS: migration.oxAppsuite: ...
+NOW: migration.oxAppSuite: ...
+```
+
+```
+WAS: secrets.oxAppsuite: ...
+NOW: secrets.oxAppSuite: ...
+```
+
+#### 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
+
+```yaml
+customization:
+  release:
+    collaboraOnline: "./my_custom_templating.yaml.gotmpl"
+```
+
+to
+
+```yaml
+customization:
+  release:
+    collaboraOnline:
+      file1: "./my_custom_templating.yaml.gotmpl"
+```
+
+You can freely choose the `file1` dictionary key used in the example above, but it should start with a letter.
+
+#### openDesk defaults (new): Enforce login
+
+Users accessing the openDesk portal are now automatically redirected to the login screen as a default.
+
+In case you want to keep the previous behavior you need to set the following `functional` flag:
+
+```yaml
+functional:
+  portal:
+    enforceLogin: false
+```
+
+#### openDesk defaults (changed): Jitsi room history enabled
+
+The default to store the Jitsi room history in the local storage of a user's browser has changed.
+
+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:
+
+```yaml
+functional:
+  dataProtection:
+    jitsiRoomHistory:
+      enabled: false
+```
+
+#### 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.
+
+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.
+
+### Post-upgrade from v1.0.0
+
+#### 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:
+
+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:
+   ```
+   rm -rf /usr/local/xwiki/data/store/solr/search_9
+   rm -rf /usr/local/xwiki/data/cache/solr/search_9
+   ```
+
+2. This is necessary if the openDesk single sign-on does not longer work 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"`
+   - Before those lines add the following line, of course 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>'
+     ```
+   - Restart the XWiki Pod.
+   - Access XWiki's web UI and login with `superadmin` and the above set password.
+   - Once XWiki UI is fully rendered, remove the line with the temporary `superadmin` password from the aforementioned ConfigMap.
+   - Restart the XWiki Pod.
+
+You should have now a properly working XWiki instance with single sign-on and full-text search.
+
+## From v0.9.0
+
+### Pre-upgrade from v0.9.0
+
+#### Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus
+
+> **Warning**<br>
+> The upgrade will fail if you do not address this section for your current deployment.
+
+The update will remove unnecessary OX-Profiles in Nubus, but it can not as long as these profiles are in use.
+
+So please ensure that only the following two supported profiles are assigned to your users:
+- `opendesk_standard`: "opendesk Standard"
+- `none`: "Login disabled"
+
+You can review and update other accounts as follows:
+- Login as IAM admin.
+- Open the user module.
+- Open the extended search by clicking the funnel (DE: "Trichter") icon next to the search input field.
+- Open the "Property" (DE: "Eigenschaft") list and select "OX Access" (DE: "OX-Berechtigung").
+- Enter an asterisk (*) in the input field next to the list.
+- Start the search by clicking once more on the funnel icon.
+- Sort the result list for the "OX Access" column.
+- Edit every user that has a value different to `opendesk_standard` or `none`:
+  - Open the user.
+  - Go to section "OX App Suite".
+  - Change the value in the dropdown "OX Access" to either:
+    - "openDesk Standard" if the user should be able to use the Groupware module or
+    - "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.
+
+#### Configuration Cleanup: Updated `global.imagePullSecrets`
+
+Without using a custom registry, you can pull all the openDesk images without authentication.
+Thus defining not existing imagePullSecrets creates unnecessary errors, so we removed them.
+
+You can keep the current settings by setting the `external-registry` in your custom environment values:
+
+```yaml
+global:
+  imagePullSecrets:
+    - "external-registry"
+```
+
+#### Changed openDesk defaults: Matrix presence status disabled
+
+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:
+
+```yaml
+functional:
+  dataProtection:
+    matrixPresence:
+      enabled: true
+```
+
+#### 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
+Matrix protocol, an update of 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.)
+
+From the user experience perspective, that was a flawed approach, so from openDesk 1.0 on, by default, the username which
+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
+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
+Matrix account from scratch, losing the existing contacts, chats, and rooms.
+
+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")
+- `PUT /_synapse/admin/v2/users/@<entryuuid>:<matrixdomain>` to update user's external_id with JSON payload:
+  `{ "external_ids": [ { "auth_provider": "oidc", "external_id": "<old_id>+deprecated" } ] }`
+- `POST /_synapse/admin/v1/deactivate/@<entryuuid>:<matrixdomain>` to deactivate old user with JSON payload:
+  `{ "erase": true }`
+
+For more details, check the Admin API documentation:
+https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html
+
+You can enforce the old standard with the following setting:
+```yaml
+functional:
+ chat:
+   matrix:
+     profile:
+       useImmutableIdentifierForLocalpart: true
+```
+
+#### Changed openDesk defaults: File-share configurability
+
+Now, we 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).
+
+For the following settings, the default in openDesk 1.0 has changed, so you might want to update
+the settings for your deployment to keep its current behavior:
+
+```yaml
+functional:
+ filestore:
+   sharing:
+     external:
+       enabled: true
+       expiry:
+         activeByDefault: false
+```
+
+#### Changed openDesk defaults: Updated default subdomains in `global.hosts`
+
+We have streamlined the subdomain names in openDesk to be more user-friendly and to avoid the use of specific
+product names.
+
+This results in the following changes to the default subdomain naming:
+
+- **collabora**: `collabora` → `office`
+- **cryptpad**: `cryptpad` → `pad`
+- **minioApi**: `minio` → `objectstore`
+- **minioConsole**: `minio-console` → `objectstore-ui`
+- **nextcloud**: `fs` → `files`
+- **openproject**: `project` → `projects`
+
+Existing deployments should keep the old subdomains cause 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
+to the defaults that were used before the upgrade:
+
+```yaml
+global:
+  hosts:
+    collabora: "collabora"
+    cryptpad: "cryptpad"
+    element: "chat"
+    intercomService: "ics"
+    jitsi: "meet"
+    keycloak: "id"
+    matrixNeoBoardWidget: "matrix-neoboard-widget"
+    matrixNeoChoiceWidget: "matrix-neochoice-widget"
+    matrixNeoDateFixBot: "matrix-neodatefix-bot"
+    matrixNeoDateFixWidget: "matrix-neodatefix-widget"
+    minioApi: "minio"
+    minioConsole: "minio-console"
+    nextcloud: "fs"
+    openproject: "project"
+    openxchange: "webmail"
+    synapse: "matrix"
+    synapseFederation: "matrix-federation"
+    univentionManagementStack: "portal"
+    whiteboard: "whiteboard"
+    xwiki: "wiki"
+```
+
+In case you would like to update an existing deployment to the new hostnames, please check the following list:
+
+- Do this at your own risk.
+- Some of your user's bookmarks and links will stop working.
+- Portal links are getting updated automatically.
+- 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
+  - In OpenProject: *Administration* > *Files* > *External file storages* > Select `Nextcloud at [your_domain]`
+    - Edit *Details* - *General Information* - *Storage provider* and update the *hostname* to `files.<your_domain>`
+  - In Nextcloud: *Administration* > *OpenProject* > *OpenProject server*
+    - Update the *OpenProject host* to `projects.<your_domain>`
+
+#### 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)
+with the following settings:
+
+```yaml
+functional:
+  externalServices:
+    nubus:
+      udmRestApi:
+        enabled: true
+```
+
+With 0.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`.
+
+The IAMs admin account `Administrator` is a member of this group by default, but no other user is.
+
+If you need other accounts to use the API, please assign them to the aforementioned group.
+
+### Post-upgrade from v0.9.0
+
+#### 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.
+
+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:
+- Open the *user* module.
+- Select all users that should get the permission for *Video Conference* using the select box left from the users entry.
+- In top bar of the user table click on *Edit*.
+- Select the *openDesk* section the the left-hand menu.
+- Check the check box 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.
+
+> **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.
+
+#### 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:
+
+```shell
+NAMESPACE=<your_namespace>
+kubectl -n ${NAMESPACE} delete pvc shared-data-ums-ldap-server-0
+kubectl -n ${NAMESPACE} delete pvc shared-run-ums-ldap-server-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
+
+## From v1.0.0 (automated)
+
+With openDesk v1.1.0 the IAM stack supports HA LDAP primary as well as scalable LDAP secondary pods.
+
+openDesk's automated migrations takes care of this upgrade requirement described here for
+[Nubus 1.5.1](https://docs.software-univention.de/nubus-kubernetes-release-notes/1.5.1/en/changelog.html#migrate-existing-ldap-server-to-mirror-mode-readiness),
+creating the config map with the mentioned label.
+
+> **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).
+
+## From v0.9.0 (automated)
+
+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)
+
+> **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).
+
+## 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:
+
+- `migrations-pre`: Is the very first app that gets deployed.
+- `migrations-post`: Is the last app that gets deployed.
+
+Both migrations must be deployed exclusively at their first/last position and not parallel with other components.
+
+The status of the upgrade migrations is tracked in the ConfigMap `migrations-status`, more details can be found in the [README.md of the related container image](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/README.md).
+
+## Development
+
+When a new upgrade migration is required, ensure to address the following list:
+
+- Update the generated release version file [`global.generated.yaml.gotmpl`](../helmfile/environments/default/global.generated.yaml.gotmpl) at least on the patch level to test the upgrade in your feature branch and trigger it in the `develop` branch after the feature branch was merged. During the release process, the value is overwritten by the release's version number.
+- You have to implement the migration logic as a runner script in the [`opendesk-migrations`](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations) image. Please find more instructions in the linked repository.
+- You most likely have to update the [`opendesk-migrations` Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations) within the `rules` section of the [`role.yaml`](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/main/charts/opendesk-migrations/templates/role.yaml) to provide the permissions required for the execution of your migration's logic.
+- You must set the runner's ID you want to execute in the [migrations.yaml.gotmpl](../helmfile/shared/migrations.yaml.gotmpl). See also the `migrations.*` section of [the Helm chart's README.md](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/main/charts/opendesk-migrations/README.md).
+- Update the [`charts.yaml.gotmpl`](../helmfile/environments/default/charts.yaml.gotmpl) and [`images.yaml.gotmpl`](../helmfile/environments/default/images.yaml.gotmpl) to reflect the newer releases of the `opendesk-migrations` Helm chart and container image.
+
+[^1]: We do not follow a brand name's specific spelling when it comes to upper and lower case and only use new word
+uppercase when names consist of multiple, space divided words.

docs/monitoring.md

@@ -0,0 +1,75 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Monitoring</h1>
+
+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.
+
+<!-- TOC -->
+* [Technology](#technology)
+* [Defaults](#defaults)
+* [Metrics](#metrics)
+* [Alerts](#alerts)
+* [Dashboards for Grafana](#dashboards-for-grafana)
+* [Components](#components)
+<!-- TOC -->
+
+# Technology
+
+We provide integration into the 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
+repository or Prometheus operator.
+
+# Defaults
+
+All configurable options and their defaults can be found in
+[`monitoring.yaml.gotmpl`](../helmfile/environments/default/monitoring.yaml.gotmpl).
+
+# Metrics
+
+To deploy `podMonitor` and `serviceMonitor` custom resources, enable it by:
+
+```yaml
+prometheus:
+  serviceMonitors:
+    enabled: true
+  podMonitors:
+    enabled: true
+```
+
+# Alerts
+
+openDesk ships with a set of Prometheus alerting rules that are specific to the operation of openDesk.
+Some of these are created by our partners while others are defined in [opendesk-alerts](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-alerts).
+
+All alert rules are deployed as [PrometheusRule](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.PrometheusRule) and can be enabled like this:
+
+```yaml
+prometheus:
+  prometheusRules:
+    enabled: true
+```
+
+# Dashboards for Grafana
+
+To deploy optional ConfigMaps with Grafana dashboards, enable it by:
+
+```yaml
+grafana:
+  dashboards:
+    enabled: true
+```
+
+# Components
+
+| Component | Metrics (pod- or serviceMonitor)  | Alerts (prometheusRule) | Dashboard (Grafana) |
+|:----------|-----------------------------------|-------------------------|---------------------|
+| Collabora | :white_check_mark:                | :white_check_mark:      | :white_check_mark:  |
+| Nextcloud | :white_check_mark:                | :x:                     | :x:                 |

docs/permissions.md

@@ -0,0 +1,202 @@
+<!--
+SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Roles & Permissions</h1>
+
+openDesk uses role-based access control (RBAC) to manage permissions. This system ensures that users have access only to the resources necessary for their role.
+
+<!-- TOC -->
+* [Identity and Access Management (IAM)](#identity-and-access-management-iam)
+  * [Permissions](#permissions)
+  * [Roles](#roles)
+    * [Application usage](#application-usage)
+    * [Application administration](#application-administration)
+  * [Groups](#groups)
+    * [Global groups](#global-groups)
+    * [Application groups](#application-groups)
+      * [Standard access to applications](#standard-access-to-applications)
+      * [Administrative access to applications](#administrative-access-to-applications)
+    * [Custom groups](#custom-groups)
+  * [Assigning roles/groups and permissions](#assigning-rolesgroups-and-permissions)
+  * [Predefined roles / user templates](#predefined-roles--user-templates)
+    * [*openDesk User*](#opendesk-user)
+    * [*openDesk Administrator*](#opendesk-administrator)
+  * [Managing permissions](#managing-permissions)
+  * [Hierarchies and delegation](#hierarchies-and-delegation)
+  * [Audit/Logging](#auditlogging)
+  * [Reporting](#reporting)
+  * [Delegation](#delegation)
+  * [Regular review](#regular-review)
+* [Applications](#applications)
+  * [Roles/groups](#rolesgroups)
+<!-- TOC -->
+
+# 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.
+
+## Permissions
+
+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.
+
+The overall permissions to access the application as well as group membership of users is managed in the IAM.
+
+## 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:
+
+- **openDesk Administrator**: Manages openDesk-global settings, such as users and groups.
+- **openDesk User**: Can login to openDesk to make use of defined openDesk applications.
+
+> **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.
+
+### 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:
+
+- **Groupware**: Use email, calendar and address book applications.
+- **Chat**: Use the chat application.
+- **Knowledge Management**: Use the wiki application.
+- **Project Management**: Use the project management application.
+- **File Sharing**: Use the file sharing application.
+- **Video Conference**: Use the video conferencing application.
+
+### Application administration
+
+For applications that provide application-specific administrative settings, openDesk defines the following permissions:
+
+- **Knowledge Management Admin**: Manage the wiki application.
+- **Project Management Admin**: Manage the project management application settings.
+- **File Sharing Admin**: Manage the file sharing administrative settings.
+
+## 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.
+
+openDesk predefines the following groups.
+
+### Global groups
+
+- **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).
+- **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.
+
+### 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).
+
+To easily identify these groups all of them are prefixed with `managed-by-Attribute-`.
+
+> **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.
+
+#### Standard access to applications
+
+Unless a user is member of a group the respective application is not shown in the portal.
+
+> **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.
+
+- **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-Projectmanagement**: Members of this group have access to the project management application.
+- **managed-by-Attribute-Knowledgemanagement**: Members of this group have access to the wiki application.
+- **managed-by-Attribute-Livecollaboration**: Members of this group have access to the chat application.
+- **managed-by-Attribute-Videoconference**: Members of this group have access to the video conferencing application.
+
+#### Administrative access to applications
+
+Within some applications it is possible to grant users elevated permissions, these are also primarily managed by attributes from the "openDesk" tab when editing a user, but are also automatically mapped to the following groups:
+
+- **managed-by-Attribute-FileshareAdmin**: Members of this group can administrate the file sharing application.
+- **managed-by-Attribute-ProjectmanagementAdmin**: Members of this group can administrate the project management application.
+- **managed-by-Attribute-KnowledgemanagementAdmin**: Members of this group can administrate the wiki application.
+
+### Custom groups
+
+While openDesk ships with predefined groups, additional groups can be [created](https://docs.opendesk.eu/administration/gruppen/) by an *IAM Administrator*.
+
+## Assigning roles/groups and permissions
+
+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
+
+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/).
+
+> **Notes**<br>
+> Additional/custom templates can be created using the UDM REST API.
+
+### *openDesk User*
+
+The *openDesk User* template sets the primary group to *Domain Users* and initially sets the following permissions:
+
+- **Groupware**: Enabled
+- **Chat**: Enabled
+- **Knowledge Management**: Enabled
+- **Project Management**: Enabled
+- **File Sharing**: Enabled
+- **Video Conference**: Enabled
+- **Knowledge Management Admin**: Disabled
+- **Project Management Admin**: Disabled
+- **File Sharing Admin**: Disabled
+
+### *openDesk Administrator*
+
+The *openDesk Administrator* template sets the primary group to *Domain Admins* and initially sets the following permissions:
+
+- **Groupware**: Disabled
+- **Chat**: Disabled
+- **Knowledge Management**: Disabled
+- **Project Management**: Disabled
+- **File Sharing**: Disabled
+- **Video Conference**: Disabled
+- **Knowledge Management Admin**: Disabled
+- **Project Management Admin**: Disabled
+- **File Sharing Admin**: Disabled
+
+## Managing permissions
+
+*Administrators* can manage permissions of *Users* using the [administration portal](https://docs.opendesk.eu/administration/).
+
+By using roles and permissions, openDesk ensures that users have the appropriate level of access, enhancing both security and efficiency.
+
+## 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.
+
+## 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.
+
+## 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.
+
+## Delegation
+
+Currently the temporary assignment of roles is not supported. Role membership must be managed at the time of granting / revoking the membership.
+
+## 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.
+
+# 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.
+
+## 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/).
+
+> **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>
+> 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.

docs/requirements.md

@@ -0,0 +1,106 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Requirements</h1>
+
+This section covers the internal system requirements and external service requirements for productive use.
+
+<!-- TOC -->
+* [tl;dr](#tldr)
+* [Hardware](#hardware)
+* [Kubernetes](#kubernetes)
+* [Ingress controller](#ingress-controller)
+* [Volume provisioner](#volume-provisioner)
+* [Certificate management](#certificate-management)
+* [External services](#external-services)
+* [Deployment](#deployment)
+<!-- TOC -->
+
+# tl;dr
+
+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/)
+- Domain and DNS Service
+- Ingress controller (Ingress NGINX)
+- [Helm](https://helm.sh/) >= v3.9.0
+- [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v1.0.0-rc5**
+- [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0
+- Volume provisioner supporting RWO (read-write-once)
+- Certificate handling with [cert-manager](https://cert-manager.io/)
+
+# Hardware
+
+The following minimal requirements are thought for initial evaluation deployment:
+
+| Spec | Value                                                 |
+| ---- | ----------------------------------------------------- |
+| CPU  | 12 Cores of x64 or x86 CPU (ARM is not supported yet) |
+| RAM  | 32 GB, more recommended                               |
+| Disk | HDD or SSD, >10 GB                                    |
+
+# Kubernetes
+
+Any self-hosted or managed K8s cluster >= 1.24 listed in
+[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.
+
+> **Note**<br>
+> The deployment is not tested against OpenShift.
+
+# Ingress controller
+
+The deployment is intended to be used only over HTTPS via a configured FQDN, therefore it is required to have a proper
+configured ingress controller deployed.
+
+**Supported controllers:**
+- [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx)
+
+> **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.
+
+# Volume provisioner
+
+Initial evaluation deployment requires a `ReadWriteOnce` volume provisioner. For local deployment, a local- or hostPath-
+provisioner is sufficient.
+
+> **Note**<br>
+> Some components require a `ReadWriteMany` volume provisioner for distributed mode or scaling.
+
+# Certificate management
+
+This deployment leverages [cert-manager](https://cert-manager.io/) to generate valid certificates. This is **optional**,
+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
+openDesk certificate management switched off.
+
+# External services
+
+For the development and evaluation of openDesk, we bundle some services. Be aware that for production
+deployments, you need to make use of your own production-grade services; see the
+[external-services.md](./external-services.md) for configuration details.
+
+| Group    | Type                | Version | Tested against        |
+| -------- | ------------------- | ------- | --------------------- |
+| Cache    | Memcached           | `1.6.x` | Memcached             |
+|          | Redis               | `7.x.x` | Redis                 |
+| Database | MariaDB             | `10.x` | MariaDB               |
+|          | PostgreSQL          | `15.x` | PostgreSQL            |
+| Mail     | Mail Transfer Agent |         | Postfix               |
+|          | PKI/CI (S/MIME)     |         |                       |
+| Security | AntiVirus/ICAP      |         | ClamAV                |
+| Storage  | K8s ReadWriteOnce   |         | Ceph / Cloud specific |
+|          | K8s ReadWriteMany   |         | Ceph / NFS            |
+|          | Object Storage      |         | MinIO                 |
+| Voice    | TURN                |         | Coturn                |
+
+# Deployment
+
+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.
+
+Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare the desired against the deployed state.

docs/scaling.md

@@ -0,0 +1,23 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Scaling</h1>
+
+This document covers the ability to scale applications.
+
+# Horizontal scalability
+
+We are working on generating this document automatically based on the file
+[`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.
+
+# Upstream information
+
+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.
+
+Please find below links to the application's upstream resources about scaling:
+
+- [OpenProject system requirements](https://www.openproject.org/docs/installation-and-operations/system-requirements/)

docs/security-context.md

@@ -0,0 +1,217 @@
+<!--
+SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Kubernetes Security Context</h1>
+
+<!-- TOC -->
+* [Container Security Context](#container-security-context)
+  * [allowPrivilegeEscalation](#allowprivilegeescalation)
+  * [capabilities](#capabilities)
+  * [privileged](#privileged)
+  * [runAsUser](#runasuser)
+  * [runAsGroup](#runasgroup)
+  * [seccompProfile](#seccompprofile)
+  * [readOnlyRootFilesystem](#readonlyrootfilesystem)
+  * [runAsNonRoot](#runasnonroot)
+* [Status quo](#status-quo)
+<!-- TOC -->
+
+# Container Security Context
+
+
+The containerSecurityContext is the most important security-related section because it has the highest precedence and restricts the container to its minimal privileges.
+
+## allowPrivilegeEscalation
+
+
+Privilege escalation (such as via set-user-ID or set-group-ID file mode) should not be allowed (Linux only) at any time.
+
+```yaml
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+```
+
+## capabilities
+
+
+Containers must drop ALL capabilities, and are only permitted to add back the `NET_BIND_SERVICE` capability (Linux only).
+
+
+**Optimal:**
+
+```yaml
+containerSecurityContext:
+  capabilities:
+    drop:
+      - "ALL"
+```
+
+
+**Allowed:**
+
+```yaml
+containerSecurityContext:
+  capabilities:
+    drop:
+      - "ALL"
+    add:
+      - "NET_BIND_SERVICE"
+```
+
+## privileged
+
+
+Privileged Pods disable most security mechanisms and must be disallowed.
+
+```yaml
+containerSecurityContext:
+  privileged: false
+```
+
+## runAsUser
+
+
+Containers should set a user id >= 1000 and never use 0 (root) as user.
+
+```yaml
+containerSecurityContext:
+  runAsUser: 1000
+```
+
+## runAsGroup
+
+
+Containers should set a group id >= 1000 and never use 0 (root) as user.
+
+```yaml
+containerSecurityContext:
+  runAsGroup: 1000
+```
+
+## seccompProfile
+
+
+Seccomp profile must be explicitly set to one of the allowed values. An unconfined profile and the complete absence of the profile are prohibited.
+
+```yaml
+containerSecurityContext:
+  seccompProfile:
+    type: "RuntimeDefault"
+```
+
+
+or
+
+```yaml
+containerSecurityContext:
+  seccompProfile:
+    type: "Localhost"
+```
+
+## readOnlyRootFilesystem
+
+
+Containers should have an immutable file systems, so that attackers could not modify application code or download malicious code.
+
+```yaml
+containerSecurityContext:
+  readOnlyRootFilesystem: true
+```
+
+## runAsNonRoot
+
+
+Containers must be required to run as non-root users.
+
+```yaml
+containerSecurityContext:
+  runAsNonRoot: true
+```
+
+# Status quo
+
+
+openDesk aims to achieve that all security relevant settings are explicitly templated and comply with security recommendations.
+
+
+The rendered manifests are also validated against Kyverno [policies](/.kyverno/policies) in CI to ensure that the provided values inside openDesk are also properly templated by the given Helm charts.
+
+
+This list gives you an overview of templated security settings and if they comply with security standards:
+
+
+ - **yes**: Value is set to `true`
+ - **no**: Value is set to `false`
+ - **n/a**: No explicitly templated in openDesk and default is used.
+
+| process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities |
+| ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ |
+| **collabora**/collabora-online | :x: | yes | no | no | yes | 100 | 101 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT","MKNOD"] |
+| **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-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/matrix-neodatefix-bot | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/matrix-neodatefix-bot-bootstrap | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/matrix-neodatefix-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/opendesk-element | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/opendesk-matrix-user-verification-service | :x: | no | no | no | no | 0 | 0 | yes | yes |
+| **element**/opendesk-matrix-user-verification-service-bootstrap | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/opendesk-synapse | :white_check_mark: | no | no | yes | yes | 10991 | 10991 | yes | yes |
+| **element**/opendesk-synapse-web | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **element**/opendesk-well-known | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
+| **jitsi**/jitsi | :white_check_mark: | no | no | yes | yes | 1993 | 1993 | yes | yes |
+| **jitsi**/jitsi/jitsi/jibri | :x: | n/a | n/a | n/a | n/a | n/a | n/a | n/a | no ["SYS_ADMIN"] |
+| **jitsi**/jitsi/jitsi/jicofo | :x: | no | no | no | no | 0 | 0 | yes | no |
+| **jitsi**/jitsi/jitsi/jvb | :x: | no | no | no | no | 0 | 0 | yes | no |
+| **jitsi**/jitsi/jitsi/prosody | :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 |
+| **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 65532 | 65532 | yes | yes |
+| **nextcloud**/opendesk-nextcloud/apache2 | :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 |
+| **nextcloud**/opendesk-nextcloud/php | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | 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**/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-imageconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/appsuite/core-mw/gotenberg | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
+| **open-xchange**/open-xchange/appsuite/core-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/appsuite/core-ui-middleware | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/appsuite/core-user-guide | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/appsuite/guard-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/nextcloud-integration-ui | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/open-xchange/public-sector-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **openproject**/openproject | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **openproject-bootstrap**/opendesk-openproject-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **open-xchange**/ox-connector | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
+| **services**/clamav | :x: | no | no | yes | no | 0 | 0 | yes | no |
+| **services**/clamav-simple | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
+| **services**/clamav/clamd | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
+| **services**/clamav/freshclam | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
+| **services**/clamav/icap | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
+| **services**/clamav/milter | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
+| **services**/mariadb | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
+| **services**/memcached | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
+| **services**/minio | :x: | no | no | no | yes | 1000 | 0 | yes | yes |
+| **services**/postfix | :x: | yes | yes | no | no | 0 | 0 | yes | no |
+| **services**/postgresql | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
+| **services**/redis/master | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
+| **univention-management-stack**/intercom-service | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/opendesk-keycloak-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/ums/keycloak | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/ums/keycloak-bootstrap | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/ums/keycloak-extensions/handler | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/ums/keycloak-extensions/proxy | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
+| **univention-management-stack**/ums/ldap-notifier | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
+| **univention-management-stack**/ums/portal-listener | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
+| **univention-management-stack**/ums/selfservice-listener | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
+| **univention-management-stack**/ums/stack-data-swp | :x: | no | no | no | no | 0 | 0 | yes | yes |
+| **univention-management-stack**/ums/stack-gateway | :x: | no | no | no | yes | 1001 | 0 | yes | yes |
+| **univention-management-stack**/ums/umc-gateway | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
+| **univention-management-stack**/ums/umc-server | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
+| **xwiki**/xwiki | :x: | no | no | no | yes | 100 | 101 | yes | yes |
+
+
+This file is auto-generated by [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli)

docs/security.md

@@ -0,0 +1,51 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Security</h1>
+
+This document should cover the current status of security measurements.
+
+<!-- TOC -->
+* [Helm Chart Trust Chain](#helm-chart-trust-chain)
+* [Kubernetes Security Enforcements](#kubernetes-security-enforcements)
+* [NetworkPolicies](#networkpolicies)
+<!-- TOC -->
+
+# Helm Chart Trust Chain
+
+Helm charts are signed and validated against GPG keys in `helmfile/files/gpg-pubkeys`.
+
+For more details on Chart validation, please visit: https://helm.sh/docs/topics/provenance/
+
+All charts except the ones mentioned below are verifiable:
+
+| Repository        | Verifiable |
+|-------------------|:----------:|
+| open-xchange-repo |     no     |
+
+# Kubernetes Security Enforcements
+
+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.
+
+# NetworkPolicies
+
+Kubernetes NetworkPolicies are an essential measure to secure your Kubernetes apps and clusters.
+When applied, they restrict the traffic to your services.
+This protects other deployments in your cluster or other services in your deployment from getting compromised when one
+component is compromised.
+
+We ship a default set of Otterize ClientIntents via
+[Otterize intents operator](https://github.com/otterize/intents-operator) which translates intent-based access control
+(IBAC) into Kubernetes native NetworkPolicies.
+
+This requires the Otterize intents operator to be installed.
+
+```yaml
+security:
+  otterizeIntents:
+    enabled: true
+```

docs/theming.md

@@ -0,0 +1,30 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Theming</h1>
+
+This document covers the theming options for an openDesk deployment.
+
+<!-- TOC -->
+* [Settings](#settings)
+* [Known limitations](#known-limitations)
+<!-- TOC -->
+
+# Settings
+
+All default settings can be found in the [`theme.gotmpl`](../helmfile/environments/default/theme.gotmpl). Most of the components adhere to these settings.
+
+Please review the default configuration that is applied to understand your customization options.
+
+You can just update the files in:
+- [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.
+
+# Known limitations
+
+Not all applications support theming. Known exceptions are:
+- 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).

docs/workflow.md

@@ -0,0 +1,389 @@
+<!--
+SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<h1>Technical development and release workflow</h1>
+
+<!-- TOC -->
+* [Scope](#scope)
+* [Roles and responsibilities](#roles-and-responsibilities)
+* [Deployment automation](#deployment-automation)
+  * [openDesk technical component classes](#opendesk-technical-component-classes)
+  * [Functional vs. service components](#functional-vs-service-components)
+  * [Origins](#origins)
+  * [Reference CI for creating Images and Helm charts (gitlab-config)](#reference-ci-for-creating-images-and-helm-charts-gitlab-config)
+  * [Licensing](#licensing)
+  * [Development workflow](#development-workflow)
+    * [Disclaimer](#disclaimer)
+    * [Workflow](#workflow)
+      * [Branching concept](#branching-concept)
+      * [Standard Quality Gate (SQG)](#standard-quality-gate-sqg)
+      * [Branch workflows](#branch-workflows)
+        * [`main`](#main)
+        * [`develop`](#develop)
+        * [`docs`](#docs)
+        * [`fix`](#fix)
+        * [`feat`](#feat)
+      * [Branch names](#branch-names)
+      * [Commit messages / Conventional Commits](#commit-messages--conventional-commits)
+      * [Verified commits](#verified-commits)
+* [Footnotes](#footnotes)
+<!-- TOC -->
+
+# Scope
+
+This document covers the development of a technical release, thereby addressing
+- the development and branching concept for the openDesk deployment automation,
+- the related quality gates and
+- how technical releases are being created.
+
+It does not cover additional artifacts that might be related to a functional release.
+
+# Roles and responsibilities
+
+The following section should provide a high-level view of the involved parties in the openDesk context and their responsibilities:
+
+- **Open source product suppliers**
+  - Focus areas
+    - Development of upstream products
+    - Development of integrative functionality relevant to openDesk and others
+    - Providing source code and the artifacts required to install openDesk to Open CoDE
+  - Hand over to _openDesk platform development_
+    - Helm charts
+    - Container images
+    - Documentation
+- **openDesk platform development**
+  - Focus areas
+    - 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 the required quality gates (QG)
+    - Ensuring the quality gates are passed
+  - Hand over to _Operator_
+    - Deployment automation
+- **Operator**
+  - Focus areas
+    - Providing production-grade required services (e.g. persistence layer) to operate 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
+  - The operator can either use a self-operated Kubernetes cluster to deploy openDesk or make use of managed Kubernetes offerings of a **Cloud Provider**.
+
+# Deployment automation
+
+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.
+
+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.
+
+## openDesk technical component classes
+
+The below rendering in 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 second section shows the **methods** like linting that must be applied to that class's artifacts.
+
+> **Note**<br>
+> The methods prefixed with '-' are not yet available in `gitlab-config`. You will learn about them later.
+
+```mermaid
+classDiagram
+ Images <|-- Helm_charts
+ Images <|-- Helmfile_based_deployment_automation
+ Helm_charts <|-- Helmfile_based_deployment_automation
+ class Images{
+ SBOM
+ SBOM signature
+ Image signature
+ reuseLint()
+ CVE analysis()
+ hadolint()
+ Malware scan()
+ }
+ class Helm_charts{
+ HelmDocs
+ Helm chart signature
+ reuseLint()
+ KubeLinter()
+ YamlLint()
+ -Kubescape()
+ }
+ class Helmfile_based_deployment_automation{
+ reuseLint()
+ YamlLint()
+ -markdownlint()
+ }
+```
+
+## 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.
+
+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).
+
+## Origins
+
+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).
+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.
+
+## Reference CI for creating Images and Helm charts (gitlab-config)
+
+As mentioned in the chapter "Origins" above, the openDesk platform development also creates images and Helm charts when needed.
+
+For that purpose openDesk provides a [GitLab CI-based reference implementation](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/tooling/gitlab-config) called `gitlab-config` to achieve the required characteristics and apply the necessary methods including releasing the artifacts based on [Semantic Release](https://github.com/semantic-release/semantic-release#readme) into the GitLab container registry.
+
+## Licensing
+
+As a standard, the openDesk platform development team uses [reuse.software](https://reuse.software/) wherever possible to annotate license and copyright.
+
+openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this:
+```
+# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+# 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).
+
+> **Note**<br>
+> If an `SPDX-FileCopyrightText` already exists, do not replace but add an additional line based on the above example.
+
+## Development workflow
+
+### 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:
+- 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.
+
+### Workflow
+
+This chapter describes the deployment automation's development workflow. The suppliers have their own development processes and workflows. While we aim to always update to the most recent community version(s) available, openDesk also sponsors the development done by the suppliers. As the openDesk team has to take a closer look at these sponsored features, they are referred to as *supplier deliverables* within the platform development workflow.
+
+#### Branching concept
+
+The picture below uses Gitflow notation to give an overview of the different types of development flows.
+
+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`)
+- 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.
+- When a *feature* branch gets pushed a Merge Request in `Draft` state is automatically created.
+- We know three types of *feature* branches:
+  - `docs`: Doing just documentation 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
+    - supplier deliverables and
+    - configurational changes that have a significant impact on openDesk users or require migrations[^1]
+- 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.
+
+```mermaid
+gitGraph
+ commit id: "QA 'nightly main'"
+ commit id: " "
+ branch "develop"
+ checkout "develop"
+ commit id: "QA 'nightly develop'"
+ commit id: "  "
+ branch "docs"
+ checkout "docs"
+ commit id: "Documentation commits" type: HIGHLIGHT
+ checkout "develop"
+ merge "docs"
+ checkout "main"
+ merge "develop" tag: "No release"
+ checkout "develop"
+ commit id: "   "
+ branch "fix"
+ checkout "fix"
+ commit id: "Maintenance commits" type: HIGHLIGHT
+ commit id: "QG 'fix'" type: REVERSE
+ checkout "develop"
+ merge "fix"
+ commit id: "QA 'release merge'" type: REVERSE
+ checkout "main"
+ merge "develop" tag: "Patch or minor release"
+ checkout "develop"
+ commit id: "    "
+ branch "feat"
+ checkout "feat"
+ commit id: "Feature commits" type: HIGHLIGHT
+ commit id: "QG 'feat'" type: REVERSE
+ commit id: "Manual Feature QA" type: REVERSE
+ commit id: "Develop Tests"
+ commit id: "Documentation"
+ checkout "develop"
+ merge "feat"
+ commit id: "QA 'release merge' " type: REVERSE
+ checkout "main"
+ merge "develop" tag: "Minor or major release"
+ checkout "develop"
+ checkout "main"
+ commit id: "     "
+ commit id: "Manual Functional Release Activities" type: HIGHLIGHT
+ commit id: "      "
+```
+
+#### Standard Quality Gate (SQG)
+
+The Standard Quality Gate addresses quality assurance steps that should be executed within each of the mentioned quality gates in the workflow.
+
+1. Linting
+   - Blocking
+     - 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).
+   - Non-Blocking
+     - Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
+     - Formal: Yaml
+1. Deploy the full openDesk stack from scratch:
+   - All deployment steps must be successful (green)
+   - 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:
+   - Deploy the current merge target baseline (`develop` or `main`)
+   - Update deploy from your QA branch into the instance from the previous step
+1. No showstopper found regarding
+   - SBOM compliance[^4]
+   - Malware check
+   - CVE check[^5]
+   - Kubescape scan[^5]
+
+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.
+
+```mermaid
+flowchart TD
+ A[<u><b>Container image</b></u>
+ checks during build time
+ e.g. based on openDesk
+ reference implementation 'gitlab-config'.
+ >> Can the artifact be integrated? <<
+ ] -->|integrate artifacts| B[<u><b>Deployment automation</b></u> SQG
+ based on GitLab CI, during
+ technical release process.
+ >> Can the platform be released? <<
+ ]
+ B-->|release| C[<u><b>openDesk release</b></u> monitoring
+ on a regular e.g. daily or live basis.
+ >> Do we need to fix something? <<
+ ]
+```
+
+#### Branch workflows
+
+This section will explain the workflow for each branch (type) based on the Gitflow picture from above.
+
+##### `main`
+
+- `QA 'nightly main'`: Execute the SQG based on the most recent release. The upgrade test environment should be a long-standing environment that only gets built from scratch with the previous technical release when something breaks the environment.
+Merge points: We are using the [Semantic Release convention](https://github.com/semantic-release/semantic-release), which is based on the [Semantic Versioning (SemVer) notation](https://semver.org), to automatically create technical releases on the merge points.
+  - "No release": When a merge from `develop` includes only changes from `docs` branches, the merge into `main` will only consist of `docs` or `chore` commits. That merge will generate no new release.
+  - "Patch or minor release": When changes from `fix` branches get merged, these might contain `fix` or `feat` commits, causing a new technical release to be built with an updated version on the Patch or Minor level.
+  - "Minor or major release": When changes from `feat` branches get merged, these might contain `feat` commits even with breaking changes, causing a technical release to be built with an updated version on the Minor or Major level.
+- "Manual Functional Release Activities": Technical releases are loosely coupled to functional releases. The additional activities for a functional release select an existing technical release as a basis to generate the artifacts required for a functional release, for example:
+  - Conduct additional manual explorative and regression tests.
+  - Perform checks like IT Grundschutz, Accessibility, or Data Protection.
+
+##### `develop`
+
+- `QA 'nightly develop'`: Follows the same approach as `QA 'nightly main'` - execute the SQG based on the head revision of the `develop` branch.
+- `QA 'release merge'`: The Merge Request for this merge has to be created manually by members of the platform development team. It should document:
+  - 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.
+  - 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.
+
+##### `docs`
+
+Branches of type `docs` only contain the commits themselves and have to adhere to the workflow basic fact that: All merges into `develop` or `main` require two approvals from the platform development team.
+
+##### `fix`
+
+Besides the actual changes being committed in an `fix` branch, there is only the:
+- `QG 'fix'`: Besides validating the actual change, the branch's owner has to ensure the successful execution of the SQG.
+
+##### `feat`
+
+This branch type requires the most activities on top of the actual development:
+- `QG 'feat'`: The branch owner has to validate the implemented functionality and ensure the SQG is passed successfully.
+- `Manual Feature QA`:
+  - This is the interface between the platform development workflow and the supplier work package workflow.
+  - The openDesk QA team validates the change, ideally based on the acceptance criteria defined in the supplier's work package definition.
+    - QA passes on the feedback to the developer/supplier if improvements are needed.
+    - Test cases for the feature's test automation are defined if the QA was successful.
+    - QA should also evaluate if there is a need for end-user documentation of the feature.
+- `Develop Test`: The test cases are implemented by the openDesk platform development and added to the openDesk end-to-end test suite.
+- `Documentation`: When required, the documentation team has to update the end-user documentation.
+
+#### Branch names
+
+Branches created from the `develop` branch have to adhere to the following notation: `<responsible_developer>/<type>_<details>`:
+
+- `<responsible_developer>`: Something that makes you identifiable as the owner of the branch, e.g. the first letter of your first name followed by your family name.
+- `<type>`: From the list of branch types explained above:
+  - `docs`
+  - `fix`
+  - `feat`
+- `<details>`: A very short note about what is going to happen in the branch and ideally what component is affected from the following list of components:
+  - `helmfile`
+  - `ci`
+  - `docs`
+  - `collabora`
+  - `cryptpad`
+  - `element`
+  - `jitsi`
+  - `nextcloud`
+  - `nubus`
+  - `open-xchange`
+  - `openproject`
+  - `services`
+  - `xwiki`
+
+Example: `tmueller/fix_jitsi_theming`.
+
+> **Note**<br>
+> The above naming convention has yet to be enforced, but please ensure you use it.
+
+#### Commit messages / Conventional Commits
+
+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.
+
+```text
+<type>(<scope>): [path/to/issue#1] <short summary>.
+ │       │              │                │
+ │       │              |                └─> Summary in present tense, sentence case, with no period at the end
+ │       │              |
+ │       │              └─> Issue reference (optional)
+ │       │
+ │       └─> Commit Scope: helmfile, docs, collabora, nextcloud, open-xchange, etc.
+ │
+ └─> Commit Type: chore, ci, docs, feat, fix
+```
+
+Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.`
+
+> **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.
+
+#### Verified commits
+
+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/ee/user/project/repository/gpg_signed_commits/
+- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/
+
+# 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
+
+[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.
+
+[^3]: As long as migrations/upgrade paths are not provided - see also footnote #1 - this step is optional.
+
+[^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.

helmfile.yaml

@@ -1,47 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-#
-# Advanced Configuration: Nested States
-#
-helmfiles:
-  # Path to the helmfile state file being processed BEFORE releases in this state file
-  - path: "helmfile/apps/services/helmfile.yaml"
-  - path: "helmfile/apps/keycloak/helmfile.yaml"
-  - path: "helmfile/apps/univention-corporate-container/helmfile.yaml"
-  - path: "helmfile/apps/univention-management-stack/helmfile.yaml"
-  - path: "helmfile/apps/keycloak-bootstrap/helmfile.yaml"
-  - path: "helmfile/apps/intercom-service/helmfile.yaml"
-  - path: "helmfile/apps/open-xchange/helmfile.yaml"
-  - path: "helmfile/apps/nextcloud/helmfile.yaml"
-  - path: "helmfile/apps/collabora/helmfile.yaml"
-  - path: "helmfile/apps/jitsi/helmfile.yaml"
-  - path: "helmfile/apps/element/helmfile.yaml"
-  - path: "helmfile/apps/openproject/helmfile.yaml"
-  - path: "helmfile/apps/xwiki/helmfile.yaml"
-  - path: "helmfile/apps/provisioning/helmfile.yaml"
-
-missingFileHandler: "Error"
-
-# Environment is defined here and in helmfile/bases/environments.yaml
-# This is a temporary solution to solve issue with different (relative) paths required when
-# - Installing all releases from root via helmfile apply
-# - Installing a single release from root via helmfile apply -f helmfile/apps/<app>/helmfile.yaml
-# - Installing a single release from app directory via helmfile apply
-# Issue: https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace/-/issues/2
-environments:
-  default:
-    values:
-      - "helmfile/environments/default/*.gotmpl"
-      - "helmfile/environments/default/*.yaml"
-  dev:
-    values:
-      - "helmfile/environments/default/*.gotmpl"
-      - "helmfile/environments/default/*.yaml"
-      - "helmfile/environments/dev/values.yaml"
-  prod:
-    values:
-      - "helmfile/environments/default/*.gotmpl"
-      - "helmfile/environments/default/*.yaml"
-      - "helmfile/environments/prod/values.yaml"
-...

helmfile.yaml.gotmpl

@@ -0,0 +1,29 @@
+# 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
+---
+environments:
+  dev:
+    values:
+      - "helmfile/environments/dev/*.yaml.gotmpl"
+  test:
+    values:
+      - "helmfile/environments/test/*.yaml.gotmpl"
+  prod:
+    values:
+      - "helmfile/environments/prod/*.yaml.gotmpl"
+---
+# yamllint disable
+helmfiles:
+  - path: "./helmfile_generic.yaml.gotmpl"
+    values:
+      - {{ toYaml .Values | nindent 8 }}
+# {{/*
+#
+#   Use this format from a remote repository
+#
+#   - path: "git::https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git@helmfile_generic.yaml.gotmpl?ref=v0.7.1"
+#     values:
+#       - {{ toYaml .Values | nindent 8 }}
+# */}}
+...

helmfile/apps/collabora/helmfile-child.yaml.gotmpl

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+# SPDX-License-Identifier: Apache-2.0
+---
+repositories:
+  # Collabora Online
+  # Source: https://github.com/CollaboraOnline/online
+  - name: "collabora-online-repo"
+    keyring: "../../files/gpg-pubkeys/collaboraoffice-com.gpg"
+    verify: {{ .Values.charts.collabora.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.collabora.registry }}/{{ .Values.charts.collabora.repository }}"
+
+  # Collabora Controller - Enterprise Only
+  # Source: https://github.com/CollaboraOnline/online
+  - name: "collabora-controller-repo"
+    keyring: "../../files/gpg-pubkeys/collaboraoffice-com.gpg"
+    verify: {{ .Values.charts.collaboraController.verify }}
+    username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.collaboraController.registry }}/{{ .Values.charts.collaboraController.repository }}"
+
+releases:
+  - name: "collabora-online"
+    chart: "collabora-online-repo/{{ .Values.charts.collabora.name }}"
+    version: "{{ .Values.charts.collabora.version }}"
+    values:
+      - "values.yaml.gotmpl"
+      {{ range .Values.customization.release.collaboraOnline }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.collabora.enabled }}
+  - name: "collabora-controller"
+    chart: "collabora-controller-repo/{{ .Values.charts.collaboraController.name }}"
+    version: "{{ .Values.charts.collaboraController.version }}"
+    values:
+      {{ range .Values.customization.release.collaboraController }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.collaboraController.enabled }}
+
+commonLabels:
+  deployStage: "050-components"
+  component: "collabora"
+...

helmfile/apps/collabora/helmfile.yaml

@@ -1,25 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-repositories:
-  - name: "collabora-online-repo"
-    url: >-
-      {{ env "PRIVATE_CHART_REPOSITORY_URL" |
-         default "https://collaboraonline.github.io/online" }}
-
-releases:
-  - name: "collabora-online"
-    chart: "collabora-online-repo/collabora-online"
-    version: "1.0.2"
-    values:
-      - "values.yaml"
-      - "values.gotmpl"
-    condition: "collabora.enabled"
-
-commonLabels:
-  deploy-stage: "component-1"
-  component: "collabora"
-
-bases:
-  - "../../bases/environments.yaml"
-...

helmfile/apps/collabora/helmfile.yaml.gotmpl

@@ -0,0 +1,12 @@
+# 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
+---
+bases:
+  - "../../bases/environments.yaml"
+---
+helmfiles:
+  - path: "./helmfile-child.yaml.gotmpl"
+    values:
+      - {{ toYaml .Values | nindent 8 }}
+...

helmfile/apps/collabora/values.gotmpl

@@ -1,41 +0,0 @@
-{{/*
-SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-SPDX-License-Identifier: Apache-2.0
-*/}}
----
-image:
-  repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.collabora.repository }}"
-  tag: "{{ .Values.images.collabora.tag }}"
-  pullPolicy: "{{ .Values.global.imagePullPolicy }}"
-
-imagePullSecrets:
-{{- range .Values.global.imagePullSecrets }}
-  - name: {{ . }}
-{{- end }}
-
-ingress:
-  enabled: {{ .Values.ingress.enabled }}
-  className: "{{ .Values.ingress.ingressClassName }}"
-  hosts:
-    - host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
-      paths:
-        - path: "/"
-          pathType: "Prefix"
-  tls:
-    - secretName: "{{ .Values.ingress.tls.secretName }}"
-      hosts:
-        - "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
-
-collabora:
-  # Admin Console Credentials: https://CODE-domain/browser/dist/admin/admin.html
-  username: "collabora-internal-admin"
-  password: {{ .Values.secrets.collabora.adminPassword }}
-  aliasgroups:
-    - host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}:443"
-
-
-replicaCount: {{ .Values.replicas.collabora }}
-
-resources:
-  {{ .Values.resources.collabora | toYaml | nindent 2 }}
-...

helmfile/apps/collabora/values.yaml

@@ -1,87 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-# https://github.com/CollaboraOnline/online/blob/master/kubernetes/helm/README.md or
-# https://github.com/CollaboraOnline/online/blob/master/kubernetes/helm/collabora-online/values.yaml
-
-fullnameOverride: "collabora"
-
-image:
-  pullPolicy: "IfNotPresent"
-
-collabora:
-  extra_params: "--o:ssl.enable=false --o:ssl.termination=true"
-
-ingress:
-  annotations:
-    # Ingress NGINX
-    nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_WOPISrc"
-    nginx.ingress.kubernetes.io/proxy-body-size: "0"
-    nginx.ingress.kubernetes.io/proxy-read-timeout: "600"
-    nginx.ingress.kubernetes.io/proxy-send-timeout: "600"
-    nginx.ingress.kubernetes.io/server-snippet: |
-      # 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; }
-    # NGINX
-    nginx.org/websocket-services: "collabora"
-    nginx.org/lb-method: "hash $arg_WOPISrc consistent"
-    nginx.org/proxy-read-timeout: "600"
-    nginx.org/proxy-send-timeout: "600"
-    nginx.org/client-max-body-size: "0"
-    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: "3600s"
-    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: "3600s"
-    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
-autoscaling:
-  enabled: false
-
-serviceAccount:
-  create: true
-
-securityContext:
-  allowPrivilegeEscalation: true
-  privileged: false
-  readOnlyRootFilesystem: false
-  runAsNonRoot: true
-  runAsUser: 100
-  runAsGroup: 101
-  seccompProfile:
-    type: "RuntimeDefault"
-  capabilities:
-    drop:
-      - "ALL"
-    add:
-      - "CHOWN"
-      - "DAC_OVERRIDE"
-      - "FOWNER"
-      - "FSETID"
-      - "KILL"
-      - "SETGID"
-      - "SETUID"
-      - "SETPCAP"
-      - "NET_BIND_SERVICE"
-      - "NET_RAW"
-      - "SYS_CHROOT"
-      - "MKNOD"
-
-podSecurityContext:
-  fsGroup: 100
-...

helmfile/apps/collabora/values.yaml.gotmpl

@@ -0,0 +1,118 @@
+{{/*
+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
+*/}}
+---
+autoscaling:
+  enabled: false
+
+collabora:
+  aliasgroups:
+    - host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
+  env:
+    - name: "POD_NAME"
+      valueFrom:
+        fieldRef:
+          fieldPath: "metadata.name"
+  extra_params: >
+    --o:ssl.enable=false
+    --o:ssl.termination=true
+    --o:fetch_update_check=0
+    --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:net.proto={{ if eq .Values.cluster.networking.ipFamilies "DualStack" }}all{{ else }}{{ .Values.cluster.networking.ipFamilies }}{{ end }}
+    {{- if .Values.debug.enabled }}
+    --o:logging.level=debug
+    {{- else }}
+    --o:logging.anonymize.anonymize_user_data=true
+    {{- end }}
+    {{- if .Values.collaboraController.enabled }}
+    --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][@retryInterval]=5
+    {{- end }}
+  username: "collabora-internal-admin"
+  password: {{ .Values.secrets.collabora.adminPassword | quote }}
+
+fullnameOverride: "collabora"
+
+image:
+  repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"
+  tag: {{ .Values.images.collabora.tag | quote }}
+  pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+
+imagePullSecrets:
+{{- range .Values.global.imagePullSecrets }}
+  - name: {{ . | quote }}
+{{- end }}
+
+ingress:
+  annotations:
+    {{- if .Values.collaboraController.enabled }}
+    nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_RouteToken"
+    {{- else }}
+    nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_WOPISrc"
+    {{- end }}
+    nginx.ingress.kubernetes.io/proxy-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
+    nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}"
+    nginx.ingress.kubernetes.io/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}"
+    nginx.ingress.kubernetes.io/server-snippet: |
+      # 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; }
+  enabled: {{ .Values.ingress.enabled }}
+  className: {{ .Values.ingress.ingressClassName | quote }}
+  hosts:
+    - host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
+      paths:
+        - path: "/"
+          pathType: "Prefix"
+  tls:
+    - secretName: {{ .Values.ingress.tls.secretName | quote }}
+      hosts:
+        - "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
+
+podAnnotations: {}
+
+podSecurityContext:
+  fsGroup: 100
+
+prometheus:
+  servicemonitor:
+    enabled: {{ .Values.monitoring.prometheus.serviceMonitors.enabled }}
+    labels:
+      {{ .Values.monitoring.prometheus.serviceMonitors.labels | toYaml | nindent 6 }}
+  rules:
+    enabled: {{ .Values.monitoring.prometheus.prometheusRules.enabled }}
+    additionalLabels:
+      {{ .Values.monitoring.prometheus.prometheusRules.labels | toYaml | nindent 6 }}
+
+replicaCount: {{ .Values.replicas.collabora }}
+
+resources:
+  {{ .Values.resources.collabora | toYaml | nindent 2 }}
+
+securityContext:
+  allowPrivilegeEscalation: true
+  privileged: false
+  readOnlyRootFilesystem: false
+  runAsNonRoot: true
+  runAsUser: 100
+  runAsGroup: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  capabilities:
+    drop:
+      - "ALL"
+    add:
+      - "CHOWN"
+      - "FOWNER"
+      - "SYS_CHROOT"
+
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.collabora | toYaml | nindent 4 }}
+serviceAccount:
+  create: true
+...

helmfile/apps/cryptpad/helmfile-child.yaml.gotmpl

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
+# SPDX-License-Identifier: Apache-2.0
+---
+repositories:
+  # CryptPad
+  # Source: https://github.com/cryptpad/helm
+  - name: "cryptpad-repo"
+    keyring: "../../files/gpg-pubkeys/xwiki-com.gpg"
+    verify: {{ .Values.charts.cryptpad.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.cryptpad.registry }}/{{ .Values.charts.cryptpad.repository }}"
+
+releases:
+  - name: "cryptpad"
+    chart: "cryptpad-repo/{{ .Values.charts.cryptpad.name }}"
+    version: "{{ .Values.charts.cryptpad.version }}"
+    values:
+      - "values.yaml.gotmpl"
+      {{ range .Values.customization.release.cryptpad }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.cryptpad.enabled }}
+
+commonLabels:
+  deployStage: "050-components"
+  component: "cryptpad"
+...

helmfile/apps/cryptpad/helmfile.yaml.gotmpl

@@ -0,0 +1,12 @@
+# 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
+---
+bases:
+  - "../../bases/environments.yaml"
+---
+helmfiles:
+  - path: "./helmfile-child.yaml.gotmpl"
+    values:
+      - {{ toYaml .Values | nindent 8 }}
+...

helmfile/apps/cryptpad/values.yaml.gotmpl

@@ -0,0 +1,86 @@
+{{/*
+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
+*/}}
+---
+# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/README.md or
+# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/values.yaml
+
+# Disable registration and access to unregistered users:
+# (https://docs.cryptpad.org/en/admin_guide/customization.html#application-config)
+
+application_config:
+  availablePadTypes:
+    - "diagram"
+
+# Deactivating public access breaks nextcloud plugin!
+#  registeredOnlyTypes:
+#    - "diagram"
+
+autoscaling:
+  enabled: false
+
+enableEmbedding: true
+
+fullnameOverride: "cryptpad"
+
+image:
+  repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.cryptpad.registry }}/{{ .Values.images.cryptpad.repository }}"
+  tag: {{ .Values.images.cryptpad.tag | quote }}
+  pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+
+imagePullSecrets:
+{{- range .Values.global.imagePullSecrets }}
+  - name: {{ . | quote }}
+{{- end }}
+
+ingress:
+  enabled: {{ .Values.ingress.enabled }}
+  annotations:
+    nginx.org/websocket-services: "cryptpad"
+  className: {{ .Values.ingress.ingressClassName | quote }}
+  hosts:
+    - host: "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}"
+      paths:
+        - path: "/"
+          pathType: "ImplementationSpecific"
+  tls:
+    - secretName: {{ .Values.ingress.tls.secretName | quote }}
+      hosts:
+        - "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}"
+
+persistence:
+  enabled: false
+
+podAnnotations: {}
+
+podSecurityContext:
+  fsGroup: 4001
+
+replicaCount: {{ .Values.replicas.cryptpad }}
+
+resources:
+  {{ .Values.resources.cryptpad | toYaml | nindent 2 }}
+
+securityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  privileged: false
+  seccompProfile:
+    type: "RuntimeDefault"
+  readOnlyRootFilesystem: false
+  runAsNonRoot: true
+  runAsUser: 4001
+  runAsGroup: 4001
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.cryptpad | toYaml | nindent 4 }}
+
+serviceAccount:
+  create: true
+
+workloadStateful: false
+
+...

helmfile/apps/element/helmfile-child.yaml.gotmpl

@@ -0,0 +1,289 @@
+# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
+# SPDX-License-Identifier: Apache-2.0
+---
+repositories:
+  # openDesk Element
+  # Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-element
+  - name: "element-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.element.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.element.registry }}/{{ .Values.charts.element.repository }}"
+  - name: "element-well-known-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.elementWellKnown.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.elementWellKnown.registry }}/{{ .Values.charts.elementWellKnown.repository }}"
+  - name: "synapse-web-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapseWeb.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseWeb.registry }}/{{ .Values.charts.synapseWeb.repository }}"
+  - name: "synapse-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapse.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapse.registry }}/{{ .Values.charts.synapse.repository }}"
+  - name: "synapse-create-account-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapseCreateAccount.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseCreateAccount.registry }}/{{ .Values.charts.synapseCreateAccount.repository }}"
+
+  # openDesk Matrix Widgets
+  # Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-matrix-widgets
+  - name: "matrix-user-verification-service-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.matrixUserVerificationService.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixUserVerificationService.registry }}/{{ .Values.charts.matrixUserVerificationService.repository }}"
+  - name: "matrix-neoboard-widget-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
+  - name: "matrix-neochoice-widget-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
+  - name: "matrix-neodatefix-widget-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.matrixNeodatefixWidget.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixWidget.registry }}/{{ .Values.charts.matrixNeodatefixWidget.repository }}"
+  - name: "matrix-neodatefix-bot-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.matrixNeodatefixBot.verify }}
+    username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixBot.registry }}/{{ .Values.charts.matrixNeodatefixBot.repository }}"
+
+  # openDesk Enterprise Repositories
+
+  # openDesk Element
+  # Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-element
+  - name: "synapse-admin-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapseAdmin.verify }}
+    username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseAdmin.registry }}/{{ .Values.charts.synapseAdmin.repository }}"
+  - name: "synapse-adminbot-web-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapseAdminbotWeb.verify }}
+    username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseAdminbotWeb.registry }}/{{ .Values.charts.synapseAdminbotWeb.repository }}"
+  - name: "synapse-groupsync-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapseGroupsync.verify }}
+    username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseGroupsync.registry }}/{{ .Values.charts.synapseGroupsync.repository }}"
+  - name: "synapse-pipe-repo"
+    keyring: "../../files/gpg-pubkeys/opencode.gpg"
+    verify: {{ .Values.charts.synapsePipe.verify }}
+    username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
+    password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
+    oci: true
+    url: "{{ .Values.global.helmRegistry | default .Values.charts.synapsePipe.registry }}/{{ .Values.charts.synapsePipe.repository }}"
+
+releases:
+  - name: "opendesk-element"
+    chart: "element-repo/{{ .Values.charts.element.name }}"
+    version: "{{ .Values.charts.element.version }}"
+    values:
+      - "values-element.yaml.gotmpl"
+      {{ range .Values.customization.release.opendeskElement }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "opendesk-well-known"
+    chart: "element-well-known-repo/{{ .Values.charts.elementWellKnown.name }}"
+    version: "{{ .Values.charts.elementWellKnown.version }}"
+    values:
+      - "values-well-known.yaml.gotmpl"
+      {{ range .Values.customization.release.opendeskWellKnown }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-web"
+    chart: "synapse-web-repo/{{ .Values.charts.synapseWeb.name }}"
+    version: "{{ .Values.charts.synapseWeb.version }}"
+    values:
+      - "values-synapse-web.yaml.gotmpl"
+      {{ range .Values.customization.release.opendeskSynapseWeb }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse"
+    chart: "synapse-repo/{{ .Values.charts.synapse.name }}"
+    version: "{{ .Values.charts.synapse.version }}"
+    values:
+      - "values-synapse.yaml.gotmpl"
+      {{ range .Values.customization.release.opendeskSynapse }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "opendesk-matrix-user-verification-service-bootstrap"
+    chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
+    version: "{{ .Values.charts.synapseCreateAccount.version }}"
+    values:
+      - "values-matrix-user-verification-service-bootstrap.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "opendesk-matrix-user-verification-service"
+    chart: "matrix-user-verification-service-repo/{{ .Values.charts.matrixUserVerificationService.name }}"
+    version: "{{ .Values.charts.matrixUserVerificationService.version }}"
+    values:
+      - "values-matrix-user-verification-service.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "matrix-neoboard-widget"
+    chart: "matrix-neoboard-widget-repo/{{ .Values.charts.matrixNeoboardWidget.name }}"
+    version: "{{ .Values.charts.matrixNeoboardWidget.version }}"
+    values:
+      - "values-matrix-neoboard-widget.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "matrix-neochoice-widget"
+    chart: "matrix-neochoice-widget-repo/{{ .Values.charts.matrixNeochoiseWidget.name }}"
+    version: "{{ .Values.charts.matrixNeochoiseWidget.version }}"
+    values:
+      - "values-matrix-neochoice-widget.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "matrix-neodatefix-widget"
+    chart: "matrix-neodatefix-widget-repo/{{ .Values.charts.matrixNeodatefixWidget.name }}"
+    version: "{{ .Values.charts.matrixNeodatefixWidget.version }}"
+    values:
+      - "values-matrix-neodatefix-widget.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "matrix-neodatefix-bot-bootstrap"
+    chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
+    version: "{{ .Values.charts.synapseCreateAccount.version }}"
+    values:
+      - "values-matrix-neodatefix-bot-bootstrap.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  - name: "matrix-neodatefix-bot"
+    chart: "matrix-neodatefix-bot-repo/{{ .Values.charts.matrixNeodatefixBot.name }}"
+    version: "{{ .Values.charts.matrixNeodatefixBot.version }}"
+    values:
+      - "values-matrix-neodatefix-bot.yaml.gotmpl"
+    installed: {{ .Values.element.enabled }}
+    timeout: 900
+
+  # openDesk Enterprise Releases
+  - name: "opendesk-synapse-admin"
+    chart: "synapse-admin-repo/{{ .Values.charts.synapseAdmin.name }}"
+    version: "{{ .Values.charts.synapseAdmin.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAdmin }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-adminbot-bootstrap"
+    chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
+    version: "{{ .Values.charts.synapseCreateAccount.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAdminbotBootstrap }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-adminbot-pipe"
+    chart: "synapse-pipe-repo/{{ .Values.charts.synapsePipe.name }}"
+    version: "{{ .Values.charts.synapsePipe.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAdminbotPipe }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-adminbot-web"
+    chart: "synapse-adminbot-web-repo/{{ .Values.charts.synapseAdminbotWeb.name }}"
+    version: "{{ .Values.charts.synapseAdminbotWeb.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAdminbotWeb }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-auditbot-bootstrap"
+    chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
+    version: "{{ .Values.charts.synapseCreateAccount.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAuditbotBootstrap }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-auditbot-pipe"
+    chart: "synapse-pipe-repo/{{ .Values.charts.synapsePipe.name }}"
+    version: "{{ .Values.charts.synapsePipe.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseAuditbotPipe }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementAdmin.enabled }}
+    timeout: 900
+
+  - name: "opendesk-synapse-groupsync"
+    chart: "synapse-groupsync-repo/{{ .Values.charts.synapseGroupsync.name }}"
+    version: "{{ .Values.charts.synapseGroupsync.version }}"
+    values:
+      {{ range .Values.customization.release.opendeskSynapseGroupsync }}
+      - {{ . }}
+      {{ end }}
+    installed: {{ .Values.elementGroupsync.enabled }}
+    timeout: 900
+
+commonLabels:
+  deployStage: "050-components"
+  component: "element"
+...

helmfile/apps/element/helmfile.yaml

@@ -1,49 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-repositories:
-  - name: "opendesk-element-repo"
-    url: >-
-      {{ env "PRIVATE_CHART_REPOSITORY_URL" |
-         default "https://gitlab.souvap-univention.de/api/v4/projects/148/packages/helm/stable" }}
-
-releases:
-  - name: "opendesk-element"
-    chart: "opendesk-element-repo/opendesk-element"
-    version: "2.0.1"
-    values:
-      - "values-element.yaml"
-      - "values-element.gotmpl"
-    condition: "element.enabled"
-
-  - name: "opendesk-well-known"
-    chart: "opendesk-element-repo/opendesk-well-known"
-    version: "2.0.1"
-    values:
-      - "values-well-known.yaml"
-      - "values-well-known.gotmpl"
-    condition: "element.enabled"
-
-  - name: "opendesk-synapse-web"
-    chart: "opendesk-element-repo/opendesk-synapse-web"
-    version: "2.0.1"
-    values:
-      - "values-synapse-web.yaml"
-      - "values-synapse-web.gotmpl"
-    condition: "element.enabled"
-
-  - name: "opendesk-synapse"
-    chart: "opendesk-element-repo/opendesk-synapse"
-    version: "2.0.1"
-    values:
-      - "values-synapse.yaml"
-      - "values-synapse.gotmpl"
-    condition: "element.enabled"
-
-commonLabels:
-  deploy-stage: "component-1"
-  component: "element"
-
-bases:
-  - "../../bases/environments.yaml"
-...

helmfile/apps/element/helmfile.yaml.gotmpl

@@ -0,0 +1,12 @@
+# 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
+---
+bases:
+  - "../../bases/environments.yaml"
+---
+helmfiles:
+  - path: "./helmfile-child.yaml.gotmpl"
+    values:
+      - {{ toYaml .Values | nindent 8 }}
+...

helmfile/apps/element/values-element.gotmpl

@@ -1,39 +0,0 @@
-{{/*
-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 }}"
-  registry: "{{ .Values.global.imageRegistry }}"
-  hosts:
-    {{ .Values.global.hosts | toYaml | nindent 4 }}
-  imagePullSecrets:
-    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
-
-configuration:
-  additionalConfiguration:
-    logout_redirect_url: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/souvap/protocol/openid-connect/logout?client_id=matrix&post_logout_redirect_uri=https%3A%2F%2F{{ .Values.global.hosts.univentionCorporateServer }}.{{ .Values.global.domain }}"
-
-image:
-  imagePullPolicy: "{{ .Values.global.imagePullPolicy }}"
-  registry: "{{ .Values.global.imageRegistry }}"
-  repository: "{{ .Values.images.element.repository }}"
-  tag: "{{ .Values.images.element.tag }}"
-
-ingress:
-  host: "{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}"
-  enabled: "{{ .Values.ingress.enabled }}"
-  ingressClassName: "{{ .Values.ingress.ingressClassName }}"
-  tls:
-    enabled: "{{ .Values.ingress.tls.enabled }}"
-    secretName: "{{ .Values.ingress.tls.secretName }}"
-
-theme:
-  {{ .Values.theme | toYaml | nindent 2 }}
-
-replicaCount: {{ .Values.replicas.element }}
-
-resources:
-  {{ .Values.resources.element | toYaml | nindent 2 }}
-...

helmfile/apps/element/values-element.yaml

@@ -1,21 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-containerSecurityContext:
-  allowPrivilegeEscalation: false
-  capabilities:
-    drop:
-      - "ALL"
-  enabled: true
-  privileged: false
-  readOnlyRootFilesystem: true
-  runAsGroup: 101
-  runAsNonRoot: true
-  runAsUser: 101
-  seccompProfile:
-    type: "RuntimeDefault"
-
-podSecurityContext:
-  enabled: true
-  fsGroup: 101
-...

helmfile/apps/element/values-element.yaml.gotmpl

@@ -0,0 +1,155 @@
+{{/*
+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
+*/}}
+---
+configuration:
+  endToEndEncryption: true
+  additionalConfiguration:
+    logout_redirect_url: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/logout?client_id=opendesk-matrix&post_logout_redirect_uri=https%3A%2F%2F{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}"
+
+    "net.nordeck.element_web.module.opendesk":
+      config:
+        banner:
+          ics_navigation_json_url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/navigation.json"
+          ics_silent_url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/silent"
+          portal_logo_svg_url: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/univention/portal/icons/logos/domain.svg"
+          portal_url: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/"
+        custom_css_variables:
+          --cpd-color-bg-action-primary-rest: {{ .Values.theme.colors.primary | quote }}
+          --cpd-color-text-action-accent: {{ .Values.theme.colors.primary | quote }}
+
+    "net.nordeck.element_web.module.widget_lifecycle":
+      widget_permissions:
+        "https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/jitsi.html":
+          identity_approved: true
+        "https://{{ .Values.global.hosts.matrixNeoBoardWidget }}.{{ .Values.global.domain }}/*":
+          preload_approved: true
+          capabilities_approved:
+            - org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.create
+            - org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.create
+            - org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.chunk
+            - org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.chunk
+            - org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.snapshot
+            - org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.snapshot
+            - org.matrix.msc2762.send.state_event:m.room.power_levels#
+            - org.matrix.msc2762.receive.state_event:m.room.power_levels#
+            - org.matrix.msc2762.receive.state_event:m.room.member
+            - org.matrix.msc2762.receive.state_event:m.room.name
+            - org.matrix.msc2762.send.state_event:net.nordeck.whiteboard
+            - org.matrix.msc2762.receive.state_event:net.nordeck.whiteboard
+            - org.matrix.msc2762.send.state_event:net.nordeck.whiteboard.sessions#*
+            - org.matrix.msc2762.receive.state_event:net.nordeck.whiteboard.sessions
+            - org.matrix.msc3819.send.to_device:net.nordeck.whiteboard.connection_signaling
+            - org.matrix.msc3819.receive.to_device:net.nordeck.whiteboard.connection_signaling
+            - town.robin.msc3846.turn_servers
+            - org.matrix.msc4039.upload_file
+            - org.matrix.msc4039.download_file
+        "https://{{ .Values.global.hosts.matrixNeoChoiceWidget }}.{{ .Values.global.domain }}/*":
+          preload_approved: true
+          capabilities_approved:
+            - org.matrix.msc2762.send.event:net.nordeck.poll.vote
+            - org.matrix.msc2762.receive.event:net.nordeck.poll.vote
+            - org.matrix.msc2762.send.state_event:net.nordeck.poll
+            - org.matrix.msc2762.receive.state_event:net.nordeck.poll
+            - org.matrix.msc2762.send.state_event:net.nordeck.poll.settings
+            - org.matrix.msc2762.receive.state_event:net.nordeck.poll.settings
+            - org.matrix.msc2762.receive.state_event:m.room.power_levels
+            - org.matrix.msc2762.receive.state_event:m.room.name
+            - org.matrix.msc2762.receive.state_event:m.room.member
+            - org.matrix.msc2762.send.state_event:net.nordeck.poll.group
+            - org.matrix.msc2762.receive.state_event:net.nordeck.poll.group
+            - org.matrix.msc2762.send.event:net.nordeck.poll.start
+            - org.matrix.msc2762.receive.event:net.nordeck.poll.start
+        "https://{{ .Values.global.hosts.matrixNeoDateFixWidget }}.{{ .Values.global.domain }}/*":
+          preload_approved: true
+          identity_approved: true
+          capabilities_approved:
+            - org.matrix.msc2931.navigate
+            - org.matrix.msc2762.timeline:*
+            - org.matrix.msc2762.receive.state_event:m.room.power_levels
+            - org.matrix.msc2762.receive.event:m.reaction
+            - org.matrix.msc2762.receive.state_event:m.room.create
+            - org.matrix.msc2762.receive.state_event:m.room.tombstone
+            - org.matrix.msc2762.receive.state_event:m.room.member
+            - org.matrix.msc2762.send.state_event:m.room.member
+            - org.matrix.msc2762.receive.state_event:m.room.name
+            - org.matrix.msc2762.receive.state_event:m.room.topic
+            - org.matrix.msc2762.receive.state_event:m.space.parent
+            - org.matrix.msc2762.receive.state_event:m.space.child
+            - org.matrix.msc2762.receive.state_event:net.nordeck.meetings.metadata
+            - org.matrix.msc2762.receive.state_event:im.vector.modular.widgets
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.create
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.create
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.breakoutsessions.create
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.breakoutsessions.create
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.close
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.close
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.widgets.handle
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.widgets.handle
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.participants.handle
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.participants.handle
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.update
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.update
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.change.message_permissions
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.change.message_permissions
+            - org.matrix.msc2762.send.event:net.nordeck.meetings.sub_meetings.send_message
+            - org.matrix.msc2762.receive.event:net.nordeck.meetings.sub_meetings.send_message
+            - org.matrix.msc3973.user_directory_search
+
+  welcomeUserId: "@meetings-bot:{{ .Values.global.matrixDomain | default .Values.global.domain }}"
+
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.element | toYaml | nindent 4 }}
+
+global:
+  domain: {{ .Values.global.domain | quote }}
+  hosts:
+    {{ .Values.global.hosts | toYaml | nindent 4 }}
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.element.registry | quote }}
+  repository: {{ .Values.images.element.repository | quote }}
+  tag: {{ .Values.images.element.tag | quote }}
+
+ingress:
+  host: "{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}"
+  enabled: {{ .Values.ingress.enabled }}
+  ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
+  tls:
+    enabled: {{ .Values.ingress.tls.enabled }}
+    secretName: {{ .Values.ingress.tls.secretName | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+replicaCount: {{ .Values.replicas.element }}
+
+resources:
+  {{ .Values.resources.element | toYaml | nindent 2 }}
+
+theme:
+  title: "Chat - {{ .Values.theme.texts.productName }}"
+  {{ .Values.theme | toYaml | nindent 2 }}
+
+...

helmfile/apps/element/values-matrix-neoboard-widget.yaml.gotmpl

@@ -0,0 +1,60 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.matrixNeoBoardWidget | toYaml | nindent 4 }}
+
+global:
+  domain: {{ .Values.global.domain | quote }}
+  hosts:
+    {{ .Values.global.hosts | toYaml | nindent 4 }}
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.matrixNeoBoardWidget.registry | quote }}
+  repository: {{ .Values.images.matrixNeoBoardWidget.repository | quote }}
+  tag: {{ .Values.images.matrixNeoBoardWidget.tag | quote }}
+
+ingress:
+  enabled: {{ .Values.ingress.enabled }}
+  ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
+  tls:
+    enabled: {{ .Values.ingress.tls.enabled }}
+    secretName: {{ .Values.ingress.tls.secretName | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+replicaCount: {{ .Values.replicas.matrixNeoBoardWidget }}
+
+resources:
+  {{ .Values.resources.matrixNeoBoardWidget | toYaml | nindent 2 }}
+
+theme:
+  {{ .Values.theme | toYaml | nindent 2 }}
+
+nginx:
+  ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
+
+...

helmfile/apps/element/values-matrix-neochoice-widget.yaml.gotmpl

@@ -0,0 +1,60 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.matrixNeoChoiceWidget | toYaml | nindent 4 }}
+
+global:
+  domain: {{ .Values.global.domain | quote }}
+  hosts:
+    {{ .Values.global.hosts | toYaml | nindent 4 }}
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.matrixNeoChoiceWidget.registry | quote }}
+  repository: {{ .Values.images.matrixNeoChoiceWidget.repository | quote }}
+  tag: {{ .Values.images.matrixNeoChoiceWidget.tag | quote }}
+
+ingress:
+  enabled: {{ .Values.ingress.enabled }}
+  ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
+  tls:
+    enabled: {{ .Values.ingress.tls.enabled }}
+    secretName: {{ .Values.ingress.tls.secretName | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+replicaCount: {{ .Values.replicas.matrixNeoChoiceWidget }}
+
+theme:
+  {{ .Values.theme | toYaml | nindent 2 }}
+
+resources:
+  {{ .Values.resources.matrixNeoChoiceWidget | toYaml | nindent 2 }}
+
+nginx:
+  ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
+
+...

helmfile/apps/element/values-matrix-neodatefix-bot-bootstrap.yaml.gotmpl

@@ -0,0 +1,46 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+cleanup:
+  deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
+  deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
+
+configuration:
+  username: "meetings-bot"
+  pod: "opendesk-synapse-0"
+  secretName: "matrix-neodatefix-bot-account"
+  password: {{ .Values.secrets.matrixNeoDateFixBot.password | quote }}
+
+global:
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.synapseCreateUser.registry | quote }}
+  url: {{ .Values.images.synapseCreateUser.repository | quote }}
+  tag: {{ .Values.images.synapseCreateUser.tag | quote }}
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+
+fullnameOverride: "matrix-neodatefix-bot-bootstrap"
+
+podAnnotations: {}
+
+securityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
+
+...

helmfile/apps/element/values-matrix-neodatefix-bot.yaml.gotmpl

@@ -0,0 +1,101 @@
+{{/*
+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-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 }}
+
+configuration:
+  bot:
+    username: "meetings-bot"
+    display name: "Terminplaner Bot"
+  openxchangeBaseUrl: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
+  strings:
+    breakoutSessionWidgetName: "Breakoutsessions"
+    calendarRoomName: "Terminplaner"
+    calendarWidgetName: "Terminplaner"
+    cockpitWidgetName: "Meeting Steuerung"
+    jitsiWidgetName: "Videokonferenz"
+    matrixNeoBoardWidgetName: "Whiteboard"
+    matrixNeoChoiceWidgetName: "Abstimmungen"
+
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.matrixNeoDateFixBot | toYaml | nindent 4 }}
+
+extraEnvVars:
+  - name: "ACCESS_TOKEN"
+    valueFrom:
+      secretKeyRef:
+        name: "matrix-neodatefix-bot-account"
+        key: "access_token"
+{{- if .Values.certificate.selfSigned }}
+  - name: "NODE_EXTRA_CA_CERTS"
+    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:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.matrixNeoDateFixBot.registry | quote }}
+  repository: {{ .Values.images.matrixNeoDateFixBot.repository | quote }}
+  tag: {{ .Values.images.matrixNeoDateFixBot.tag | quote }}
+
+ingress:
+  enabled: {{ .Values.ingress.enabled }}
+  ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
+  tls:
+    enabled: {{ .Values.ingress.tls.enabled }}
+    secretName: {{ .Values.ingress.tls.secretName | quote }}
+
+liveness sample:
+  enabled: true
+
+persistence:
+  size: {{ .Values.persistence.storages.matrixNeoDateFixBot.size | quote }}
+  storageClass: {{ coalesce .Values.persistence.storages.matrixNeoDateFixBot.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+readinessProbe:
+  enabled: true
+
+replicaCount: {{ .Values.replicas.matrixNeoDateFixBot }}
+
+resources:
+  {{ .Values.resources.matrixNeoDateFixBot | toYaml | nindent 2 }}
+
+...

helmfile/apps/element/values-matrix-neodatefix-widget.yaml.gotmpl

@@ -0,0 +1,65 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+configuration:
+  bot:
+    username: "meetings-bot"
+    homeserver: {{ .Values.global.matrixDomain | default .Values.global.domain }}
+
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.matrixNeoDateFixWidget | toYaml | nindent 4 }}
+
+global:
+  domain: {{ .Values.global.domain | quote }}
+  hosts:
+    {{ .Values.global.hosts | toYaml | nindent 4 }}
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.matrixNeoDateFixWidget.registry | quote }}
+  repository: {{ .Values.images.matrixNeoDateFixWidget.repository | quote }}
+  tag: {{ .Values.images.matrixNeoDateFixWidget.tag | quote }}
+
+ingress:
+  enabled: {{ .Values.ingress.enabled }}
+  ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
+  tls:
+    enabled: {{ .Values.ingress.tls.enabled }}
+    secretName: {{ .Values.ingress.tls.secretName | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+replicaCount: {{ .Values.replicas.matrixNeoDateFixWidget }}
+
+resources:
+  {{ .Values.resources.matrixNeoDateFixWidget | toYaml | nindent 2 }}
+
+theme:
+  {{ .Values.theme | toYaml | nindent 2 }}
+
+nginx:
+  ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
+
+...

helmfile/apps/element/values-matrix-user-verification-service-bootstrap.yaml.gotmpl

@@ -0,0 +1,45 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+cleanup:
+  deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
+  deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
+
+configuration:
+  username: "uvs"
+  pod: "opendesk-synapse-0"
+  secretName: "opendesk-matrix-user-verification-service-account"
+  password: {{ .Values.secrets.matrixUserVerificationService.password | quote }}
+
+global:
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.synapseCreateUser.registry | quote }}
+  url: {{ .Values.images.synapseCreateUser.repository | quote }}
+  tag: {{ .Values.images.synapseCreateUser.tag | quote }}
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+
+fullnameOverride: "opendesk-matrix-user-verification-service-bootstrap"
+
+podAnnotations: {}
+
+securityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  privileged: false
+  readOnlyRootFilesystem: true
+  runAsGroup: 101
+  runAsNonRoot: true
+  runAsUser: 101
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
+...

helmfile/apps/element/values-matrix-user-verification-service.yaml.gotmpl

@@ -0,0 +1,56 @@
+{{/*
+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-License-Identifier: Apache-2.0
+*/}}
+---
+containerSecurityContext:
+  allowPrivilegeEscalation: false
+  capabilities:
+    drop:
+      - "ALL"
+  enabled: true
+  privileged: false
+  readOnlyRootFilesystem: false
+  runAsGroup: 0
+  runAsNonRoot: false
+  runAsUser: 0
+  seccompProfile:
+    type: "RuntimeDefault"
+  seLinuxOptions:
+    {{ .Values.seLinuxOptions.matrixUserVerificationService | toYaml | nindent 4 }}
+
+extraEnvVars:
+  - name: "UVS_ACCESS_TOKEN"
+    valueFrom:
+      secretKeyRef:
+        name: "opendesk-matrix-user-verification-service-account"
+        key: "access_token"
+  - name: "UVS_DISABLE_IP_BLACKLIST"
+    value: "true"
+
+global:
+  domain: {{ .Values.global.domain | quote }}
+  hosts:
+    {{ .Values.global.hosts | toYaml | nindent 4 }}
+  imagePullSecrets:
+    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
+
+image:
+  imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
+  registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.matrixUserVerificationService.registry | quote }}
+  repository: {{ .Values.images.matrixUserVerificationService.repository | quote }}
+  tag: {{ .Values.images.matrixUserVerificationService.tag | quote }}
+
+podAnnotations: {}
+
+podSecurityContext:
+  enabled: true
+  fsGroup: 101
+
+replicaCount: {{ .Values.replicas.matrixUserVerificationService }}
+
+resources:
+  {{ .Values.resources.matrixUserVerificationService | toYaml | nindent 2 }}
+
+...

helmfile/apps/element/values-synapse-web.gotmpl

@@ -1,32 +0,0 @@
-{{/*
-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 }}"
-  registry: "{{ .Values.global.imageRegistry }}"
-  hosts:
-    {{ .Values.global.hosts | toYaml | nindent 4 }}
-  imagePullSecrets:
-    {{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
-
-image:
-  imagePullPolicy: "{{ .Values.global.imagePullPolicy }}"
-  registry: "{{ .Values.global.imageRegistry }}"
-  repository: "{{ .Values.images.synapseWeb.repository }}"
-  tag: "{{ .Values.images.synapseWeb.tag }}"
-
-ingress:
-  host: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
-  enabled: "{{ .Values.ingress.enabled }}"
-  ingressClassName: "{{ .Values.ingress.ingressClassName }}"
-  tls:
-    enabled: "{{ .Values.ingress.tls.enabled }}"
-    secretName: "{{ .Values.ingress.tls.secretName }}"
-
-replicaCount: {{ .Values.replicas.synapseWeb }}
-
-resources:
-  {{ .Values.resources.synapseWeb | toYaml | nindent 2 }}
-...

helmfile/apps/element/values-synapse-web.yaml

@@ -1,21 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
-# SPDX-License-Identifier: Apache-2.0
----
-containerSecurityContext:
-  allowPrivilegeEscalation: false
-  capabilities:
-    drop:
-      - "ALL"
-  enabled: true
-  privileged: false
-  readOnlyRootFilesystem: true
-  runAsGroup: 101
-  runAsNonRoot: true
-  runAsUser: 101
-  seccompProfile:
-    type: "RuntimeDefault"
-
-podSecurityContext:
-  enabled: true
-  fsGroup: 101
-...