Compare commits
149 Commits
trossner/f
...
jahlers/2f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ac674b93ae | ||
|
|
e46c3759e0 | ||
|
|
52b0b13e6b | ||
|
|
4c42ed76e8 | ||
|
|
7b05213d6e | ||
|
|
4296db7c90 | ||
|
|
a6de1fe694 | ||
|
|
817af98fcd | ||
|
|
780596ab40 | ||
|
|
da3adff0ef | ||
|
|
60f5e36b7c | ||
|
|
c4e4258162 | ||
|
|
c62e66cd84 | ||
|
|
ef7e3d225d | ||
|
|
31a22f38cc | ||
|
|
a25a0e9173 | ||
|
|
ba333cd74e | ||
|
|
17a0adb67c | ||
|
|
91d0f98682 | ||
|
|
09f482981b | ||
|
|
930ae9d3e7 | ||
|
|
581c8aed1f | ||
|
|
de8b560fe7 | ||
|
|
370247b951 | ||
|
|
b32996da34 | ||
|
|
10e0b0ad6c | ||
|
|
32df1657d2 | ||
|
|
8dcac46d98 | ||
|
|
284c9fe0c7 | ||
|
|
83c311b101 | ||
|
|
aff8edbde2 | ||
|
|
9c79c44453 | ||
|
|
1e9e7d8e3a | ||
|
|
1f051e7779 | ||
|
|
824e5cbf3e | ||
|
|
955f17ef8b | ||
|
|
ab49bf9f6b | ||
|
|
777e7d2fc6 | ||
|
|
b70959d82d | ||
|
|
6e343c76a3 | ||
|
|
cd9c54b177 | ||
|
|
4662709673 | ||
|
|
8eeaa23c2f | ||
|
|
601e649913 | ||
|
|
2fcf014894 | ||
|
|
c51c92536a | ||
|
|
e23c97430f | ||
|
|
61d94a8de6 | ||
|
|
4e21129456 | ||
|
|
1323ef142e | ||
|
|
03ec70435c | ||
|
|
40aa9d0e63 | ||
|
|
1cdfcf2784 | ||
|
|
ccb51a0de3 | ||
|
|
9d8e9c3ade | ||
|
|
d096fb1154 | ||
|
|
a0f52ee7d4 | ||
|
|
335806a53e | ||
|
|
d5e73feb88 | ||
|
|
3662b5cd25 | ||
|
|
bacf51efb1 | ||
|
|
033cb558dd | ||
|
|
5496317fee | ||
|
|
b4b714ff41 | ||
|
|
04ab28c029 | ||
|
|
ae27a35f5a | ||
|
|
b0e665b031 | ||
|
|
9d0f6daad0 | ||
|
|
5aae75a152 | ||
|
|
054c39c124 | ||
|
|
ba18e6f61c | ||
|
|
a16d9071c9 | ||
|
|
0b230fa2cc | ||
|
|
6f2f7cd5db | ||
|
|
fab862eec6 | ||
|
|
b71c2e57ee | ||
|
|
33ff9227b7 | ||
|
|
0c91117575 | ||
|
|
6c67eca7aa | ||
|
|
0e21d2cea5 | ||
|
|
a13cf63024 | ||
|
|
28a6528528 | ||
|
|
2926e2c93a | ||
|
|
6796f320f7 | ||
|
|
63562c1aae | ||
|
|
1c643ac8ff | ||
|
|
4811b570e7 | ||
|
|
0e69f38fef | ||
|
|
3983c608be | ||
|
|
174951cd51 | ||
|
|
16dfd255c6 | ||
|
|
669995bb95 | ||
|
|
6d329e18cf | ||
|
|
6438284090 | ||
|
|
a63d7cb861 | ||
|
|
4602396583 | ||
|
|
b9656772a9 | ||
|
|
4403dfe720 | ||
|
|
31ec1003c0 | ||
|
|
4cda827f55 | ||
|
|
96f18196c5 | ||
|
|
eac214e364 | ||
|
|
3ad285a869 | ||
|
|
e4d9106c45 | ||
|
|
7f60ab3b7a | ||
|
|
4c7422a411 | ||
|
|
99851e6286 | ||
|
|
77108587c7 | ||
|
|
718eb45e9c | ||
|
|
af77ff8bf6 | ||
|
|
186f12fba0 | ||
|
|
539a30263c | ||
|
|
47ce294403 | ||
|
|
b90bff30b3 | ||
|
|
277a1f5a65 | ||
|
|
0e3b661565 | ||
|
|
627b9c1e84 | ||
|
|
00a1a9394e | ||
|
|
1441c5734f | ||
|
|
9d7644dc04 | ||
|
|
54f9e4c3f8 | ||
|
|
2a94f2dd4b | ||
|
|
c0cbb76921 | ||
|
|
45add7981c | ||
|
|
d3b191644b | ||
|
|
bbe7550c46 | ||
|
|
a9c8dfeab1 | ||
|
|
f630a369da | ||
|
|
508e286232 | ||
|
|
407f2be2ad | ||
|
|
18fcaa0331 | ||
|
|
f96942536f | ||
|
|
56ce3355fc | ||
|
|
6ff1fcd438 | ||
|
|
8611d95e5a | ||
|
|
86ef0be542 | ||
|
|
df144fe3d3 | ||
|
|
83da87e962 | ||
|
|
e2b3bd543f | ||
|
|
e5ad0bb2e0 | ||
|
|
1213ecc425 | ||
|
|
5e0b2e26fc | ||
|
|
1402593556 | ||
|
|
564fb2d7c7 | ||
|
|
9e102e2d1b | ||
|
|
b3b6ab5a61 | ||
|
|
7f1f6cdcd4 | ||
|
|
de15071ae9 | ||
|
|
c8c12a278e |
3
.gitignore
vendored
@@ -8,6 +8,9 @@
|
|||||||
helmfile/environments/dev/*.yaml.gotmpl
|
helmfile/environments/dev/*.yaml.gotmpl
|
||||||
helmfile/environments/test/*.yaml.gotmpl
|
helmfile/environments/test/*.yaml.gotmpl
|
||||||
helmfile/environments/prod/*.yaml.gotmpl
|
helmfile/environments/prod/*.yaml.gotmpl
|
||||||
|
helmfile/environments/dev/*/
|
||||||
|
helmfile/environments/test/*/
|
||||||
|
helmfile/environments/prod/*/
|
||||||
!helmfile/environments/dev/sample.yaml.gotmpl
|
!helmfile/environments/dev/sample.yaml.gotmpl
|
||||||
!helmfile/environments/test/sample.yaml.gotmpl
|
!helmfile/environments/test/sample.yaml.gotmpl
|
||||||
!helmfile/environments/prod/sample.yaml.gotmpl
|
!helmfile/environments/prod/sample.yaml.gotmpl
|
||||||
|
|||||||
313
.gitlab-ci.yml
@@ -1,15 +1,20 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
include:
|
include:
|
||||||
- project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}"
|
- project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}"
|
||||||
ref: "v2.4.3"
|
ref: "v2.4.8"
|
||||||
file:
|
file:
|
||||||
- "ci/common/automr.yml"
|
|
||||||
- "ci/common/lint.yml"
|
- "ci/common/lint.yml"
|
||||||
- "ci/release-automation/semantic-release.yml"
|
- "ci/release-automation/semantic-release.yml"
|
||||||
- local: "/.gitlab/generate/generate-docs.yml"
|
- local: "/.gitlab/generate/generate-docs.yml"
|
||||||
|
- local: "/.gitlab/renovate/renovate.yml"
|
||||||
|
- local: "/.gitlab/release/release-common.yml"
|
||||||
|
- local: "/.gitlab/release/release-generate-version.yml"
|
||||||
|
- local: "/.gitlab/release/release-semantic.yml"
|
||||||
|
- local: "/.gitlab/lint/lint-common.yml"
|
||||||
|
- local: "/.gitlab/lint/lint-reuse.yml"
|
||||||
- project: "${PROJECT_PATH_CUSTOM_ENVIRONMENT_CONFIG}"
|
- project: "${PROJECT_PATH_CUSTOM_ENVIRONMENT_CONFIG}"
|
||||||
file: "gitlab/environments.yaml"
|
file: "gitlab/environments.yaml"
|
||||||
ref: "main"
|
ref: "main"
|
||||||
@@ -32,21 +37,22 @@ stages:
|
|||||||
- ".pre"
|
- ".pre"
|
||||||
- "renovate"
|
- "renovate"
|
||||||
- "scan"
|
- "scan"
|
||||||
- "automr"
|
|
||||||
- "env-cleanup"
|
- "env-cleanup"
|
||||||
- "env"
|
- "env"
|
||||||
- "pre-services-deploy"
|
- "pre-services-deploy"
|
||||||
- "migrations-pre"
|
- "010-migrations-pre"
|
||||||
- "basic-services-deploy"
|
- "030-services"
|
||||||
- "component-deploy-stage-1"
|
- "050-components"
|
||||||
- "component-deploy-stage-2"
|
- "060-components"
|
||||||
- "migrations-post"
|
- "090-migrations-post"
|
||||||
- "lint"
|
- "lint"
|
||||||
- "tests"
|
- "post-prepare"
|
||||||
|
- "post-execute"
|
||||||
- "env-stop"
|
- "env-stop"
|
||||||
- ".post"
|
- ".post"
|
||||||
|
|
||||||
variables:
|
variables:
|
||||||
|
RELEASE_BRANCH: "main"
|
||||||
NAMESPACE:
|
NAMESPACE:
|
||||||
description: "The name of namespaces to deploy to."
|
description: "The name of namespaces to deploy to."
|
||||||
value: ""
|
value: ""
|
||||||
@@ -68,11 +74,17 @@ variables:
|
|||||||
- "no"
|
- "no"
|
||||||
DEBUG_ENABLED:
|
DEBUG_ENABLED:
|
||||||
description: "Allows to set `debug.enabled` to true for a deployment, needs to be supported by stage specific\
|
description: "Allows to set `debug.enabled` to true for a deployment, needs to be supported by stage specific\
|
||||||
configuration containting: `debug.enabled: {{ env \"DEBUG_ENABLED\" | default false }}`"
|
configuration containing: `debug.enabled: {{ env \"DEBUG_ENABLED\" | default false }}`"
|
||||||
value: "no"
|
value: "no"
|
||||||
options:
|
options:
|
||||||
- "yes"
|
- "yes"
|
||||||
- "no"
|
- "no"
|
||||||
|
OPENDESK_ENTERPRISE:
|
||||||
|
description: "Set to `true` if you want to deploy openDesk EE (but be sure you provide the required EE keys/tokens for the application)"
|
||||||
|
value: "false"
|
||||||
|
options:
|
||||||
|
- "true"
|
||||||
|
- "false"
|
||||||
DEPLOY_ALL_COMPONENTS:
|
DEPLOY_ALL_COMPONENTS:
|
||||||
description: "Enable all component deployment (overwrites 'no' setting on component level)."
|
description: "Enable all component deployment (overwrites 'no' setting on component level)."
|
||||||
value: "no"
|
value: "no"
|
||||||
@@ -145,6 +157,19 @@ variables:
|
|||||||
options:
|
options:
|
||||||
- "yes"
|
- "yes"
|
||||||
- "no"
|
- "no"
|
||||||
|
CREATE_DEFAULT_ACCOUNTS:
|
||||||
|
description: "Creates `default` and `default-admin` in the instance using the password defined as CI variable
|
||||||
|
`DEFAULT_ACCOUNTS_PASSWORD`."
|
||||||
|
value: "no"
|
||||||
|
options:
|
||||||
|
- "yes"
|
||||||
|
- "no"
|
||||||
|
DEPLOY_NOTES:
|
||||||
|
description: "Enable Notes deployment."
|
||||||
|
value: "no"
|
||||||
|
options:
|
||||||
|
- "yes"
|
||||||
|
- "no"
|
||||||
RUN_TESTS:
|
RUN_TESTS:
|
||||||
description: "Triggers execution of E2E-tests."
|
description: "Triggers execution of E2E-tests."
|
||||||
value: "no"
|
value: "no"
|
||||||
@@ -170,13 +195,24 @@ variables:
|
|||||||
- "Regression"
|
- "Regression"
|
||||||
- "Smoke"
|
- "Smoke"
|
||||||
TESTS_GRACE_PERIOD:
|
TESTS_GRACE_PERIOD:
|
||||||
description: "A new deployment sometimes needs a few minutes to sort itself. If tested too early tests may fail. GRACE_PERIOD is the period in seconds that should be waited before running the tests."
|
description: "A new deployment sometimes needs a few minutes to sort itself. If tested too early tests may fail.
|
||||||
|
GRACE_PERIOD is the period in seconds that should be waited before running the tests."
|
||||||
value: "0"
|
value: "0"
|
||||||
|
TESTS_NUMBER_OF_THREADS:
|
||||||
|
description: "How many threads are used for executing the tests in parallel?"
|
||||||
|
value: "8"
|
||||||
|
|
||||||
|
# Declare .environments which is in `opendesk-env` repository. In case it is not available
|
||||||
|
# 'cache' is used because job as a dummy key, as the job is not allowed to be empty.
|
||||||
|
.environments:
|
||||||
|
cache: {}
|
||||||
|
|
||||||
.deploy-common:
|
.deploy-common:
|
||||||
cache: {}
|
cache: {}
|
||||||
dependencies: []
|
dependencies: []
|
||||||
extends: ".environments"
|
extends: ".environments"
|
||||||
|
environment:
|
||||||
|
name: "${NAMESPACE}"
|
||||||
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:1.1.0\
|
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:1.1.0\
|
||||||
@sha256:74f349066ac5d20e3afaa6abd28781b4c8dc086f67e3d3c1b8345e4a9c3371b1"
|
@sha256:74f349066ac5d20e3afaa6abd28781b4c8dc086f67e3d3c1b8345e4a9c3371b1"
|
||||||
script:
|
script:
|
||||||
@@ -198,9 +234,6 @@ variables:
|
|||||||
|
|
||||||
env-cleanup:
|
env-cleanup:
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
environment:
|
|
||||||
name: "${NAMESPACE}"
|
|
||||||
action: "stop"
|
|
||||||
needs: []
|
needs: []
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -214,6 +247,7 @@ env-cleanup:
|
|||||||
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
||||||
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
||||||
done
|
done
|
||||||
|
# if you update the section below, please also update the respective section in getting_started.md
|
||||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||||
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
||||||
@@ -261,6 +295,18 @@ env-start:
|
|||||||
ca:
|
ca:
|
||||||
secretName: opendesk-root-cert-secret
|
secretName: opendesk-root-cert-secret
|
||||||
EOF
|
EOF
|
||||||
|
after_script:
|
||||||
|
# Set credentials for openDesk Enterprise Registry
|
||||||
|
- |
|
||||||
|
if [ "${OPENDESK_ENTERPRISE}" = "true" ]; then
|
||||||
|
kubectl create secret \
|
||||||
|
--namespace "${NAMESPACE}" \
|
||||||
|
docker-registry enterprise-registry \
|
||||||
|
--docker-server "registry.opencode.de" \
|
||||||
|
--docker-username "${OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME}" \
|
||||||
|
--docker-password "${OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD}" \
|
||||||
|
--dry-run=client -o yaml | kubectl apply -f -
|
||||||
|
fi
|
||||||
stage: "env"
|
stage: "env"
|
||||||
|
|
||||||
policies-deploy:
|
policies-deploy:
|
||||||
@@ -273,11 +319,11 @@ policies-deploy:
|
|||||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
variables:
|
variables:
|
||||||
COMPONENT: "services"
|
COMPONENT: "opendesk-services"
|
||||||
ADDITIONAL_ARGS: "-l name=opendesk-otterize"
|
ADDITIONAL_ARGS: "-l name=opendesk-otterize"
|
||||||
|
|
||||||
migrations-pre:
|
migrations-pre:
|
||||||
stage: "migrations-pre"
|
stage: "010-migrations-pre"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -286,10 +332,10 @@ migrations-pre:
|
|||||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
variables:
|
variables:
|
||||||
COMPONENT: "migrations-pre"
|
COMPONENT: "opendesk-migrations-pre"
|
||||||
|
|
||||||
migrations-post:
|
migrations-post:
|
||||||
stage: "migrations-post"
|
stage: "090-migrations-post"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -298,10 +344,10 @@ migrations-post:
|
|||||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
variables:
|
variables:
|
||||||
COMPONENT: "migrations-post"
|
COMPONENT: "opendesk-migrations-post"
|
||||||
|
|
||||||
services-deploy:
|
services-external-deploy:
|
||||||
stage: "basic-services-deploy"
|
stage: "030-services"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -310,10 +356,22 @@ services-deploy:
|
|||||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
variables:
|
variables:
|
||||||
COMPONENT: "services"
|
COMPONENT: "services-external"
|
||||||
|
|
||||||
|
opendesk-services-deploy:
|
||||||
|
stage: "030-services"
|
||||||
|
extends: ".deploy-common"
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||||
|
$NAMESPACE =~ /.+/ &&
|
||||||
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
||||||
|
when: "on_success"
|
||||||
|
variables:
|
||||||
|
COMPONENT: "opendesk-services"
|
||||||
|
|
||||||
nubus-deploy:
|
nubus-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -325,7 +383,7 @@ nubus-deploy:
|
|||||||
COMPONENT: "nubus"
|
COMPONENT: "nubus"
|
||||||
|
|
||||||
ox-deploy:
|
ox-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
timeout: "30m"
|
timeout: "30m"
|
||||||
rules:
|
rules:
|
||||||
@@ -338,7 +396,7 @@ ox-deploy:
|
|||||||
COMPONENT: "open-xchange"
|
COMPONENT: "open-xchange"
|
||||||
|
|
||||||
xwiki-deploy:
|
xwiki-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -350,7 +408,7 @@ xwiki-deploy:
|
|||||||
COMPONENT: "xwiki"
|
COMPONENT: "xwiki"
|
||||||
|
|
||||||
collabora-deploy:
|
collabora-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -362,7 +420,7 @@ collabora-deploy:
|
|||||||
COMPONENT: "collabora"
|
COMPONENT: "collabora"
|
||||||
|
|
||||||
cryptpad-deploy:
|
cryptpad-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -374,7 +432,7 @@ cryptpad-deploy:
|
|||||||
COMPONENT: "cryptpad"
|
COMPONENT: "cryptpad"
|
||||||
|
|
||||||
nextcloud-deploy:
|
nextcloud-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -386,7 +444,7 @@ nextcloud-deploy:
|
|||||||
COMPONENT: "nextcloud"
|
COMPONENT: "nextcloud"
|
||||||
|
|
||||||
openproject-deploy:
|
openproject-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -398,7 +456,7 @@ openproject-deploy:
|
|||||||
COMPONENT: "openproject"
|
COMPONENT: "openproject"
|
||||||
|
|
||||||
openproject-bootstrap-deploy:
|
openproject-bootstrap-deploy:
|
||||||
stage: "component-deploy-stage-2"
|
stage: "060-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -407,10 +465,10 @@ openproject-bootstrap-deploy:
|
|||||||
($DEPLOY_ALL_COMPONENTS != "no" || ($DEPLOY_OPENPROJECT != "no" && $DEPLOY_NEXTCLOUD != "no"))
|
($DEPLOY_ALL_COMPONENTS != "no" || ($DEPLOY_OPENPROJECT != "no" && $DEPLOY_NEXTCLOUD != "no"))
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
variables:
|
variables:
|
||||||
COMPONENT: "openproject-bootstrap"
|
COMPONENT: "opendesk-openproject-bootstrap"
|
||||||
|
|
||||||
jitsi-deploy:
|
jitsi-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -421,8 +479,20 @@ jitsi-deploy:
|
|||||||
variables:
|
variables:
|
||||||
COMPONENT: "jitsi"
|
COMPONENT: "jitsi"
|
||||||
|
|
||||||
|
notes-deploy:
|
||||||
|
stage: "050-components"
|
||||||
|
extends: ".deploy-common"
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||||
|
$NAMESPACE =~ /.+/ &&
|
||||||
|
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_NOTES != "no")
|
||||||
|
when: "on_success"
|
||||||
|
variables:
|
||||||
|
COMPONENT: "notes"
|
||||||
|
|
||||||
element-deploy:
|
element-deploy:
|
||||||
stage: "component-deploy-stage-1"
|
stage: "050-components"
|
||||||
extends: ".deploy-common"
|
extends: ".deploy-common"
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
@@ -433,20 +503,61 @@ element-deploy:
|
|||||||
variables:
|
variables:
|
||||||
COMPONENT: "element"
|
COMPONENT: "element"
|
||||||
|
|
||||||
.ums-default-password: &ums-default-password
|
fetch-administrator-credentials:
|
||||||
|
extends: ".deploy-common"
|
||||||
|
stage: "post-prepare"
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api"
|
||||||
|
&& $NAMESPACE =~ /.+/
|
||||||
|
&& ($CREATE_DEFAULT_ACCOUNTS == "yes" || $RUN_TESTS == "yes")
|
||||||
|
when: "on_success"
|
||||||
|
script:
|
||||||
- |
|
- |
|
||||||
DEFAULT_ADMINISTRATOR_PASSWORD=$(
|
echo "DEFAULT_ADMINISTRATOR_PASSWORD=$(
|
||||||
kubectl \
|
kubectl \
|
||||||
-n ${NAMESPACE} \
|
-n ${NAMESPACE} \
|
||||||
get secret ums-nubus-credentials \
|
get secret ums-nubus-credentials \
|
||||||
-o jsonpath='{.data.administrator_password}' | base64 -d \
|
-o jsonpath='{.data.administrator_password}' | base64 -d \
|
||||||
)
|
)" >> .env
|
||||||
|
artifacts:
|
||||||
|
reports:
|
||||||
|
dotenv: ".env"
|
||||||
|
|
||||||
run-tests:
|
import-default-accounts:
|
||||||
extends: ".deploy-common"
|
stage: "post-execute"
|
||||||
|
extends: ".environments"
|
||||||
|
dependencies:
|
||||||
|
- "fetch-administrator-credentials"
|
||||||
|
environment:
|
||||||
|
name: "${NAMESPACE}"
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" && $NAMESPACE =~ /.+/ && $CREATE_DEFAULT_ACCOUNTS == "yes"
|
||||||
|
when: "on_success"
|
||||||
|
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/user-import:3.0.0"
|
||||||
|
script:
|
||||||
|
- "echo \"Starting default account import for ${DOMAIN}\""
|
||||||
|
- "cd /app"
|
||||||
|
- |
|
||||||
|
./user_import_udm_rest_api.py \
|
||||||
|
--import_domain ${DOMAIN} \
|
||||||
|
--udm_api_password ${DEFAULT_ADMINISTRATOR_PASSWORD} \
|
||||||
|
--set_default_password ${DEFAULT_ACCOUNTS_PASSWORD} \
|
||||||
|
--import_filename ./template.ods \
|
||||||
|
--admin_enable_fileshare True \
|
||||||
|
--admin_enable_knowledgemanagement True \
|
||||||
|
--admin_enable_projectmanagement True \
|
||||||
|
--create_admin_accounts True \
|
||||||
|
--verify_certificate False
|
||||||
|
|
||||||
|
run-tests:
|
||||||
|
stage: "post-execute"
|
||||||
|
extends: ".deploy-common"
|
||||||
|
dependencies:
|
||||||
|
- "fetch-administrator-credentials"
|
||||||
environment:
|
environment:
|
||||||
name: "${NAMESPACE}"
|
name: "${NAMESPACE}"
|
||||||
stage: "tests"
|
|
||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" && $NAMESPACE =~ /.+/ && $RUN_TESTS == "yes"
|
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" && $NAMESPACE =~ /.+/ && $RUN_TESTS == "yes"
|
||||||
@@ -457,7 +568,6 @@ run-tests:
|
|||||||
- "de"
|
- "de"
|
||||||
- "en"
|
- "en"
|
||||||
script:
|
script:
|
||||||
- *ums-default-password
|
|
||||||
- |
|
- |
|
||||||
curl --request POST \
|
curl --request POST \
|
||||||
--header "Content-Type: application/json" \
|
--header "Content-Type: application/json" \
|
||||||
@@ -478,7 +588,9 @@ run-tests:
|
|||||||
\"screenshot_redirect_step\": \"yes\", \
|
\"screenshot_redirect_step\": \"yes\", \
|
||||||
\"testset\": \"${TESTS_TESTSET}\", \
|
\"testset\": \"${TESTS_TESTSET}\", \
|
||||||
\"testprofile\": \"Namespace\", \
|
\"testprofile\": \"Namespace\", \
|
||||||
\"GRACE_PERIOD\": \"${TESTS_GRACE_PERIOD}\" \
|
\"OPENDESK_ENTERPRISE\": \"${OPENDESK_ENTERPRISE}\", \
|
||||||
|
\"GRACE_PERIOD\": \"${TESTS_GRACE_PERIOD}\", \
|
||||||
|
\"NUMBER_OF_THREADS\": \"${TESTS_NUMBER_OF_THREADS}\" \
|
||||||
} \
|
} \
|
||||||
}" \
|
}" \
|
||||||
"https://${TESTS_PROJECT_URL}/trigger/pipeline"
|
"https://${TESTS_PROJECT_URL}/trigger/pipeline"
|
||||||
@@ -489,7 +601,7 @@ avscan-prepare:
|
|||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||||
$CI_COMMIT_BRANCH == 'main' &&
|
$CI_COMMIT_BRANCH == $RELEASE_BRANCH &&
|
||||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||||
when: "always"
|
when: "always"
|
||||||
- when: "never"
|
- when: "never"
|
||||||
@@ -528,7 +640,7 @@ avscan-prepare:
|
|||||||
| del(.[].repository)
|
| del(.[].repository)
|
||||||
| del(.[].tag)
|
| del(.[].tag)
|
||||||
| del(.[].registry)'
|
| del(.[].registry)'
|
||||||
helmfile/environments/default/images.yaml
|
helmfile/environments/default/images.yaml.gotmpl
|
||||||
>> dynamic-scans.yml
|
>> dynamic-scans.yml
|
||||||
artifacts:
|
artifacts:
|
||||||
paths:
|
paths:
|
||||||
@@ -539,7 +651,7 @@ avscan-start:
|
|||||||
rules:
|
rules:
|
||||||
- if: >
|
- if: >
|
||||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||||
$CI_COMMIT_BRANCH == 'main' &&
|
$CI_COMMIT_BRANCH == $RELEASE_BRANCH &&
|
||||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||||
when: "always"
|
when: "always"
|
||||||
- when: "never"
|
- when: "never"
|
||||||
@@ -548,115 +660,4 @@ avscan-start:
|
|||||||
- artifact: "dynamic-scans.yml"
|
- artifact: "dynamic-scans.yml"
|
||||||
job: "avscan-prepare"
|
job: "avscan-prepare"
|
||||||
strategy: "depend"
|
strategy: "depend"
|
||||||
|
|
||||||
# Declare .environments which is in environments repository. In case it is not available
|
|
||||||
# 'cache' is used because job must contain at least one key, so cache is just a dummy key.
|
|
||||||
.environments:
|
|
||||||
cache: {}
|
|
||||||
|
|
||||||
# Overwrite shared settings
|
|
||||||
.common-semantic-release:
|
|
||||||
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/semantic-release:1.1.0"
|
|
||||||
tags: []
|
|
||||||
|
|
||||||
conventional-commits-linter:
|
|
||||||
rules:
|
|
||||||
- if: >
|
|
||||||
$RUN_RENOVATE == "yes" ||
|
|
||||||
$JOB_CONVENTIONAL_COMMITS_LINTER_ENABLED == 'false' ||
|
|
||||||
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event'
|
|
||||||
when: "never"
|
|
||||||
- when: "always"
|
|
||||||
|
|
||||||
common-yaml-linter:
|
|
||||||
rules:
|
|
||||||
- if: "$JOB_COMMON_YAML_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
|
||||||
when: "never"
|
|
||||||
- when: "always"
|
|
||||||
|
|
||||||
reuse-linter:
|
|
||||||
allow_failure: false
|
|
||||||
rules:
|
|
||||||
- if: "$JOB_REUSE_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
|
||||||
when: "never"
|
|
||||||
- when: "always"
|
|
||||||
|
|
||||||
generate-release-version:
|
|
||||||
rules:
|
|
||||||
- if: >
|
|
||||||
$JOB_RELEASE_ENABLED != 'false' &&
|
|
||||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
|
||||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
|
||||||
when: "on_success"
|
|
||||||
|
|
||||||
release:
|
|
||||||
rules:
|
|
||||||
- if: >
|
|
||||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
|
||||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
|
||||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
|
||||||
when: "on_success"
|
|
||||||
script:
|
|
||||||
- >
|
|
||||||
export RELEASE_VERSION=$(semantic-release --dry-run --branches $CI_COMMIT_REF_NAME --plugins
|
|
||||||
"@semantic-release/gitlab" | grep -oP "Published release [0-9]+\.[0-9]+\.[0-9]+ on" |
|
|
||||||
grep -oP "[0-9]+\.[0-9]+\.[0-9]+")
|
|
||||||
- |
|
|
||||||
if [ -z "${RELEASE_VERSION}" ]; then
|
|
||||||
echo "RELEASE_VERSION=$(git describe --tags --abbrev=0 | sed s@^v@@g )"
|
|
||||||
else
|
|
||||||
echo "RELEASE_VERSION=${RELEASE_VERSION}"
|
|
||||||
fi
|
|
||||||
- |
|
|
||||||
echo -e "\n[INFO] Writing data to helm value file..."
|
|
||||||
cat <<EOF >helmfile/environments/default/global.generated.yaml
|
|
||||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
|
||||||
---
|
|
||||||
global:
|
|
||||||
systemInformation:
|
|
||||||
releaseVersion: "v$(echo -E "$RELEASE_VERSION")"
|
|
||||||
...
|
|
||||||
EOF
|
|
||||||
- |
|
|
||||||
cat << 'EOF' > ${CI_PROJECT_DIR}/.releaserc
|
|
||||||
{
|
|
||||||
"branches": ["main"],
|
|
||||||
"plugins": [
|
|
||||||
"@semantic-release/gitlab",
|
|
||||||
"@semantic-release/release-notes-generator",
|
|
||||||
"@semantic-release/changelog",
|
|
||||||
["@semantic-release/git", {
|
|
||||||
"assets": [
|
|
||||||
"charts/**/Chart.yaml",
|
|
||||||
"CHANGELOG.md",
|
|
||||||
"charts/**/README.md",
|
|
||||||
"helmfile/environments/default/global.generated.yaml",
|
|
||||||
".kyverno/kyverno-test.yaml",
|
|
||||||
"docs"
|
|
||||||
],
|
|
||||||
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
|
||||||
}]
|
|
||||||
]
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
- "semantic-release"
|
|
||||||
needs:
|
|
||||||
- "generate-docs"
|
|
||||||
|
|
||||||
renovate:
|
|
||||||
rules:
|
|
||||||
- if: >
|
|
||||||
$RUN_RENOVATE == "yes"
|
|
||||||
when: "on_success"
|
|
||||||
# The `-full` image does not install the dependencies on the fly, that is our preferred approach
|
|
||||||
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/renovate/renovate:37.356-full"
|
|
||||||
variables:
|
|
||||||
RENOVATE_CONFIG_FILE: "${CI_PROJECT_DIR}/.renovate/config.yaml"
|
|
||||||
RENOVATE_ENDPOINT: "${CI_API_V4_URL}"
|
|
||||||
# Increase the renovatebot log level on stdout
|
|
||||||
LOG_LEVEL: "DEBUG"
|
|
||||||
script:
|
|
||||||
- "renovate ${RENOVATE_EXTRA_FLAGS}"
|
|
||||||
stage: "renovate"
|
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -2,10 +2,10 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
variables:
|
variables:
|
||||||
OPENDESK_CI_CLI_IMAGE: "registry.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli:2.5.2\
|
OPENDESK_CI_CLI_IMAGE: "registry.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli:2.7.2\
|
||||||
@sha256:8445978facabf1526cdb4434e7da8b9c8b9b930337c247ea811b1a53765817e3"
|
@sha256:e33a6327b9c8f89f6e86d13804d5d81e9fdf6974a2f280874d6901067c22fd83"
|
||||||
OPENDESK_LINT_IMAGE: "registry.opencode.de/bmi/opendesk/components/platform-development/images/ci-lint:1.0.7\
|
OPENDESK_LINT_IMAGE: "registry.opencode.de/bmi/opendesk/components/platform-development/images/ci-lint:1.0.14\
|
||||||
@sha256:632ea46d4ff70d39a627404576ea3b14a1cf96d04ea0701cbea6b771765d1769"
|
@sha256:34d2a96e5fc25155abd48fef4d335b131c71d8cbc00ad531df0cae9918b9f2ab"
|
||||||
|
|
||||||
.common:
|
.common:
|
||||||
cache: {}
|
cache: {}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ generate-docs:
|
|||||||
extends: ".generate-common"
|
extends: ".generate-common"
|
||||||
image: "${OPENDESK_CI_CLI_IMAGE}"
|
image: "${OPENDESK_CI_CLI_IMAGE}"
|
||||||
rules:
|
rules:
|
||||||
- if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
|
- if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $RELEASE_BRANCH"
|
||||||
when: "on_success"
|
when: "on_success"
|
||||||
script:
|
script:
|
||||||
- "node /app/src/index.js generate-docs -d ${CI_PROJECT_DIR}"
|
- "node /app/src/index.js generate-docs -d ${CI_PROJECT_DIR}"
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
# SPDX-FileCopyrightText: 2024-2025 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
include:
|
include:
|
||||||
@@ -8,4 +8,18 @@ include:
|
|||||||
extends: ".common"
|
extends: ".common"
|
||||||
stage: "lint"
|
stage: "lint"
|
||||||
|
|
||||||
|
common-yaml-linter:
|
||||||
|
rules:
|
||||||
|
- if: "$JOB_COMMON_YAML_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
||||||
|
when: "never"
|
||||||
|
- when: "always"
|
||||||
|
|
||||||
|
conventional-commits-linter:
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$RUN_RENOVATE == "yes" ||
|
||||||
|
$JOB_CONVENTIONAL_COMMITS_LINTER_ENABLED == 'false' ||
|
||||||
|
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event'
|
||||||
|
when: "never"
|
||||||
|
- when: "always"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -16,18 +16,26 @@ lint-kyverno:
|
|||||||
- "element"
|
- "element"
|
||||||
- "jitsi"
|
- "jitsi"
|
||||||
- "nextcloud"
|
- "nextcloud"
|
||||||
|
- "notes"
|
||||||
- "nubus"
|
- "nubus"
|
||||||
- "open-xchange"
|
- "open-xchange"
|
||||||
|
- "opendesk-migrations-post"
|
||||||
|
- "opendesk-migrations-pre"
|
||||||
|
- "opendesk-openproject-bootstrap"
|
||||||
|
- "opendesk-services"
|
||||||
- "openproject"
|
- "openproject"
|
||||||
- "openproject-bootstrap"
|
- "services-external"
|
||||||
- "services"
|
|
||||||
- "xwiki"
|
- "xwiki"
|
||||||
script:
|
script:
|
||||||
- "cd ${CI_PROJECT_DIR}/helmfile/apps/${APP}"
|
- "cd ${CI_PROJECT_DIR}/helmfile/apps/${APP}"
|
||||||
- >
|
- >
|
||||||
node /app/opendesk-ci-cli/src/index.js generate-kyverno-env
|
node /app/opendesk-ci-cli/src/index.js generate-kyverno-env
|
||||||
-d ${CI_PROJECT_DIR}/helmfile/environments
|
-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"
|
- "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"
|
- "cd ${CI_PROJECT_DIR}/.kyverno"
|
||||||
# Test optional
|
# Test optional
|
||||||
- >
|
- >
|
||||||
|
|||||||
10
.gitlab/lint/lint-reuse.yml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
reuse-linter:
|
||||||
|
allow_failure: false
|
||||||
|
rules:
|
||||||
|
- if: "$JOB_REUSE_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
||||||
|
when: "never"
|
||||||
|
- when: "always"
|
||||||
|
...
|
||||||
8
.gitlab/release/release-common.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
# Overwrite shared settings
|
||||||
|
.common-semantic-release:
|
||||||
|
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/semantic-release:1.1.0"
|
||||||
|
tags: []
|
||||||
|
...
|
||||||
11
.gitlab/release/release-generate-version.yml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
generate-release-version:
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$JOB_RELEASE_ENABLED != 'false' &&
|
||||||
|
$CI_COMMIT_BRANCH == $RELEASE_BRANCH &&
|
||||||
|
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||||
|
when: "on_success"
|
||||||
|
...
|
||||||
63
.gitlab/release/release-semantic.yml
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
release:
|
||||||
|
cache:
|
||||||
|
- key: "generate-docs-${CI_COMMIT_REF_SLUG}"
|
||||||
|
paths:
|
||||||
|
- "${CI_PROJECT_DIR}/docs"
|
||||||
|
policy: "pull"
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||||
|
$CI_COMMIT_BRANCH == $RELEASE_BRANCH &&
|
||||||
|
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||||
|
when: "on_success"
|
||||||
|
script:
|
||||||
|
- >
|
||||||
|
export RELEASE_VERSION=$(semantic-release --dry-run --branches $CI_COMMIT_REF_NAME --plugins
|
||||||
|
"@semantic-release/gitlab" | grep -oP "Published release [0-9]+\.[0-9]+\.[0-9]+ on" |
|
||||||
|
grep -oP "[0-9]+\.[0-9]+\.[0-9]+")
|
||||||
|
- |
|
||||||
|
if [ -z "${RELEASE_VERSION}" ]; then
|
||||||
|
echo "RELEASE_VERSION=$(git describe --tags --abbrev=0 | sed s@^v@@g )"
|
||||||
|
else
|
||||||
|
echo "RELEASE_VERSION=${RELEASE_VERSION}"
|
||||||
|
fi
|
||||||
|
- |
|
||||||
|
echo -e "\n[INFO] Writing data to helm value file..."
|
||||||
|
cat <<EOF >helmfile/environments/default/global.generated.yaml.gotmpl
|
||||||
|
# SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
global:
|
||||||
|
systemInformation:
|
||||||
|
releaseVersion: "v$(echo -E "$RELEASE_VERSION")"
|
||||||
|
...
|
||||||
|
EOF
|
||||||
|
- |
|
||||||
|
cat << 'EOF' > ${CI_PROJECT_DIR}/.releaserc
|
||||||
|
{
|
||||||
|
"branches": ["main"],
|
||||||
|
"plugins": [
|
||||||
|
"@semantic-release/gitlab",
|
||||||
|
"@semantic-release/release-notes-generator",
|
||||||
|
"@semantic-release/changelog",
|
||||||
|
["@semantic-release/git", {
|
||||||
|
"assets": [
|
||||||
|
"charts/**/Chart.yaml",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"charts/**/README.md",
|
||||||
|
"helmfile/environments/default/global.generated.yaml.gotmpl",
|
||||||
|
".kyverno/kyverno-test.yaml",
|
||||||
|
"docs"
|
||||||
|
],
|
||||||
|
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
||||||
|
}]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
- "semantic-release"
|
||||||
|
needs:
|
||||||
|
- "generate-docs"
|
||||||
|
...
|
||||||
19
.gitlab/renovate/renovate.yml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
renovate:
|
||||||
|
rules:
|
||||||
|
- if: >
|
||||||
|
$RUN_RENOVATE == "yes"
|
||||||
|
when: "on_success"
|
||||||
|
# The `-full` image does not install the dependencies on the fly, that is our preferred approach
|
||||||
|
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/renovate/renovate:37.356-full"
|
||||||
|
variables:
|
||||||
|
RENOVATE_CONFIG_FILE: "${CI_PROJECT_DIR}/.renovate/config.yaml"
|
||||||
|
RENOVATE_ENDPOINT: "${CI_API_V4_URL}"
|
||||||
|
# Increase the renovatebot log level on stdout
|
||||||
|
LOG_LEVEL: "DEBUG"
|
||||||
|
script:
|
||||||
|
- "renovate ${RENOVATE_EXTRA_FLAGS}"
|
||||||
|
stage: "renovate"
|
||||||
|
...
|
||||||
6
.kyverno/_overwrite.yaml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
replicas:
|
||||||
|
umsLdapServerPrimary: 2
|
||||||
|
...
|
||||||
@@ -10,7 +10,7 @@ metadata:
|
|||||||
policies.kyverno.io/subject: "Pod"
|
policies.kyverno.io/subject: "Pod"
|
||||||
policies.kyverno.io/description: >-
|
policies.kyverno.io/description: >-
|
||||||
This policy validates if `.Values.persistence.storageClassNames` variables are used in templates and if the size
|
This policy validates if `.Values.persistence.storageClassNames` variables are used in templates and if the size
|
||||||
of volumes can be customized by `.Values.persistence.size` variable.
|
of volumes can be customized by `.Values.persistence.storages.<COMPONENT>.size` variable.
|
||||||
spec:
|
spec:
|
||||||
background: true
|
background: true
|
||||||
rules:
|
rules:
|
||||||
|
|||||||
@@ -32,15 +32,15 @@ repositories:
|
|||||||
# Commit type to use if Semantic Commits are enabled (default: "chore")
|
# Commit type to use if Semantic Commits are enabled (default: "chore")
|
||||||
semanticCommitType: "chore"
|
semanticCommitType: "chore"
|
||||||
# Enable dependency dashboard
|
# Enable dependency dashboard
|
||||||
dependencyDashboard: true
|
dependencyDashboard: false
|
||||||
# Include package files only within these defined paths
|
# Include package files only within these defined paths
|
||||||
includePaths:
|
includePaths:
|
||||||
- "helmfile/environments/default/images.yaml"
|
- "helmfile/environments/default/images.yaml.gotmpl"
|
||||||
- "helmfile/environments/default/charts.yaml"
|
- "helmfile/environments/default/charts.yaml.gotmpl"
|
||||||
customManagers:
|
customManagers:
|
||||||
- customType: "regex"
|
- customType: "regex"
|
||||||
fileMatch:
|
fileMatch:
|
||||||
- "helmfile/environments/default/images.yaml"
|
- "helmfile/environments/default/images.yaml.gotmpl"
|
||||||
datasourceTemplate: "docker"
|
datasourceTemplate: "docker"
|
||||||
matchStrings:
|
matchStrings:
|
||||||
# yamllint disable rule:line-length rule:quoted-strings
|
# yamllint disable rule:line-length rule:quoted-strings
|
||||||
@@ -48,7 +48,7 @@ repositories:
|
|||||||
# yamllint enable rule:line-length rule:quoted-strings
|
# yamllint enable rule:line-length rule:quoted-strings
|
||||||
- customType: "regex"
|
- customType: "regex"
|
||||||
fileMatch:
|
fileMatch:
|
||||||
- "helmfile/environments/default/charts.yaml"
|
- "helmfile/environments/default/charts.yaml.gotmpl"
|
||||||
datasourceTemplate: "docker"
|
datasourceTemplate: "docker"
|
||||||
matchStrings:
|
matchStrings:
|
||||||
# yamllint disable rule:line-length rule:quoted-strings
|
# yamllint disable rule:line-length rule:quoted-strings
|
||||||
@@ -59,30 +59,47 @@ repositories:
|
|||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "openDesk" ]
|
matchDepTypes: [ "openDesk" ]
|
||||||
groupName: "Platform"
|
groupName: "Platform"
|
||||||
|
groupSlug: "platform"
|
||||||
|
branchTopic: "platform"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "Collabora" ]
|
matchDepTypes: [ "Collabora" ]
|
||||||
groupName: "Collabora"
|
groupName: "Collabora"
|
||||||
|
groupSlug: "collabora"
|
||||||
|
branchTopic: "collabora"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "Element" ]
|
matchDepTypes: [ "Element" ]
|
||||||
groupName: "Element"
|
groupName: "Element"
|
||||||
|
groupSlug: "element"
|
||||||
|
branchTopic: "element"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "Nordeck" ]
|
matchDepTypes: [ "Nordeck" ]
|
||||||
groupName: "Nordeck"
|
groupName: "Nordeck"
|
||||||
|
groupSlug: "nordeck"
|
||||||
|
branchTopic: "nordeck"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "Open-Xchange" ]
|
matchDepTypes: [ "Open-Xchange" ]
|
||||||
groupName: "Open-Xchange"
|
groupName: "Open-Xchange"
|
||||||
|
groupSlug: "openxchange"
|
||||||
|
branchTopic: "openxchang"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "OpenProject" ]
|
matchDepTypes: [ "OpenProject" ]
|
||||||
groupName: "OpenProject"
|
groupName: "OpenProject"
|
||||||
|
groupSlug: "openproject"
|
||||||
|
branchTopic: "openproject"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "OpenProject" ]
|
matchDepTypes: [ "Nextcloud" ]
|
||||||
groupName: "OpenProject"
|
groupName: "nextcloud"
|
||||||
|
branchTopic: "nextcloud"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "Univention" ]
|
matchDepTypes: [ "Univention" ]
|
||||||
groupName: "Univention"
|
groupName: "Univention"
|
||||||
|
groupSlug: "univention"
|
||||||
|
branchTopic: "univention"
|
||||||
- matchDatasources: [ "docker" ]
|
- matchDatasources: [ "docker" ]
|
||||||
matchDepTypes: [ "XWiki" ]
|
matchDepTypes: [ "XWiki" ]
|
||||||
groupName: "XWiki"
|
groupName: "XWiki"
|
||||||
|
groupSlug: "xwiki"
|
||||||
|
branchTopic: "xwiki"
|
||||||
# Add merge request labels
|
# Add merge request labels
|
||||||
labels:
|
labels:
|
||||||
- "renovate"
|
- "renovate"
|
||||||
|
|||||||
149
CHANGELOG.md
@@ -1,3 +1,152 @@
|
|||||||
|
## [1.1.2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.1.1...v1.1.2) (2025-02-19)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **dovecot:** Add Dovecot Pro [EE] ([6e343c7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6e343c76a32a5bf4b431bdad6be1f7d107caa4f5))
|
||||||
|
* **element:** Add Element EE components ([61d94a8](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/61d94a8de655d1289aaf59c42f0dbf30b0156e1f))
|
||||||
|
* **helmfile:** Add missing customizing option for Matrix widgets ([9c79c44](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9c79c44453af7b0c68f4ee2a5e40f1f9fb298570))
|
||||||
|
* **helmfile:** Add SSL option for Keycloak Extensions Proxy's PostgreSQL connection ([91d0f98](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/91d0f9868226b08128af518be741c8614342581e))
|
||||||
|
* **helmfile:** Fine-grained service types ([de8b560](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/de8b560fe7e2294229a959398be60bec9b6a7790))
|
||||||
|
* **helmfile:** Integrate oD EE ([03ec704](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/03ec70435c365eca9f555a195b7ab92cc9eee907))
|
||||||
|
* **helmfile:** Introduce `apps` as top level in `opendesk_main.yaml.gotmpl`; Please check migrations.md for upgrades of existing installations ([2fcf014](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/2fcf014894ac3356ef8c6e57dda30c5176172e5e))
|
||||||
|
* **helmfile:** Make openDesk IAM attributes optional with enabled as default ([b32996d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b32996da347c7ec24fb53afe72fee8c07631bebe))
|
||||||
|
* **helmfile:** Provide toggle in `functional.yaml.gotmpl` for "new device notification" mails ([284c9fe](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/284c9fe0c7e217e3f92ec70eaad6ccf593ff2a87))
|
||||||
|
* **helmfile:** Remove reference to no longer required `elementWeb` chart ([cd9c54b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/cd9c54b17733f9e334c558ccd86e69677264970a))
|
||||||
|
* **helmfile:** Set default for domain to `opendesk.internal` to avoid enforcing DOMAIN environment variable for deployments using YAML overrides ([930ae9d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/930ae9d3e71bcd3f4034aa4dae5eabb3ae04d11b))
|
||||||
|
* **helmfile:** Update/streamline theming ([8eeaa23](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/8eeaa23c2f68e8e0cbda5b3763ab15ba8262c48d))
|
||||||
|
* **jitsi:** Support for phone dial-in into Jitsi conferences ([1323ef1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1323ef142e789820acb05cb4991d10502a35498b))
|
||||||
|
* **nextcloud:** Update `groupfolders` app to fix group selection in admin mode ([ab49bf9](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/ab49bf9f6bb945cdce3950e46382b7361c48e6e4))
|
||||||
|
* **nextcloud:** Update Nextcloud to 29.0.11 and support for Cron-Job specific resource definitions ([09f4829](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/09f482981b96774b3fe0948b7bb120be90157148))
|
||||||
|
* **nubus:** Disable unused notification feature ([955f17e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/955f17ef8bb72459beb536cdcf6b502b16eabbff))
|
||||||
|
* **nubus:** Fix Keycloak dialogue background length on small screens ([4662709](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/466270967310fab9333b892c904efa86d21f7d17))
|
||||||
|
* **nubus:** Only configure apps that are deployed to show up in IAM admin UI and Keycloak ([1f051e7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1f051e777905668297c98dfa507875c08158bfda))
|
||||||
|
* **nubus:** Re-implement toggle for UDM-REST-API based on `functional.externalServices.nubus.udmRestApi.enabled` ([777e7d2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/777e7d2fc6afa9c53a4ff1c6853c9960b9a22d5f))
|
||||||
|
* **nubus:** Remove doublet `resources` key in `udm-listener` StatefulSet ([10e0b0a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/10e0b0ad6cbd89bd88b119f17b6cba6ec698f698))
|
||||||
|
* **nubus:** Support for custom UDM commands ([aff8edb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/aff8edbde2150763d6a36f97b9403c8c67e51fab))
|
||||||
|
* **nubus:** Update Keycloak Extensions Proxy ([601e649](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/601e6499132c3adaaaea374033511eab09132cb2))
|
||||||
|
* **open-xchange:** Parameters to split read and write queries to MariaDB ([370247b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/370247b95197792a65b84b2d01b9c1806f8b059a))
|
||||||
|
* **open-xchange:** Update OX App Suite to 8.33 ([581c8ae](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/581c8aed1f86bad251141ecb105e59d0054d5a1a))
|
||||||
|
* **openproject:** Update OpenProject to 15.2.1 ([83c311b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/83c311b101a6fa551d9c25ea4e9a7ef6673137ca))
|
||||||
|
* **oxconnector:** Update to strict `securityContext` from upstream defaults ([32df165](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/32df1657d29a2d73495d52b62bb77521cb8b8e86))
|
||||||
|
|
||||||
|
## [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](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/04ab28c029bb60575c1936ca5acdd2f829b26c06))
|
||||||
|
* **element:** MatrixID for Element "Welcome User" to support deployments where matrix domain differs from homeserver FQDN ([ccb51a0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/ccb51a0de32525a93fd982d52dc8e6a35db8f09a))
|
||||||
|
* **element:** Update Element to 1.11.90 ([335806a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/335806a53e51c3fc6a03440316e909aa51af5be8))
|
||||||
|
* **element:** Update Helm chart to v6.0.2 for a fix when using non generated secrets in `opendesk-synapse` ([d5e73fe](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/d5e73feb880c33e8127f284fcc685ffdc15874a8))
|
||||||
|
* **element:** Update Synapse to 1.121.1 ([33ff922](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/33ff9227b745f99e3abdde6dbbe6b00042fca655))
|
||||||
|
* **helmfile:** Move the access restriction configuration for Keycloak client scopes into helmfile templating, instead of hardcoded Helm chart values ([3662b5c](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3662b5cd255b37321d3a3625f78feff07b7e633c))
|
||||||
|
* **helmfile:** Remove duplicate entries from `secrets.yaml.gotmpl` ([a13cf63](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a13cf630242343dc8f759cfeb423ff626480b086))
|
||||||
|
* **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](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bacf51efb1b042b80f13f5cf3f50557006f32374))
|
||||||
|
* **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](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a0f52ee7d4f6a9b82c9d4e288bc4c6cc96018985))
|
||||||
|
* **helmfile:** Update `opendesk-alerts` and `opendesk-dashboards` to get predictable sort order, improving GitOps deployments ([0c91117](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0c91117575a3b56ff9f0b4ae72a501b9f3b4384c))
|
||||||
|
* **helmfile:** Update upstream images for k8s/kubectl to v1.32.0 ([b71c2e5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b71c2e57eec10093d96804e249fbaf81c51fb22e))
|
||||||
|
* **intercom:** Remove legacy OIDC claims ([6796f32](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6796f320f72db02d67b73685aa6356cda9ac86d1))
|
||||||
|
* **nextcloud:** Update image and Helm chart to support app toggles during deployment ([1cdfcf2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1cdfcf2784271f2b8ea61d2e8e534db2aa386f4b))
|
||||||
|
* **nextcloud:** Update to Nextcloud 29.0.10 ([d096fb1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/d096fb1154dbcd092e105d4450e7996dfda0388e))
|
||||||
|
* **nubus:** Fix `pullPolicy` setting for `ldapServer.leaderElector` to satisfy Kyverno linter ([6f2f7cd](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6f2f7cd5db6708c1fc523e3cf3160f39f1dba2bb))
|
||||||
|
* **nubus:** Merge yaml files for better maintainability ([6c67eca](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6c67eca7aa68c3f597cc5790ba1046ca0855c329))
|
||||||
|
* **nubus:** Pre-create groups in Keycloak to avoid race condition on group sync when initial users login parallel ([5496317](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5496317fee1ca47a80d0798b9048a1474ca8e2a6))
|
||||||
|
* **nubus:** Remove `extra` settings from ldapServer needed for openDesk 1.0.0 LDAP migration ([fab862e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/fab862eec689bf8ef547c4bd06244313f24f6d0b))
|
||||||
|
* **nubus:** Remove b64 encoded files from CSS, instead use `opendesk-static-files` ([2926e2c](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/2926e2c93a2b4be24abd1e6dd4ce02071a629cb4))
|
||||||
|
* **nubus:** Template `secrets.nubus.masterpassword`. **Note:** Please check migrations.md for details. ([5aae75a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5aae75a1521f73e497859fe3d3b89a8752bb47a1))
|
||||||
|
* **nubus:** Update customizations for group cleanup ([0b230fa](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0b230fa2cc841edfde99f5d94dc9c8054bfbb5ec))
|
||||||
|
* **open-xchange:** Add missing `registryOpencodeDe` to OX-Connector's `waitForDependency` image ([a16d907](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a16d9071c96ef7fde87e6579c328e1e05509824b))
|
||||||
|
* **openproject:** Update to 15.1.1 ([b4b714f](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b4b714ff41a8f01d4b44c6d5ced3f036f7d90699))
|
||||||
|
* **openproject:** Update to 15.2.0 ([9d8e9c3](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9d8e9c3ade9917fb8044331ebdea8d7bca4066b0))
|
||||||
|
* **static-files:** Update Helm chart to use more generic `assets` over `theme.imagery.assets` ([63562c1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/63562c1aae6b2c33ea39b93c11e842c2ab1e2c25))
|
||||||
|
* **static-files:** Update Helm chart to v4.0.1 to support longer domain names ([b0e665b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b0e665b031baf36c59eea85b3d575f1a49290bf1))
|
||||||
|
* **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](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/033cb558ddc0b47d17b006cdc75c593c5c356147))
|
||||||
|
|
||||||
|
# [1.1.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v1.0.0...v1.1.0) (2024-12-24)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **cassandra:** Prepare cassandra for openDesk Enterprise. ([508e286](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/508e28623258542a4082e79ed75ce1e5758ae2e0))
|
||||||
|
* **cassandra:** Remove values in charts.yaml for enterprise components. ([c0cbb76](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c0cbb76921b5108d084640baf3e607e9fc6557c7))
|
||||||
|
* **ci:** Explicitly set RELEASE_BRANCH (to `main`) for scan and release steps ([e5ad0bb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e5ad0bb2e028dafab0ba29fb2e9b0d207b8795fd))
|
||||||
|
* **ci:** Reduce Kyverno linting issues ([e4d9106](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e4d9106c457e018922dcc730df0570d41f3ec2aa))
|
||||||
|
* **collabora:** Add/update Helmfile for Collabora Controller to be used in EE deployments ([a63d7cb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a63d7cb8614bfa7d26d997ffdf3ea807ae187664))
|
||||||
|
* **collabora:** Update to 24.04.9.2. ([407f2be](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/407f2be2ad2d40813bb37e0ba302ef14e3a06bd9))
|
||||||
|
* **docs:** Add `architecture.md` and `apis.md` ([7710858](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/77108587c71dee16ecf539608838c8c9064a66f8))
|
||||||
|
* **docs:** Add GitOps / Argo CD documentation ([bbe7550](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bbe7550c4617b4799190192b5316ac04295e9e88))
|
||||||
|
* **docs:** Update and streamline README.md and migrations.md. ([a86c0af](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a86c0afdbb7fa1230aa90cf210323969fd580431))
|
||||||
|
* **element:** Add extensive database options ([9e102e2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9e102e2d1b9d6621b9c5d6ed0643432e8879f663))
|
||||||
|
* **element:** Prepare element for openDesk Enterprise. ([00a1a93](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/00a1a9394ee3544b1a0d7b3e975c36830ba8b13c))
|
||||||
|
* **element:** Rename release opendesk-element to opendesk-element-web ([1213ecc](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1213ecc425041ac4adba99a0ae2d8188932a7d9f))
|
||||||
|
* **element:** Switch `element-web` base image to Alpine ([47ce294](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/47ce29440388370f7d63e373eeda90d067830ebd))
|
||||||
|
* **element:** Toggle IPv4-only mode depending on cluster.networking.ipFamilies ([627b9c1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/627b9c1e8464fd9529ddf50f171031053710323c))
|
||||||
|
* **element:** Update Matrix Meetings Bot to 2.8.2 ([4403dfe](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4403dfe720982a8339043951a4dfc88bfb0af57c))
|
||||||
|
* **element:** Update Synapse to 1.120.2 and Element to 1.11.87 update also related containers ([9d7644d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9d7644dc04c9ef97449680e5197f2129d62d56f8))
|
||||||
|
* **helmfile:** Add `opendesk-static-files` to `opendesk-services` to serve favicons ([6438284](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6438284090f3e552843679c1ea62b5538be5dff9))
|
||||||
|
* **helmfile:** Add Redis username and tls option ([564fb2d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/564fb2d7c7190a91446293ce21950701503ecbb7))
|
||||||
|
* **helmfile:** Allow usage of pre-defined CA certificates. ([0738fa0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0738fa080d61f0e6c084dd8fd5e09635469b1dca))
|
||||||
|
* **helmfile:** Auto-redirect user to login dialogue, please read migrations.md for more details ([a9c8dfe](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/a9c8dfeab125510a7d9a137e16b14685155aa441))
|
||||||
|
* **helmfile:** Remove `default.user` and `default.admin` for new deployments. ([54f9e4c](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/54f9e4c3f8fd425bde1272e3eec490efa30461f7))
|
||||||
|
* **helmfile:** Remove `theme` subtree from the migration's `.Values` secret to avoid a bloated secret hitting limits in certain clusters setups and GitOps tools. ([b6725dd](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b6725dddc19f22e142a214c02aef5139b2921d5a))
|
||||||
|
* **helmfile:** Splitting the directory `./helmfile/apps/services` into `-external` and `opendesk-` services, please read migrations.md for more details ([277a1f5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/277a1f5a65e340180feeb84cce2097be5a2157e1))
|
||||||
|
* **helmfile:** Streamline `commonLabels.deployStage`. ([f969425](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/f96942536f931e8f8eb714ce0503716b873b593b))
|
||||||
|
* **helmfile:** Streamline `requests.cpu` in `resources.yaml` ([43f427e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/43f427e06a83aea8979e1b54f7ea7f2d24ab28cf))
|
||||||
|
* **helmfile:** Streamline file extensions in `/helmfile/environments/default` to ([0e3b661](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0e3b6615653d7bbe30b09e57428b1f5c19f171f8))
|
||||||
|
* **helmfile:** Unify templating name for Open-Xchange to `openxchange` and for OX App Suite to `oxAppSuite`. ([6ff1fcd](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6ff1fcd438103534e78a5898f25fcea1080dfb86))
|
||||||
|
* **helmfile:** Use dictionaries for defining `customization.yaml`, please read migrations.md for more details ([86ef0be](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/86ef0be542b0e34d76a85cb226e223a3e7dbc76e))
|
||||||
|
* **jitsi:** Update Jitsi Helm chart and images. ([5c691e4](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5c691e450821c81b363040b68ffba96e38d1712b))
|
||||||
|
* **jitsi:** Update to 2.0.9823 and chart to 2.1.1 ([56ce335](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/56ce3355fcedf60595f33609848f6c8bd8644914))
|
||||||
|
* **jitsi:** Update to switch the colors of `Hang up` and `End meeting for all` buttons. ([9dbb2b7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/9dbb2b755caa8e6bda80bed691c54e66b1a63eb9))
|
||||||
|
* **migrations:** Cleanup of jobs ([539a302](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/539a30263c9ce25ab7c6aa6607fd41cd1099315b))
|
||||||
|
* **migrations:** Update to support Nubus 1.5.1 ([7f60ab3](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7f60ab3b7a155c8f95bfcf139fa896cbc41ca767))
|
||||||
|
* **nextcloud:** Add Redis TLS option ([1402593](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1402593556af9cf039878a1261b656424fc45c88))
|
||||||
|
* **nextcloud:** Fix templating for nextcloud database name ([7f1f6cd](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/7f1f6cdcd4385d24cf13cdf9425b615337a131de))
|
||||||
|
* **nextcloud:** Fix templating for nextcloud database user ([c8c12a2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c8c12a278e8d00f04c1c7b6dd7fbdf3826c89a19))
|
||||||
|
* **nextcloud:** Support IPv4 only clusters ([b25ada1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b25ada1f603659cd551be23d62992e8fa6a0603d))
|
||||||
|
* **nextcloud:** Trusted Proxy setting. ([bc0ca8b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/bc0ca8b4c1dfdcd046c9b4ddd1f63a28e6a5531a))
|
||||||
|
* **nextcloud:** Update Chart to 3.6.1 and Image to 2.3.3 (including rollback to 29.0.8). Introducing setting for `functional.filestore.sharing.external.sendPasswordMail` ([18fcaa0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/18fcaa0331c9c94bb2f260f97fbadad44b019bb6))
|
||||||
|
* **nextcloud:** Update to 29.0.9 incl. latest apps. ([c63cca7](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c63cca72a35cdeb35b8ea48d98a5c5d55982d145))
|
||||||
|
* **notes:** Add `favicon.ico` via `opendesk-static-files` ([669995b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/669995bb95235a56f7b2387c4c582d6e7250e4a9))
|
||||||
|
* **notes:** Add https to all endpoints ([174951c](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/174951cd5145e83d776a9b4bda4f091d5b827402))
|
||||||
|
* **nubus:** Add nginx s3 proxy when minio disabled ([b3b6ab5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b3b6ab5a61dc5bca13c8b1f4e6b716bbcad64e8c))
|
||||||
|
* **nubus:** Enable Keycloak debug mode logging; add Keycloak specific section to debugging.md ([3b3679b](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3b3679bab150ece327ce1e132933820b1e3afa88))
|
||||||
|
* **nubus:** Fix selfsigned certificate mounts ([b90bff3](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b90bff30b35b91fff792f2d5d617de4cdba30f23))
|
||||||
|
* **nubus:** Leader election on re-deployments ([b965677](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/b9656772a9c743c9119a850e0b48cb39d68f48fa))
|
||||||
|
* **nubus:** Start ums keycloak bootstrap already during Sync phase ([16dfd25](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/16dfd255c621b1da311fd6fee775f7397e5f6792))
|
||||||
|
* **nubus:** Update external portal links and login screen background. ([901b1f5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/901b1f529e7d16a8164511bebac1e7f9a475d111))
|
||||||
|
* **nubus:** Update to 1.4.0 ([2a94f2d](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/2a94f2dd4bdfa039b4459b3711e171ee46172583))
|
||||||
|
* **nubus:** Update to v1.5.1 ([4c7422a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4c7422a411a4fa1ddc36430d363ae06226efb31d))
|
||||||
|
* **nubus:** Use favicon with transparent background for portal ([1b13c3e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1b13c3ea658786420d960c8e67aed81f40067c0a))
|
||||||
|
* **open-xchange:** Extend Dovecot LDAP filter to also match OX-Resources ([31ea6e0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/31ea6e0e08226afb8d9cba4370033fd6f742459b))
|
||||||
|
* **open-xchange:** Fix truststore decrypt error on self-signed deployments ([8611d95](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/8611d95e5a4ab7b158ed8322676589c3d196b548))
|
||||||
|
* **open-xchange:** Update AppSuite to 8.30, update Helm chart to 2.12.85 ([0c88699](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/0c886999174f87030af268c7fdd0beee11f01346))
|
||||||
|
* **opendesk-services:** Update minio to 2024.12.13 ([4cda827](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4cda827f5554ed7ff92a85fc62f6908183181f9b))
|
||||||
|
* **opendesk-services:** Update otterize Network Policies ([4602396](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4602396583c454a23b3458c54cb40e259f245163))
|
||||||
|
* **openproject:** Bump Helm chart to 9.2 ([718eb45](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/718eb45e9c9961f1f792b59e232fd7da66916c7d))
|
||||||
|
* **openproject:** Bump version to 15.0.2 ([c06e0bb](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c06e0bb8d4d04c8794dafddecc189d5f376d661e))
|
||||||
|
* **openproject:** Update 15.1.0 image ([6d329e1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/6d329e18cff8c6ebbbf1b0965801827079904f88))
|
||||||
|
* **openproject:** Update branding and Helm chart to 9.0.1 ([d3b1916](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/d3b191644b0bf20cac1cd9f85ed4b4dc7c6b549d))
|
||||||
|
* **openproject:** Update to 14.6.3 incl. latest Helm chart (8.3.2). ([4c82adf](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/4c82adf668c7f90489bc4ae46426cf607e3425d8))
|
||||||
|
* **postfix:** Added service type definition analogous to dovecot ([31ec100](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/31ec1003c0874a2920132c61d48a1a88e5569cb8))
|
||||||
|
* **services:** Add template for certificate issuerRef.kind ([df144fe](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/df144fe3d3ffd70ca0b7e5aa4c2894b96d0138f1))
|
||||||
|
* **services:** Update MariaDB chart to v3.0.3 in preparation for the use of external secrets. ([08feab1](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/08feab1cfcc099d9b8caed2c4db9a97d4542a5ac))
|
||||||
|
* **services:** Update Redis to 7.4.1 as required by OX Appsuite, please read migrations.md for more details ([5e0b2e2](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/5e0b2e26fc33d7befcb3f94d748e8e9d6f93f383))
|
||||||
|
* **xwiki:** Fix templating for xwiki database port ([de15071](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/de15071ae9d6194d93f9a5fbb0033650b266eaf9))
|
||||||
|
* **xwiki:** Set superadmin password account only when debug is enabled ([e2b3bd5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/e2b3bd543fab7be512cef58382c4d62c48cd79b4))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **helmfile:** Add grafana dashboards ([1441c57](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/1441c5734f42b995505e6aa97f59bdb1eae32b1b))
|
||||||
|
* **helmfile:** Add openDesk specific alerts ([f630a36](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/f630a369da12ef7f19d5553c6dbd5955e414868f))
|
||||||
|
* **helmfile:** Add template support for antivirus icap/milter ([83da87e](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/83da87e9623be294753302686a8d8270c28bcc58))
|
||||||
|
* **helmfile:** Allow custom/self-signed ca-certificates ([c71faf5](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/c71faf5e8011c42b02fd5025a9b1629300a4f1e3))
|
||||||
|
* **jitsi:** Enable Jitsi room history by default. ([45add79](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/45add7981c3a50045caeadb7f2b0bc11254ae562))
|
||||||
|
* Newsfeed in Portal based on XWiki blog feature ([3ad285a](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/3ad285a8695a32607c4bf0faea0747c7e685dcd6))
|
||||||
|
* **notes:** Integrate Preview of Notes app ([96f1819](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/commit/96f18196c53267dbd72cd28e6fbadf06448db93a))
|
||||||
|
|
||||||
# [1.0.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v0.9.0...v1.0.0) (2024-10-14)
|
# [1.0.0](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/compare/v0.9.0...v1.0.0) (2024-10-14)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
106
README-EE.md
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1>openDesk Enterprise Edition</h1>
|
||||||
|
|
||||||
|
<!-- TOC -->
|
||||||
|
* [Components](#components)
|
||||||
|
* [Enabling the Enterprise deployment](#enabling-the-enterprise-deployment)
|
||||||
|
* [Configuring the oD EE deployment for self-hosted installations](#configuring-the-od-ee-deployment-for-self-hosted-installations)
|
||||||
|
* [Registry access](#registry-access)
|
||||||
|
* [License keys](#license-keys)
|
||||||
|
<!-- TOC -->
|
||||||
|
|
||||||
|
openDesk Enterprise Edition is recommended for production use. It receives support and patches from ZenDiS and the suppliers of the components due to the included product subscriptions.
|
||||||
|
|
||||||
|
The document refers to openDesk Community Edition as "oD CE" and for the openDesk Enterprise Edition it is "oD EE".
|
||||||
|
|
||||||
|
Please contact [ZenDiS](mailto:opendesk@zendis.de) to get openDesk Enterprise, either as SaaS offering or for you on-premise installation.
|
||||||
|
|
||||||
|
# Components
|
||||||
|
|
||||||
|
The following components using the same codebase and artifacts for their Enterprise and Community offering:
|
||||||
|
- Cryptpad
|
||||||
|
- Jitsi
|
||||||
|
- Nubus
|
||||||
|
- OpenProject
|
||||||
|
- XWiki
|
||||||
|
|
||||||
|
The following components have - at least partially - Enterprise specific artifacts:
|
||||||
|
|
||||||
|
- Collabora: Collabora Online image version `<major>.<minor>.<patch>.3` will be used once available, at the same time the Collabora Development Edition image will be updated to `<major>.<minor>.<patch>.2` for oD CE.
|
||||||
|
- Element: Some artifacts providing additional functionality are only available in oD EE. For the shared artifacts we keep the ones in oD CE and oD EE in sync.
|
||||||
|
- Nextcloud: Specific enterprise image based on the NC Enterprise package is build based on the same release version as used in oD CE.
|
||||||
|
- OX AppSuite: oD CE and EE are using the same release version, in EE an enterprise-built container of the AppSuite's Core-Middleware is being integrated.
|
||||||
|
- OX Dovecot Pro 3: Dovecot Pro provides support for S3 storage and this feature is used by default.
|
||||||
|
|
||||||
|
# Enabling the Enterprise deployment
|
||||||
|
|
||||||
|
To enable the oD EE deployment you must set the environment variable `OPENDESK_ENTERPRISE` to any value that does not evaluate to boolean *false* for [Helm flow control](https://helm.sh/docs/chart_template_guide/control_structures/#ifelse), e.g. `"true"`, `"yes"` or `"1"`:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
OPENDESK_ENTERPRISE=true
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
> Upgrading from oD CE to EE is currently not supported, especially due to the fact it requires a migration
|
||||||
|
> from Dovecot 2.x (standard storage) to Dovecot Pro 3.x (S3).
|
||||||
|
|
||||||
|
# Configuring the oD EE deployment for self-hosted installations
|
||||||
|
|
||||||
|
## Registry access
|
||||||
|
|
||||||
|
With openDesk EE you get access to the related artifact registry owned by ZenDiS.
|
||||||
|
|
||||||
|
Three steps are required to access the registry - for step #1 and #2 you can set some variables. You can to define a `<your_name_for_the_secret>` freely, like `enterprise-secret`, as long as it consistent in step #1 and #3.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
NAMESPACE=<your_namespace>
|
||||||
|
NAME_FOR_THE_SECRET=<your_name_for_the_secret>
|
||||||
|
YOUR_ENTERPRISE_REGISTRY_USERNAME=<your_registry_credential_username>
|
||||||
|
YOUR_ENTERPRISE_REGISTRY_PASSWORD=<your_registry_credential_password>
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Add your registry credentials as secret to the namespace you want to deploy openDesk to. Do not forget to create the namespace if it does not exist yet (`kubectl create namespace ${NAMESPACE}`).
|
||||||
|
|
||||||
|
```shell
|
||||||
|
kubectl create secret --namespace "${NAMESPACE}" \
|
||||||
|
docker-registry "${NAME_FOR_THE_SECRET}" \
|
||||||
|
--docker-server "registry.opencode.de" \
|
||||||
|
--docker-username "${YOUR_ENTERPRISE_REGISTRY_USERNAME}" \
|
||||||
|
--docker-password "${YOUR_ENTERPRISE_REGISTRY_PASSWORD}" \
|
||||||
|
--dry-run=client -o yaml | kubectl apply -f -
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Docker login to the registry to access Helm charts for local deployments:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker login registry.opencode.de -u ${YOUR_ENTERPRISE_REGISTRY_USERNAME} -p ${YOUR_ENTERPRISE_REGISTRY_PASSWORD}
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Reference the secret from step #1 in the deployment as well as the registry itself for `images` and `helm` charts:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
global:
|
||||||
|
imagePullSecrets:
|
||||||
|
- "<your_name_for_the_secret>"
|
||||||
|
repositories:
|
||||||
|
image:
|
||||||
|
registryOpencodeDeEnterprise: "registry.opencode.de"
|
||||||
|
helm:
|
||||||
|
registryOpencodeDeEnterprise: "registry.opencode.de"
|
||||||
|
```
|
||||||
|
|
||||||
|
## License keys
|
||||||
|
|
||||||
|
Some applications require license information for their Enterprise features to be enabled. With the aforementioned registry credentials you will also receive a file called `enterprise.yaml` containing the relevant license keys.
|
||||||
|
|
||||||
|
Please place the file next your other `.yaml.gotmpl` file(s) that configure your deployment.
|
||||||
|
|
||||||
|
Details regarding the scope/limitation of the component's licenses:
|
||||||
|
|
||||||
|
- Nextcloud: Enterprise license to enable [Nextcloud Enterprise](https://nextcloud.com/de/enterprise/) specific features, can be used across multiple installations until the licensed number of users is reached.
|
||||||
|
- OpenProject: Domain specific enterprise license to enable [OpenProject's Enterprise feature set](https://www.openproject.org/enterprise-edition/), domain matching can use regular expressions.
|
||||||
|
- XWiki: Deployment specific enterprise license (key pair) to activate the [XWiki Pro](https://xwiki.com/en/offerings/products/xwiki-pro) apps.
|
||||||
44
README.md
@@ -12,8 +12,11 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
* [Getting started](#getting-started)
|
* [Getting started](#getting-started)
|
||||||
* [Advanced customization](#advanced-customization)
|
* [Advanced customization](#advanced-customization)
|
||||||
* [Components](#components)
|
* [Architecture](#architecture)
|
||||||
|
* [Testing](#testing)
|
||||||
|
* [Permissions](#permissions)
|
||||||
* [Releases](#releases)
|
* [Releases](#releases)
|
||||||
|
* [Data Storage](#data-storage)
|
||||||
* [Feedback](#feedback)
|
* [Feedback](#feedback)
|
||||||
* [Development](#development)
|
* [Development](#development)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
@@ -25,19 +28,21 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the
|
openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the
|
||||||
*Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH*.
|
*Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH*.
|
||||||
|
|
||||||
|
For production use the [openDesk Enterprise Edition](./README-EE.md) is required.
|
||||||
|
|
||||||
openDesk currently features the following functional main components:
|
openDesk currently features the following functional main components:
|
||||||
|
|
||||||
| Function | Functional Component | Component<br/>Version | Upstream Documentation |
|
| Function | Functional Component | Component<br/>Version | Upstream Documentation |
|
||||||
| -------------------- | --------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
| -------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| Chat & collaboration | Element ft. Nordeck widgets | [1.11.67](https://github.com/element-hq/element-desktop/releases/tag/v1.11.67) | [For the most recent release](https://element.io/user-guide) |
|
| 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/) |
|
| 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.9](https://nextcloud.com/de/changelog/#29-0-9) | [Nextcloud 29](https://docs.nextcloud.com/) |
|
| 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/) |
|
| 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) |
|
| 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.0](https://www.univention.de/produkte/nubus/) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) |
|
| 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.0.2](https://www.openproject.org/docs/release-notes/15-0-2/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) |
|
| Project management | OpenProject | [15.3.0](https://www.openproject.org/docs/release-notes/15-3-0/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) |
|
||||||
| Videoconferencing | Jitsi | [2.0.9779](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9779) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/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.7.2](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) |
|
| Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) |
|
||||||
|
|
||||||
While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to
|
While not all components are perfectly 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.
|
align the applications with best practices regarding container design and operations.
|
||||||
@@ -73,9 +78,17 @@ You would like to install openDesk in your own infrastructure?
|
|||||||
- [Monitoring](./docs/monitoring.md)
|
- [Monitoring](./docs/monitoring.md)
|
||||||
- [Theming](./docs/theming.md)
|
- [Theming](./docs/theming.md)
|
||||||
|
|
||||||
# Components
|
# Architecture
|
||||||
|
|
||||||
More information on openDesk's components and their integration can be found in our detailed [Component docs](./docs/components.md).
|
More information on openDesk's architecture can be found in our [architecture docs](./docs/architecture.md).
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
|
||||||
|
openDesk is continously tested to ensure a high quality. Read how we test in openDesk in our [test concept](./docs/testing.md).
|
||||||
|
|
||||||
|
# Permissions
|
||||||
|
|
||||||
|
Find out more about the permission system in the[roles & permissions concept](./docs/permissions.md)
|
||||||
|
|
||||||
# Releases
|
# Releases
|
||||||
|
|
||||||
@@ -87,11 +100,16 @@ of this project.
|
|||||||
|
|
||||||
Please find a list of the artifacts related to the release either in the source code archive attached to the release or
|
Please find a list of the artifacts related to the release either in the source code archive attached to the release or
|
||||||
in the files from the release's git-tag:
|
in the files from the release's git-tag:
|
||||||
- `./helmfile/environments/default/images.yaml`
|
- `./helmfile/environments/default/images.yaml.gotmpl`
|
||||||
- `./helmfile/environments/default/charts.yaml`
|
- `./helmfile/environments/default/charts.yaml.gotmpl`
|
||||||
|
|
||||||
Find more information in our [Workflow documentation](./docs/workflow.md).
|
Find more information in our [Workflow documentation](./docs/workflow.md).
|
||||||
|
|
||||||
|
# Data Storage
|
||||||
|
|
||||||
|
More information about different data storages used within openDesk are described in the
|
||||||
|
[Data Storage documentation](./docs/data-storage.md).
|
||||||
|
|
||||||
# Feedback
|
# Feedback
|
||||||
|
|
||||||
We love to get feedback from you!
|
We love to get feedback from you!
|
||||||
@@ -112,4 +130,4 @@ This project uses the following license: Apache-2.0
|
|||||||
|
|
||||||
# Copyright
|
# Copyright
|
||||||
|
|
||||||
Copyright (C) 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
Copyright (C) 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
|||||||
@@ -14,7 +14,12 @@ SPDX-FileCopyrightText = "2023 Bundesministerium des Innern und für Heimat, PG
|
|||||||
SPDX-License-Identifier = "CC0-1.0"
|
SPDX-License-Identifier = "CC0-1.0"
|
||||||
|
|
||||||
[[annotations]]
|
[[annotations]]
|
||||||
path = "helmfile/files/theme/*"
|
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-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
|
||||||
SPDX-License-Identifier = "Apache-2.0"
|
SPDX-License-Identifier = "Apache-2.0"
|
||||||
|
|
||||||
|
|||||||
133
cspell.json
@@ -4,79 +4,82 @@
|
|||||||
"dictionaryDefinitions": [],
|
"dictionaryDefinitions": [],
|
||||||
"dictionaries": [],
|
"dictionaries": [],
|
||||||
"words": [
|
"words": [
|
||||||
"openDesk",
|
"Addressbooks",
|
||||||
"AppSuite",
|
"AppSuite",
|
||||||
"Collabora",
|
"Arbeitsplatz",
|
||||||
"Digitale",
|
|
||||||
"Jitsi",
|
|
||||||
"Nextcloud",
|
|
||||||
"Öffentlichen",
|
|
||||||
"OpenProject",
|
|
||||||
"Souveränität",
|
|
||||||
"Verwaltung",
|
|
||||||
"Zentrum",
|
|
||||||
"Keycloak",
|
|
||||||
"NATS",
|
|
||||||
"slapadd",
|
|
||||||
"slapcat",
|
|
||||||
"RDBMS",
|
|
||||||
"Velero",
|
|
||||||
"Univention",
|
|
||||||
"OIDC",
|
|
||||||
"kcadmin",
|
|
||||||
"DMARC",
|
|
||||||
"homeserver",
|
|
||||||
"Bundesministerium",
|
|
||||||
"Innern",
|
|
||||||
"Heimat",
|
|
||||||
"Projektgruppe",
|
|
||||||
"Aufbau",
|
"Aufbau",
|
||||||
"Filepicker",
|
"bootstrap",
|
||||||
"Weboffice",
|
"Bundesministerium",
|
||||||
"Xchange",
|
|
||||||
"opencode",
|
|
||||||
"seccomp",
|
|
||||||
"psql",
|
|
||||||
"databasename",
|
|
||||||
"helmfile",
|
|
||||||
"gotmpl",
|
|
||||||
"containerd",
|
|
||||||
"letsencrypt",
|
|
||||||
"CNCF",
|
|
||||||
"kubespray",
|
|
||||||
"ICAP",
|
|
||||||
"Ceph",
|
"Ceph",
|
||||||
|
"clamav",
|
||||||
|
"CNCF",
|
||||||
|
"Collabora",
|
||||||
|
"commandline",
|
||||||
|
"configurability",
|
||||||
|
"containerd",
|
||||||
"Coturn",
|
"Coturn",
|
||||||
"Minio",
|
"cryptpad",
|
||||||
"Kyverno",
|
"databasename",
|
||||||
"Otterize",
|
"Digitale",
|
||||||
"IBAC",
|
"DMARC",
|
||||||
"pubkeys",
|
|
||||||
"Grundschutz",
|
|
||||||
"Kubescape",
|
|
||||||
"Gitflow",
|
|
||||||
"hadolint",
|
|
||||||
"explorative",
|
"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",
|
"Nordeck",
|
||||||
"Nubus",
|
"Nubus",
|
||||||
"Souveräne",
|
"Öffentlichen",
|
||||||
"Arbeitsplatz",
|
"OIDC",
|
||||||
"commandline",
|
"opencode",
|
||||||
"helmfiles",
|
"openDesk",
|
||||||
"SMTPS",
|
"OpenProject",
|
||||||
"IMAPS",
|
"Otterize",
|
||||||
"xwiki",
|
"Projektgruppe",
|
||||||
"cryptpad",
|
"psql",
|
||||||
"clamav",
|
"pubkeys",
|
||||||
"templating",
|
"RDBMS",
|
||||||
"localpart",
|
"seccomp",
|
||||||
"Addressbooks",
|
|
||||||
"filestore",
|
|
||||||
"trashbin",
|
|
||||||
"bootstrap",
|
|
||||||
"configurability",
|
|
||||||
"selfsigned",
|
"selfsigned",
|
||||||
"truststore"
|
"slapadd",
|
||||||
|
"slapcat",
|
||||||
|
"SMTPS",
|
||||||
|
"Souveräne",
|
||||||
|
"Souveränität",
|
||||||
|
"templating",
|
||||||
|
"trashbin",
|
||||||
|
"truststore",
|
||||||
|
"Univention",
|
||||||
|
"Velero",
|
||||||
|
"Verwaltung",
|
||||||
|
"Videokonferenz",
|
||||||
|
"Weboffice",
|
||||||
|
"Xchange",
|
||||||
|
"xwiki",
|
||||||
|
"Zentrum",
|
||||||
|
"analysed"
|
||||||
],
|
],
|
||||||
"ignoreWords": [],
|
"ignoreWords": [],
|
||||||
"import": []
|
"import": []
|
||||||
|
|||||||
@@ -7,30 +7,40 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
|
|
||||||
* [charts-local.py](#charts-localpy)
|
* [charts-local.py](#charts-localpy)
|
||||||
* [Commandline parameter](#commandline-parameter)
|
* [Commandline parameter](#commandline-parameter)
|
||||||
* [`--branch`](#--branch)
|
* [`--match <your_string>`](#--match-your_string)
|
||||||
* [`--revert`](#--revert)
|
* [`--revert`](#--revert)
|
||||||
|
* [`--branch` (deprecated)](#--branch-deprecated)
|
||||||
|
|
||||||
# charts-local.py
|
# charts-local.py
|
||||||
|
|
||||||
This script helps you on cloning the platform development Helm charts and referencing them directly in the openDesk
|
This script helps you with cloning/pulling 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
|
Helmfile deployment for comfortable local test and development. The charts will be cloned/pulled into a directory
|
||||||
parallel created next to the `opendesk` repo containing this documentation and the `charts-local.py` script.
|
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.
|
The name of the directory containing the charts is based on the (currently) selected branch of the openDesk
|
||||||
|
repo prefixed with `charts-`.
|
||||||
|
|
||||||
|
The script will create `.bak` copies of the helmfiles that have been touched that can easily be reverted to
|
||||||
|
using the `--revert` option.
|
||||||
|
|
||||||
Run the script with `-h` to get information about the script's parameter on commandline.
|
Run the script with `-h` to get information about the script's parameter on commandline.
|
||||||
|
|
||||||
## Commandline parameter
|
## Commandline parameter
|
||||||
|
|
||||||
### `--branch`
|
### `--match <your_string>`
|
||||||
|
|
||||||
|
Will only fetch repos or pull images for charts which name matches `<your_string>`.
|
||||||
|
|
||||||
|
### `--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.
|
||||||
|
|
||||||
|
### `--branch` (deprecated)
|
||||||
|
|
||||||
Optional parameter: Defines a branch for the `opendesk` repo to work with. The script will create the branch if it
|
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.
|
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.
|
If parameter is omitted the current branch of the `opendesk` repo will be used.
|
||||||
|
|
||||||
### `--revert`
|
As this parameter was used rarely, we might remove the support in a later version.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import logging
|
|||||||
import yaml
|
import yaml
|
||||||
import sys
|
import sys
|
||||||
import shutil
|
import shutil
|
||||||
import re
|
import subprocess
|
||||||
import configargparse
|
import configargparse
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -17,13 +17,14 @@ 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('--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('--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('--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('--loglevel', env_var='LOGLEVEL', default='DEBUG', help='Set the loglevel: DEBUG, INFO, WARNING, ERROR, CRITICAL-')
|
p.add('--loglevel', env_var='LOGLEVEL', default='DEBUG', help='Set the loglevel: DEBUG, INFO, WARNING, ERROR, CRITICAL-')
|
||||||
options = p.parse_args()
|
options = p.parse_args()
|
||||||
|
|
||||||
script_path = os.path.dirname(os.path.realpath(__file__))
|
script_path = os.path.dirname(os.path.realpath(__file__))
|
||||||
# some static definitions
|
# some static definitions
|
||||||
log_path = script_path+'/../logs'
|
log_path = script_path+'/../logs'
|
||||||
charts_yaml = script_path+'/../helmfile/environments/default/charts.yaml'
|
charts_yaml = script_path+'/../helmfile/environments/default/charts.yaml.gotmpl'
|
||||||
base_repo_path = script_path+'/..'
|
base_repo_path = script_path+'/..'
|
||||||
base_helmfile = base_repo_path+'/helmfile_generic.yaml.gotmpl'
|
base_helmfile = base_repo_path+'/helmfile_generic.yaml.gotmpl'
|
||||||
helmfile_backup_extension = '.bak'
|
helmfile_backup_extension = '.bak'
|
||||||
@@ -44,7 +45,7 @@ rootLogger.addHandler(consoleHandler)
|
|||||||
|
|
||||||
logging.debug(f"Working with relative paths from script location: {script_path}")
|
logging.debug(f"Working with relative paths from script location: {script_path}")
|
||||||
logging.debug(f"Log directory: {log_path}")
|
logging.debug(f"Log directory: {log_path}")
|
||||||
logging.debug(f"charts.yaml : {charts_yaml}")
|
logging.debug(f"charts.yaml.gotmpl: {charts_yaml}")
|
||||||
|
|
||||||
|
|
||||||
def create_or_switch_branch_base_repo():
|
def create_or_switch_branch_base_repo():
|
||||||
@@ -68,40 +69,62 @@ def create_or_switch_branch_base_repo():
|
|||||||
base_repo.git.switch(branch)
|
base_repo.git.switch(branch)
|
||||||
return 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):
|
def clone_charts_locally(branch, charts):
|
||||||
charts_clone_path = script_path+'/../../'+branch.replace('/', '_')
|
charts_path = script_path+'/../../charts-'+branch.replace('/', '_')
|
||||||
charts_dict = {}
|
charts_dict = {}
|
||||||
doublette_dict = {}
|
doublette_dict = {}
|
||||||
if os.path.isdir(charts_clone_path):
|
create_path_if_not_exists(charts_path)
|
||||||
logging.warning(f"Path {charts_clone_path} already exists, will not clone any charts.")
|
|
||||||
else:
|
|
||||||
logging.debug(f"creating directory {charts_clone_path} to clone charts into")
|
|
||||||
Path(charts_clone_path).mkdir(parents=True, exist_ok=True)
|
|
||||||
|
|
||||||
for chart in charts['charts']:
|
for chart in charts['charts']:
|
||||||
if 'opendesk/components/platform-development/charts' in charts['charts'][chart]['repository']:
|
|
||||||
tag = charts['charts'][chart]['version']
|
tag = charts['charts'][chart]['version']
|
||||||
logging.debug(f"Working on {chart} / tag {tag}")
|
|
||||||
repository = charts['charts'][chart]['repository']
|
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}")
|
||||||
|
chart_local_path = charts_path+'/'+name
|
||||||
|
if not options.match in name:
|
||||||
|
logging.info(f"Chart name {name} does not match {options.match} - skipping...")
|
||||||
|
continue
|
||||||
|
elif registry == '':
|
||||||
|
logging.info("Empty registry definition - skipping...")
|
||||||
|
continue
|
||||||
|
if os.path.isdir(chart_local_path):
|
||||||
|
logging.debug(f"Found pre-existing {chart_local_path} skipping clone/pull, but will still reference chart in Helmfile...")
|
||||||
|
charts_dict[chart] = chart_local_path
|
||||||
|
git_url = options.git_hostname+':'+repository
|
||||||
|
doublette_dict[git_url] = chart_local_path
|
||||||
|
continue
|
||||||
|
elif 'opendesk/components/platform-development/charts' in repository:
|
||||||
|
logging.info("Cloning the charts repo")
|
||||||
git_url = options.git_hostname+':'+repository
|
git_url = options.git_hostname+':'+repository
|
||||||
chart_repo_path = charts_clone_path+'/'+charts['charts'][chart]['name']
|
|
||||||
if git_url in doublette_dict:
|
if git_url in doublette_dict:
|
||||||
logging.debug(f"{chart} located at {git_url} is already checked out to {doublette_dict[git_url]}")
|
logging.debug(f"{chart} located at {git_url} is already checked out to {doublette_dict[git_url]}")
|
||||||
charts_dict[chart] = doublette_dict[git_url]
|
charts_dict[chart] = doublette_dict[git_url]
|
||||||
else:
|
else:
|
||||||
if os.path.isdir(chart_repo_path):
|
logging.debug(f"Cloning into {chart_local_path}")
|
||||||
logging.debug(f"Already exists {chart_repo_path} leaving it unmodified")
|
Repo.clone_from(git_url, chart_local_path)
|
||||||
else:
|
chart_repo = Repo(path=chart_local_path)
|
||||||
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'])
|
chart_repo.git.checkout('v'+charts['charts'][chart]['version'])
|
||||||
doublette_dict[git_url] = chart_repo_path
|
doublette_dict[git_url] = chart_local_path
|
||||||
charts_dict[chart] = chart_repo_path
|
charts_dict[chart] = chart_local_path
|
||||||
|
else:
|
||||||
|
logging.info("Pulling the chart")
|
||||||
|
helm_command = f"helm pull oci://{registry}/{repository}/{name} --version {tag} --untar --destination {charts_path}"
|
||||||
|
logging.debug(f"CLI command: {helm_command}")
|
||||||
|
try:
|
||||||
|
subprocess.check_output(helm_command, shell = True)
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
sys.exit(f"! CLI command '{helm_command}' failed")
|
||||||
|
charts_dict[chart] = chart_local_path
|
||||||
return charts_dict
|
return charts_dict
|
||||||
|
|
||||||
|
|
||||||
def grep_yaml(file):
|
def grep_yaml(file):
|
||||||
with open(file, 'r') as file:
|
with open(file, 'r') as file:
|
||||||
content = ''
|
content = ''
|
||||||
@@ -131,7 +154,12 @@ def process_the_helmfiles(charts_dict, charts):
|
|||||||
for chart_ident in charts_dict:
|
for chart_ident in charts_dict:
|
||||||
if '.Values.charts.'+chart_ident+'.name' in line:
|
if '.Values.charts.'+chart_ident+'.name' in line:
|
||||||
logging.debug(f"found match with {chart_ident} in {line.strip()}")
|
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"
|
line = charts_dict[chart_ident]
|
||||||
|
if os.path.isdir(line+'/charts/'+charts['charts'][chart_ident]['name']):
|
||||||
|
line += '/charts/'+charts['charts'][chart_ident]['name']
|
||||||
|
elif not os.path.isdir(line):
|
||||||
|
sys.exit(f"! Did not find directory to reference in Helmfile: '{line}'")
|
||||||
|
line = chart_def_prefix+line+'" # replaced by local-dev script'+"\n"
|
||||||
child_helmfile_updated = True
|
child_helmfile_updated = True
|
||||||
break
|
break
|
||||||
output.append(line)
|
output.append(line)
|
||||||
|
|||||||
450
docs/architecture.md
Normal file
@@ -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.
|
||||||
941
docs/architecture/apis.md
Normal file
@@ -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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## UMC Python API
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
| 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
| 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
| 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
| 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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 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/ |
|
||||||
BIN
docs/architecture/apis_images/Files-api.png
Normal file
|
After Width: | Height: | Size: 69 KiB |
BIN
docs/architecture/apis_images/Groupware-api-http-usage.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/architecture/apis_images/Groupware-api-usage.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
docs/architecture/apis_images/Groupware-api.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/architecture/apis_images/IAM-ics-api-use.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
docs/architecture/apis_images/IAM-overview.png
Normal file
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/architecture/apis_images/IAM-ucr.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
docs/architecture/apis_images/IAM-udm.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/architecture/apis_images/IAM-umc-architecture.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
@@ -1,189 +0,0 @@
|
|||||||
<!--
|
|
||||||
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>Components</h1>
|
|
||||||
|
|
||||||
This section covers the internal system requirements and external service requirements for productive use.
|
|
||||||
|
|
||||||
<!-- TOC -->
|
|
||||||
* [Overview](#overview)
|
|
||||||
* [Component integration](#component-integration)
|
|
||||||
* [Intercom Service / Silent Login](#intercom-service--silent-login)
|
|
||||||
* [Filepicker](#filepicker)
|
|
||||||
* [Central Navigation](#central-navigation)
|
|
||||||
* [Central Contacts](#central-contacts)
|
|
||||||
* [File Store (OpenProject -\> Nextcloud)](#file-store-openproject---nextcloud)
|
|
||||||
* [Identity data flows](#identity-data-flows)
|
|
||||||
* [Provisioning](#provisioning)
|
|
||||||
<!-- TOC -->
|
|
||||||
|
|
||||||
# Overview
|
|
||||||
|
|
||||||
openDesk consists of a variety of open-source projects. Here is a list with the description and type.
|
|
||||||
|
|
||||||
Components of type `Eval` are used for development and evaluation purposes only,
|
|
||||||
they need to be replaced in production deployments.
|
|
||||||
|
|
||||||
| Component | Description | Type |
|
|
||||||
|-----------------------------|--------------------------------|------------|
|
|
||||||
| Certificates | TLS certificates | Eval |
|
|
||||||
| ClamAV (Distributed) | Antivirus engine | Eval |
|
|
||||||
| ClamAV (Simple) | Antivirus engine | Eval |
|
|
||||||
| Collabora | Weboffice | Functional |
|
|
||||||
| CryptPad | Weboffice | Functional |
|
|
||||||
| dkimpy-milter | DKIM milter for Postfix | Eval |
|
|
||||||
| Element | Secure communications platform | Functional |
|
|
||||||
| Jitsi | Videoconferencing | Functional |
|
|
||||||
| MariaDB | Database | Eval |
|
|
||||||
| Memcached | Cache Database | Eval |
|
|
||||||
| MinIO | Object Storage | Eval |
|
|
||||||
| Nextcloud | File share | Functional |
|
|
||||||
| Nubus (UMS) | Identity Management & Portal | Functional |
|
|
||||||
| OpenProject | Project management | Functional |
|
|
||||||
| OX Appsuite | Groupware | Functional |
|
|
||||||
| OX Dovecot | Mail backend (IMAP) | Functional |
|
|
||||||
| Postfix | MTA | Eval |
|
|
||||||
| PostgreSQL | Database | Eval |
|
|
||||||
| Redis | Cache Database | Eval |
|
|
||||||
| XWiki | Knowledge Management | Functional |
|
|
||||||
|
|
||||||
# Component integration
|
|
||||||
|
|
||||||
Some use cases require inter-component integration.
|
|
||||||
|
|
||||||
```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 Navigation|Portal
|
|
||||||
OX-AppSuite_Backend-->|Filepicker|Nextcloud
|
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
Most 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/UMS. 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).
|
|
||||||
|
|
||||||
## 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).
|
|
||||||
|
|
||||||
## 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>"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
## File Store (OpenProject -> Nextcloud)
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
# 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, except for Jitsi, which is using authentication with the
|
|
||||||
[Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) that does not
|
|
||||||
require an OIDC client to be 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
|
|
||||||
```
|
|
||||||
|
|
||||||
# Provisioning
|
|
||||||
|
|
||||||
Currently, active provisioning is only done for OX AppSuite. The OX-Connector synchronizes the following objects to the OX AppSuite using the AppSuite's SOAP API:
|
|
||||||
|
|
||||||
- Contexts
|
|
||||||
- Users
|
|
||||||
- Groups
|
|
||||||
- Functional Mailboxes
|
|
||||||
- Resources
|
|
||||||
117
docs/data-storage.md
Normal file
@@ -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` |
|
||||||
@@ -12,6 +12,7 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
* [Adding a container to a pod/deployment - Dev/Test only](#adding-a-container-to-a-poddeployment---devtest-only)
|
* [Adding a container to a pod/deployment - Dev/Test only](#adding-a-container-to-a-poddeployment---devtest-only)
|
||||||
* [Temporary/ephemeral containers](#temporaryephemeral-containers)
|
* [Temporary/ephemeral containers](#temporaryephemeral-containers)
|
||||||
* [Components](#components)
|
* [Components](#components)
|
||||||
|
* [Helmfile](#helmfile)
|
||||||
* [MariaDB](#mariadb)
|
* [MariaDB](#mariadb)
|
||||||
* [Nextcloud](#nextcloud)
|
* [Nextcloud](#nextcloud)
|
||||||
* [OpenProject](#openproject)
|
* [OpenProject](#openproject)
|
||||||
@@ -29,16 +30,16 @@ We for sure do not want to reinvent the wheel, so we might link to external sour
|
|||||||
information where available.
|
information where available.
|
||||||
|
|
||||||
> **Warning**<br>
|
> **Warning**<br>
|
||||||
> You should never enable the debug option in production environments! By looking up `debug.enable` in the deployment, you
|
> 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
|
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.
|
environments, you should use them thoughtfully and carefully if needed.
|
||||||
|
|
||||||
# Enable debugging
|
# Enable debugging
|
||||||
|
|
||||||
Check the openDesk [`debug.yaml`](../helmfile/environments/default/debug.yaml) and set for your deployment
|
Check the openDesk [`debug.yaml.gotmpl`](../helmfile/environments/default/debug.yaml.gotmpl) and set for your deployment
|
||||||
```
|
```
|
||||||
debug:
|
debug:
|
||||||
enable: true
|
enabled: true
|
||||||
```
|
```
|
||||||
|
|
||||||
This will result in:
|
This will result in:
|
||||||
@@ -142,6 +143,15 @@ kubectl -n ${NAMESPACE} attach -it -c ${EPH_CONTAINER_NAME} ${POD_NAME}
|
|||||||
|
|
||||||
# Components
|
# 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
|
## MariaDB
|
||||||
|
|
||||||
When using the openDesk bundled MariaDB, you can explore the database(s) using the MariaDB interactive terminal from the Pod's command line: `mariadb -u root -p`. On the password prompt, provide the value for `MARIADB_ROOT_PASSWORD` found in the Pod's environment.
|
When using the openDesk bundled MariaDB, you can explore the database(s) using the MariaDB interactive terminal from the Pod's command line: `mariadb -u root -p`. On the password prompt, provide the value for `MARIADB_ROOT_PASSWORD` found in the Pod's environment.
|
||||||
@@ -158,7 +168,7 @@ While you will find all the details for the CLI tool in [the online documentatio
|
|||||||
|
|
||||||
`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).
|
`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`
|
You can run occ commands in the `opendesk-nextcloud-aio` pod like this: `php /var/www/html/occ config:list`
|
||||||
|
|
||||||
## OpenProject
|
## OpenProject
|
||||||
|
|
||||||
@@ -201,3 +211,6 @@ kubectl patch -n ${NAMESPACE} configmap ${CONFIGMAP_NAME} --type merge -p '{"dat
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. Restart the Keycloak Pod(s).
|
2. Restart the Keycloak Pod(s).
|
||||||
|
|
||||||
|
> **Note**<br>
|
||||||
|
> 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.
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ However, contributions are possible using the [CLA](https://gitlab.opencode.de/b
|
|||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
* [Overview](#overview)
|
* [Overview](#overview)
|
||||||
* [Default branch, `develop` and other branches](#default-branch-develop-and-other-branches)
|
* [Default branch, `develop` and other branches](#default-branch-develop-and-other-branches)
|
||||||
* [External artifacts - `charts.yaml` and `images.yaml`](#external-artifacts---chartsyaml-and-imagesyaml)
|
* [External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`](#external-artifacts---chartsyamlgotmpl-and-imagesyamlgotmpl)
|
||||||
* [Linting](#linting)
|
* [Linting](#linting)
|
||||||
* [Disable linting selectively](#disable-linting-selectively)
|
* [Disable linting selectively](#disable-linting-selectively)
|
||||||
* [Renovate](#renovate)
|
* [Renovate](#renovate)
|
||||||
@@ -29,29 +29,29 @@ developing the openDesk platform.
|
|||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart TD
|
flowchart TD
|
||||||
J[helmfile.yaml\nor a helmfile outside of this repository]-->A
|
J[helmfile.yaml.gotmpl\nor a helmfile outside of this repository]-->A
|
||||||
J-->K[./helmfile/environemnts/*your_environment*/values.yaml.gotmpl\nor any an environment values file]
|
J-->K[./helmfile/environemnts/*your_environment*/values.yaml.gotmpl\nor any an environment values file]
|
||||||
A[./helmfile_generic.yaml]-->B[./helmfile/apps/*all_configured_apps*/helmfile.yaml\nReferences the relevant app Helm\ncharts using details from 'charts.yaml']
|
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`]
|
B-->C[./values-*all_configured_components*.yaml.gotmpl\nValues to template the charts\nwith references to the `images.yaml.gotmpl`]
|
||||||
A-->D[./helmfile/environments/default/*\nwith just some examples below]
|
A-->D[./helmfile/environments/default/*\nwith just some examples below]
|
||||||
D-->F[charts.yaml]
|
D-->F[charts.yaml.gotmpl]
|
||||||
D-->G[images.yaml]
|
D-->G[images.yaml.gotmpl]
|
||||||
D-->H[global.*]
|
D-->H[global.*]
|
||||||
D-->I[secrets.yaml\nreplicas.yaml\nresources.yaml\n...]
|
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]
|
A-->|overwrite defaults with your\ndeployment/environment specific values|E[./helmfile/environments/default/values.yaml.gotmpl]
|
||||||
```
|
```
|
||||||
|
|
||||||
The `helmfile.yaml` file in the root folder is the foundation
|
The `helmfile.yaml.gotmpl` file in the root folder is the foundation
|
||||||
for the entire deployment. It references the `helmfile_generic.yaml`
|
for the entire deployment. It references the `helmfile_generic.yaml.gotmpl`
|
||||||
file, which includes app-specific `helmfile.yaml` files and
|
file, which includes app-specific `helmfile.yaml.gotmpl` files and
|
||||||
global values files located in `./environments/default`.
|
global values files located in `./environments/default`.
|
||||||
|
|
||||||
`helmfile.yaml` also refers to three predefined environments: `dev`,
|
`helmfile.yaml.gotmpl` also refers to three predefined environments: `dev`,
|
||||||
`test`, and `prod`.
|
`test`, and `prod`.
|
||||||
|
|
||||||
The `helmfile_generic.yaml` file is designed to be referenced from
|
The `helmfile_generic.yaml.gotmpl` file is designed to be referenced from
|
||||||
external repositories, where custom environments may be defined. An
|
external repositories, where custom environments may be defined. An
|
||||||
example is demonstrated in the `helmfile.yaml` file.
|
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.
|
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.
|
||||||
|
|
||||||
@@ -68,9 +68,9 @@ Of course, the merge request will target the `develop` branch, be in status `dra
|
|||||||
|
|
||||||
If you do not plan to merge from the branch you have pushed, please close the auto-created MR.
|
If you do not plan to merge from the branch you have pushed, please close the auto-created MR.
|
||||||
|
|
||||||
# External artifacts - `charts.yaml` and `images.yaml`
|
# External artifacts - `charts.yaml.gotmpl` and `images.yaml.gotmpl`
|
||||||
|
|
||||||
The `charts.yaml` and `images.yaml` files are the central place to reference external artifacts used for the deployment.
|
The `charts.yaml.gotmpl` and `images.yaml.gotmpl` files are the central place to reference external artifacts used for the deployment.
|
||||||
|
|
||||||
Besides the deployment automation itself, some tools work with the contents of the files:
|
Besides the deployment automation itself, some tools work with the contents of the files:
|
||||||
|
|
||||||
@@ -142,7 +142,7 @@ The mirror script takes the information on what artifacts to mirror from the ann
|
|||||||
- `# upstreamRegistry` *required*: To identify the source registry
|
- `# upstreamRegistry` *required*: To identify the source registry
|
||||||
- `# upstreamRegistryCredentialId`: *optional*: In case the source registry is not public, the access credentials have to be specified as ENV variables containing the value of this key in their name, so you want to specify that key all uppercase:
|
- `# upstreamRegistryCredentialId`: *optional*: In case the source registry is not public, the access credentials have to be specified as 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>_USERNAME`
|
||||||
- `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_PASSWORT`
|
- `MIRROR_CREDENTIALS_SRC_<upstreamRegistryCredentialId>_PASSWORD`
|
||||||
- `# upstreamRepository` *required*: To identify the source repository
|
- `# upstreamRepository` *required*: To identify the source repository
|
||||||
- `# upstreamMirrorTagFilterRegEx` *required*: If this annotation is set, the mirror for the component will be activated. Only tags that match the given regular expression are being mirrored. **Note:** You must use single quotes for this attribute's value if you use backslash leading regex notation like `\d`.
|
- `# upstreamMirrorTagFilterRegEx` *required*: If this annotation is set, the mirror for the component will be activated. Only tags that match the given regular expression 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
|
- `# upstreamMirrorStartFrom` *optional*: Array of numeric values in case you want to mirror only artifacts beginning with a specific version. You must use capturing group
|
||||||
|
|||||||
@@ -13,4 +13,5 @@ The following enhanced configuration use cases are described in separate documen
|
|||||||
- [Federation with external identity provider](./enhanced-configuration/idp-federation.md)
|
- [Federation with external identity provider](./enhanced-configuration/idp-federation.md)
|
||||||
- [Matrix federation](./enhanced-configuration/matrix-federation.md)
|
- [Matrix federation](./enhanced-configuration/matrix-federation.md)
|
||||||
- [Groupware migration from M365 to openDesk](./enhanced-configuration/groupware-migration.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)
|
- [Self-signed certificate and custom Certificate Authority (CA)](./enhanced-configuration/self-signed-certificates.md)
|
||||||
|
- [GitOps deployments using Argo CD](./enhanced-configuration/gitops.md)
|
||||||
|
|||||||
60
docs/enhanced-configuration/gitops.md
Normal file
@@ -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.
|
||||||
@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
<h1>Migration from M365 with audriga migration service and master authentication</h1>
|
<h1>Migration from M365 with audriga migration service and master authentication</h1>
|
||||||
|
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
* [Context](#context)
|
|
||||||
* [Prerequisites](#prerequisites)
|
* [Prerequisites](#prerequisites)
|
||||||
* [Prepare M365 tenant for access](#prepare-m365-tenant-for-access)
|
* [Prepare M365 tenant for access](#prepare-m365-tenant-for-access)
|
||||||
* [Provisioning user accounts in openDesk](#provisioning-user-accounts-in-opendesk)
|
* [Provisioning user accounts in openDesk](#provisioning-user-accounts-in-opendesk)
|
||||||
@@ -75,18 +74,18 @@ With openDesk 1.0 Enterprise, you can set openDesk's email components (OX AppSui
|
|||||||
|
|
||||||
```
|
```
|
||||||
secrets:
|
secrets:
|
||||||
oxAppsuite:
|
oxAppSuite:
|
||||||
adminPassword: "your_temporary_master_password"
|
adminPassword: "your_temporary_master_password"
|
||||||
functional:
|
functional:
|
||||||
migration:
|
migration:
|
||||||
oxAppsuite:
|
oxAppSuite:
|
||||||
enabled: true
|
enabled: true
|
||||||
```
|
```
|
||||||
|
|
||||||
1. You must specify the master password referenced in the document's following sections.
|
1. You must specify the master password referenced in the document's following sections.
|
||||||
2. You need to enable the actual master authentication mode.
|
2. You need to enable the actual master authentication mode.
|
||||||
|
|
||||||
Updating your deployment with these settings will allow you to continue with the migration scenario. Once the migration is completed, you can remove `secrets.oxAppsuite.adminPassword` and need to turn off the migration mode by setting `functional.migration.oxAppsuite.enabled` to `false` or removing that setting, as `false` is the default before you update your deployment once again.
|
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>
|
> **Note**<br>
|
||||||
> For the changes to take effect, it is sufficient to deploy the `open-xchange` component.
|
> For the changes to take effect, it is sufficient to deploy the `open-xchange` component.
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
<h1>Federation with external identity provider (IdP)</h1>
|
<h1>Federation with external identity provider (IdP)</h1>
|
||||||
|
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
* [Context](#context)
|
* [References](#references)
|
||||||
* [Prerequisites](#prerequisites)
|
* [Prerequisites](#prerequisites)
|
||||||
* [User accounts](#user-accounts)
|
* [User accounts](#user-accounts)
|
||||||
* [External IdP with OIDC](#external-idp-with-oidc)
|
* [External IdP with OIDC](#external-idp-with-oidc)
|
||||||
@@ -24,6 +24,15 @@ Most organizations already have an Identity and Access Management (IAM) system w
|
|||||||
|
|
||||||
This document shows how to configure your organization's IdP and the openDesk IdP to support account federation with openDesk single sign-on based on your organization's login.
|
This document 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
|
# Prerequisites
|
||||||
|
|
||||||
## User accounts
|
## User accounts
|
||||||
@@ -143,10 +152,9 @@ The following configuration is taking place in the Keycloak realm `opendesk`.
|
|||||||
- *Client authentication*: `Client secret sent as post` (default)
|
- *Client authentication*: `Client secret sent as post` (default)
|
||||||
- *Client ID*: Use the client ID you took from your organization's IdP config (`opendesk-federation-client` in this example)
|
- *Client ID*: Use the client ID you took from your organization's IdP config (`opendesk-federation-client` in this example)
|
||||||
- *Client Secret*: Use the secret you took from your organization's IdP config
|
- *Client Secret*: Use the secret you took from your organization's IdP config
|
||||||
- When completed with *Add*, you get to the detailed IdP configured that also needs some updates (you may need to open the *Advanced* section to access some settings)
|
- When completed with *Add*, you get to the detailed IdP configuration that at least needs some the following update:
|
||||||
- *Back-channel logout*: `On`
|
|
||||||
- *Disable user info*: `On`
|
|
||||||
- *First login flow override*: `auto-federate-flow`
|
- *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):
|
- In case you want to forcefully redirect all users to your organization's IdP (disabling login with local openDesk accounts):
|
||||||
- *Authentication* > `2fa-browser`
|
- *Authentication* > `2fa-browser`
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ access openDesk.
|
|||||||
```
|
```
|
||||||
|
|
||||||
1. Create a Kubernetes secret named `opendesk-certificates-tls` of type `kubernetes.io/tls` containing either a valid
|
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)
|
wildcard certificate or a certificate with [all required subdomains](../../helmfile/environments/default/global.yaml.gotmpl)
|
||||||
set as SANs (Subject Alternative Name).
|
set as SANs (Subject Alternative Name).
|
||||||
|
|
||||||
1. Create a Kubernetes secret with name `opendesk-certificates-ca-tls` of type `kubernetes.io/tls` containing the custom
|
1. Create a Kubernetes secret with name `opendesk-certificates-ca-tls` of type `kubernetes.io/tls` containing the custom
|
||||||
@@ -98,6 +98,8 @@ multiple namespaces in a cluster.
|
|||||||
name: selfsigned-issuer
|
name: selfsigned-issuer
|
||||||
kind: ClusterIssuer
|
kind: ClusterIssuer
|
||||||
group: cert-manager.io
|
group: cert-manager.io
|
||||||
|
duration: 87600h # 10y
|
||||||
|
renewBefore: 87599h
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Copy this cert's secret into the/each namespace you want to make use of the cert.
|
1. Copy this cert's secret into the/each namespace you want to make use of the cert.
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ This document will cover the additional configuration for external services like
|
|||||||
* [Database](#database)
|
* [Database](#database)
|
||||||
* [Object storage](#object-storage)
|
* [Object storage](#object-storage)
|
||||||
* [Cache](#cache)
|
* [Cache](#cache)
|
||||||
|
* [Footnotes](#footnotes)
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
|
|
||||||
# Database
|
# Database
|
||||||
@@ -18,93 +19,150 @@ This document will cover the additional configuration for external services like
|
|||||||
When deploying this suite to production, you need to configure the applications to use your production-grade database
|
When deploying this suite to production, you need to configure the applications to use your production-grade database
|
||||||
service.
|
service.
|
||||||
|
|
||||||
| Component | Name | Type | Parameter | Key | Default |
|
> **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.
|
||||||
| Element | Synapse | PostgreSQL | | | |
|
|
||||||
| | | | Name | `databases.synapse.name` | `matrix` |
|
| Component | Name | Parameter | Key | Default |
|
||||||
| | | | Host | `databases.synapse.host` | `postgresql` |
|
| ------------------ | ------------------ | --------- | --------------------------------------------- | ---------------------------- |
|
||||||
| | | | Port | `databases.synapse.port` | `5432` |
|
| Element | Synapse | | | |
|
||||||
| | | | Username | `databases.synapse.username` | `matrix_user` |
|
| | | Type | `databases.synapse.type` | `postgresql` |
|
||||||
| | | | Password | `databases.synapse.password` | |
|
| | | Name | `databases.synapse.name` | `matrix` |
|
||||||
| Keycloak | Keycloak | PostgreSQL | | | |
|
| | | Host | `databases.synapse.host` | `postgresql` |
|
||||||
| | | | Name | `databases.keycloak.name` | `keycloak` |
|
| | | Port | `databases.synapse.port` | `5432` |
|
||||||
| | | | Host | `databases.keycloak.host` | `postgresql` |
|
| | | Username | `databases.synapse.username` | `matrix_user` |
|
||||||
| | | | Port | `databases.keycloak.port` | `5432` |
|
| | | Password | `databases.synapse.password` | |
|
||||||
| | | | Username | `databases.keycloak.username` | `keycloak_user` |
|
| Nubus | Guardian Mgmt API | | | |
|
||||||
| | | | Password | `databases.keycloak.password` | |
|
| | | Type | `databases.umsGuardianManagementApi.type` | `postgresql` |
|
||||||
| | Keycloak Extension | PostgreSQL | | | |
|
| | | Name | `databases.umsGuardianManagementApi.name` | `guardianmanagementapi` |
|
||||||
| | | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
|
| | | Host | `databases.umsGuardianManagementApi.host` | `postgresql` |
|
||||||
| | | | Host | `databases.keycloakExtension.host` | `postgresql` |
|
| | | Port | `databases.umsGuardianManagementApi.port` | `5432` |
|
||||||
| | | | Port | `databases.keycloakExtension.port` | `5432` |
|
| | | Username | `databases.umsGuardianManagementApi.username` | `guardianmanagementapi_user` |
|
||||||
| | | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
|
| | | Password | `databases.umsGuardianManagementApi.password` | |
|
||||||
| | | | Password | `databases.keycloakExtension.password` | |
|
| | Keycloak | | | |
|
||||||
| UMS | Notifications API | PostgreSQL | | | |
|
| | | Type | `databases.keycloak.type` | `postgresql` |
|
||||||
| | | | Name | `databases.umsNotificationsApi.name` | `notificationsapi` |
|
| | | Name | `databases.keycloak.name` | `keycloak` |
|
||||||
| | | | Host | `databases.umsNotificationsApi.host` | `postgresql` |
|
| | | Host | `databases.keycloak.host` | `postgresql` |
|
||||||
| | | | Port | `databases.umsNotificationsApi.port` | `5432` |
|
| | | Port | `databases.keycloak.port` | `5432` |
|
||||||
| | | | Username | `databases.umsNotificationsApi.username` | `notificationsapi_user` |
|
| | | Username | `databases.keycloak.username` | `keycloak_user` |
|
||||||
| | | | Password | `databases.umsNotificationsApi.password` | |
|
| | | Password | `databases.keycloak.password` | |
|
||||||
| | Self Service | PostgreSQL | | | |
|
| | Keycloak Extension | | | |
|
||||||
| | | | Name | `databases.umsSelfservice.name` | `selfservice` |
|
| | | Type | `databases.keycloakExtension.type` | `postgresql` |
|
||||||
| | | | Host | `databases.umsSelfservice.host` | `postgresql` |
|
| | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
|
||||||
| | | | Port | `databases.umsSelfservice.port` | `5432` |
|
| | | Host | `databases.keycloakExtension.host` | `postgresql` |
|
||||||
| | | | Username | `databases.umsSelfservice.username` | `selfservice_user` |
|
| | | Port | `databases.keycloakExtension.port` | `5432` |
|
||||||
| | | | Password | `databases.umsSelfservice.password` | |
|
| | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
|
||||||
| Nextcloud | Nextcloud | MariaDB | | | |
|
| | | Password | `databases.keycloakExtension.password` | |
|
||||||
| | | | Name | `databases.nextcloud.name` | `nextcloud` |
|
| | Notifications API | | | |
|
||||||
| | | | Host | `databases.nextcloud.host` | `mariadb` |
|
| | | Type | `databases.umsNotificationsApi.type` | `postgresql` |
|
||||||
| | | | Username | `databases.nextcloud.username` | `nextcloud_user` |
|
| | | Name | `databases.umsNotificationsApi.name` | `notificationsapi` |
|
||||||
| | | | Password | `databases.nextcloud.password` | |
|
| | | Host | `databases.umsNotificationsApi.host` | `postgresql` |
|
||||||
| OpenProject | OpenProject | PostgreSQL | | | |
|
| | | Port | `databases.umsNotificationsApi.port` | `5432` |
|
||||||
| | | | Name | `databases.openproject.name` | `openproject` |
|
| | | Username | `databases.umsNotificationsApi.username` | `notificationsapi_user` |
|
||||||
| | | | Host | `databases.openproject.host` | `postgresql` |
|
| | | Password | `databases.umsNotificationsApi.password` | |
|
||||||
| | | | Port | `databases.openproject.port` | `5432` |
|
| | Self Service | | | |
|
||||||
| | | | Username | `databases.openproject.username` | `openproject_user` |
|
| | | Type | `databases.umsSelfservice.type` | `postgresql` |
|
||||||
| | | | Password | `databases.openproject.password` | |
|
| | | Name | `databases.umsSelfservice.name` | `selfservice` |
|
||||||
| OX Appsuite | OX Appsuite | MariaDB | | | |
|
| | | Host | `databases.umsSelfservice.host` | `postgresql` |
|
||||||
| | | | Name | `databases.oxAppsuite.name` | `CONFIGDB` |
|
| | | Port | `databases.umsSelfservice.port` | `5432` |
|
||||||
| | | | Host | `databases.oxAppsuite.host` | `mariadb` |
|
| | | Username | `databases.umsSelfservice.username` | `selfservice_user` |
|
||||||
| | | | Username | `databases.oxAppsuite.username` | `root` |
|
| | | Password | `databases.umsSelfservice.password` | |
|
||||||
| | | | Password | `databases.oxAppsuite.password` | |
|
| Nextcloud | Nextcloud | | | |
|
||||||
| XWiki | XWiki | MariaDB | | | |
|
| | | Type | `databases.nextcloud.type` | `mariadb` |
|
||||||
| | | | Name | `databases.xwiki.name` | `xwiki` |
|
| | | Name | `databases.nextcloud.name` | `nextcloud` |
|
||||||
| | | | Host | `databases.xwiki.host` | `mariadb` |
|
| | | Host | `databases.nextcloud.host` | `mariadb` |
|
||||||
| | | | Username | `databases.xwiki.username` | `xwiki_user` |
|
| | | Port | `databases.nextcloud.port` | `3306` |
|
||||||
| | | | Password | `databases.xwiki.password` | |
|
| | | 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` | |
|
||||||
|
| OX Dovecot Pro[^3] | ACLs | | | |
|
||||||
|
| | | Type | `databases.dovecotACL.type` | `cassandra` |
|
||||||
|
| | | Name | `databases.dovecotACL.name` | `dovecot_acl` |
|
||||||
|
| | | Host | `databases.dovecotACL.host` | `cassandra` |
|
||||||
|
| | | Port | `databases.dovecotACL.port` | `9042` |
|
||||||
|
| | | Username | `databases.dovecotACL.username` | `dovecot_acl_user` |
|
||||||
|
| | | Password | `databases.dovecotACL.password` | |
|
||||||
|
| | Dictmap | | | |
|
||||||
|
| | | Type | `databases.dovecotDictmap.type` | `cassandra` |
|
||||||
|
| | | Name | `databases.dovecotDictmap.name` | `dovecot_dictmap` |
|
||||||
|
| | | Host | `databases.dovecotDictmap.host` | `cassandra` |
|
||||||
|
| | | Port | `databases.dovecotDictmap.port` | `9042` |
|
||||||
|
| | | Username | `databases.dovecotDictmap.username` | `dovecot_dictmap_user` |
|
||||||
|
| | | Password | `databases.dovecotDictmap.password` | |
|
||||||
|
| XWiki[^4] | 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
|
# Object storage
|
||||||
|
|
||||||
When deploying this suite to production, you need to configure the applications to use your production-grade object
|
When deploying this suite to production, you need to configure the applications to use your production-grade object
|
||||||
storage service.
|
storage service.
|
||||||
|
|
||||||
| Component | Name | Parameter | Key | Default |
|
| Component | Name | Parameter | Key | Default |
|
||||||
|-------------|-------------|-----------------|------------------------------------------|--------------------|
|
|-------------|-------------|-----------------|------------------------------------------|--------------------|
|
||||||
| OpenProject | OpenProject | | | |
|
| OpenProject | OpenProject | | | |
|
||||||
| | | Backend | `objectstores.openproject.backend` | `minio` |
|
| | | Backend | `objectstores.openproject.backend` | `minio` |
|
||||||
| | | Bucket | `objectstores.openproject.bucket` | `openproject` |
|
| | | Bucket | `objectstores.openproject.bucket` | `openproject` |
|
||||||
| | | Endpoint | `objectstores.openproject.endpoint` | |
|
| | | Endpoint | `objectstores.openproject.endpoint` | |
|
||||||
| | | Provider | `objectstores.openproject.provider` | `AWS` |
|
| | | Provider | `objectstores.openproject.provider` | `AWS` |
|
||||||
| | | Region | `objectstores.openproject.region` | |
|
| | | Region | `objectstores.openproject.region` | |
|
||||||
| | | Secret | `objectstores.openproject.secret` | |
|
| | | Secret | `objectstores.openproject.secret` | |
|
||||||
| | | Username | `objectstores.openproject.username` | `openproject_user` |
|
| | | Username | `objectstores.openproject.username` | `openproject_user` |
|
||||||
| | | Use IAM profile | `objectstores.openproject.useIAMProfile` | |
|
| | | Use IAM profile | `objectstores.openproject.useIAMProfile` | |
|
||||||
|
|
||||||
# Cache
|
# Cache
|
||||||
|
|
||||||
When deploying this suite to production, you need to configure the applications to use your production-grade cache
|
When deploying this suite to production, you need to configure the applications to use your production-grade cache
|
||||||
service.
|
service.
|
||||||
|
|
||||||
| Component | Name | Type | Parameter | Key | Default |
|
| Component | Name | Type | Parameter | Key | Default |
|
||||||
|------------------|------------------|-----------|-----------|------------------------------|------------------|
|
|------------------|------------------|-----------|-----------|------------------------------|------------------|
|
||||||
| Intercom Service | Intercom Service | Redis | | | |
|
| Intercom Service | Intercom Service | Redis | | | |
|
||||||
| | | | Host | `cache.intercomService.host` | `redis-headless` |
|
| | | | Host | `cache.intercomService.host` | `redis-headless` |
|
||||||
| | | | Port | `cache.intercomService.port` | `6379` |
|
| | | | Port | `cache.intercomService.port` | `6379` |
|
||||||
| Nextcloud | Nextcloud | Redis | | | |
|
| Nextcloud | Nextcloud | Redis | | | |
|
||||||
| | | | Host | `cache.nextcloud.host` | `redis-headless` |
|
| | | | Host | `cache.nextcloud.host` | `redis-headless` |
|
||||||
| | | | Port | `cache.nextcloud.port` | `6379` |
|
| | | | Port | `cache.nextcloud.port` | `6379` |
|
||||||
| OpenProject | OpenProject | Memcached | | | |
|
| OpenProject | OpenProject | Memcached | | | |
|
||||||
| | | | Host | `cache.openproject.host` | `memcached` |
|
| | | | Host | `cache.openproject.host` | `memcached` |
|
||||||
| | | | Port | `cache.openproject.port` | `11211` |
|
| | | | Port | `cache.openproject.port` | `11211` |
|
||||||
| UMS | Self Service | Memcached | | | |
|
| UMS | Self Service | Memcached | | | |
|
||||||
| | | | Host | `cache.umsSelfservice.host` | `memcached` |
|
| | | | Host | `cache.umsSelfservice.host` | `memcached` |
|
||||||
| | | | Port | `cache.umsSelfservice.port` | `11211` |
|
| | | | 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] openDesk Enterprise only.
|
||||||
|
|
||||||
|
[^4] XWiki requires root access when using MariaDB as sub-wikis are using separate databases that are managed by XWiki. When using PostgreSQL with XWiki no root user is required as the sub-wikis are managed within multiple schemes within a single database.
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ deploy openDesk onto your Kubernetes infrastructure.
|
|||||||
|
|
||||||
# Requirements
|
# Requirements
|
||||||
|
|
||||||
Detailed system requirements are covered on the [requirements](requirements.md) page.
|
Detailed system requirements are covered on the [requirements](./docs/requirements.md) page.
|
||||||
|
|
||||||
# Customize environment
|
# Customize environment
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ Before deploying openDesk, you must configure the deployment to fit your environ
|
|||||||
To keep your deployment up to date, we recommend customizing in `dev`, `test`, or `prod` and not in `default` environment
|
To keep your deployment up to date, we recommend customizing in `dev`, `test`, or `prod` and not in `default` environment
|
||||||
files.
|
files.
|
||||||
|
|
||||||
> All configuration options and their default values can be found in files at `helmfile/environments/default/`
|
> 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
|
For the following guide, we will use `dev` as environment where variables can be set in
|
||||||
`helmfile/environments/dev/values.yaml.gotmpl`.
|
`helmfile/environments/dev/values.yaml.gotmpl`.
|
||||||
@@ -78,15 +78,15 @@ All subdomains can be customized. For example, _Nextcloud_ can be changed to `fi
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
global:
|
global:
|
||||||
hosts:
|
hosts:
|
||||||
nextcloud: "files"
|
nextcloud: "files"
|
||||||
```
|
```
|
||||||
|
|
||||||
The domain has to be set either via `dev` environment
|
The domain has to be set either via `dev` environment
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
global:
|
global:
|
||||||
domain: "domain.tld"
|
domain: "domain.tld"
|
||||||
```
|
```
|
||||||
|
|
||||||
or via environment variable
|
or via environment variable
|
||||||
@@ -97,35 +97,38 @@ export DOMAIN=domain.tld
|
|||||||
|
|
||||||
### Apps
|
### Apps
|
||||||
|
|
||||||
All available apps and their default value are in `helmfile/environments/default/workplace.yaml`.
|
All available apps and their default value are in `helmfile/environments/default/opendesk_main.gotmpl`.
|
||||||
|
|
||||||
| Component | Name | Default | Description |
|
| Component | Name | Default | Description |
|
||||||
| -------------------- | --------------------------- | ------- | ------------------------------ |
|
| -------------------- | --------------------------- | ------- | ------------------------------ |
|
||||||
| Certificates | `certificates.enabled` | `true` | TLS certificates |
|
| Certificates | `apps.certificates.enabled` | `true` | TLS certificates |
|
||||||
| ClamAV (Distributed) | `clamavDistributed.enabled` | `false` | Antivirus engine |
|
| ClamAV (Distributed) | `apps.clamavDistributed.enabled` | `false` | Antivirus engine |
|
||||||
| ClamAV (Simple) | `clamavSimple.enabled` | `true` | Antivirus engine |
|
| ClamAV (Simple) | `apps.clamavSimple.enabled` | `true` | Antivirus engine |
|
||||||
| Collabora | `collabora.enabled` | `true` | Weboffice |
|
| Collabora | `apps.collabora.enabled` | `true` | Weboffice |
|
||||||
| CryptPad | `cryptpad.enabled` | `true` | Weboffice |
|
| CryptPad | `apps.cryptpad.enabled` | `true` | Weboffice |
|
||||||
| Dovecot | `dovecot.enabled` | `true` | Mail backend |
|
| dkimpy | `apps.dkimpy.enabled` | `false` | Postfix milter for DKIM |
|
||||||
| Element | `element.enabled` | `true` | Secure communications platform |
|
| Dovecot | `apps.dovecot.enabled` | `true` | Mail backend |
|
||||||
| Jitsi | `jitsi.enabled` | `true` | Videoconferencing |
|
| Element | `apps.element.enabled` | `true` | Secure communications platform |
|
||||||
| MariaDB | `mariadb.enabled` | `true` | Database |
|
| Home | `apps.home.enabled` | `true` | Base domain portal redirect |
|
||||||
| Memcached | `memcached.enabled` | `true` | Cache Database |
|
| Jitsi | `apps.jitsi.enabled` | `true` | Videoconferencing |
|
||||||
| MinIO | `minio.enabled` | `true` | Object Storage |
|
| MariaDB | `apps.mariadb.enabled` | `true` | Database |
|
||||||
| Nextcloud | `nextcloud.enabled` | `true` | File share |
|
| Memcached | `apps.memcached.enabled` | `true` | Cache Database |
|
||||||
| Nubus | `nubus.enabled` | `true` | Identity Management & Portal |
|
| MinIO | `apps.minio.enabled` | `true` | Object Storage |
|
||||||
| OpenProject | `openproject.enabled` | `true` | Project management |
|
| Nextcloud | `apps.nextcloud.enabled` | `true` | File share |
|
||||||
| OX Appsuite | `oxAppsuite.enabled` | `true` | Groupware |
|
| Nubus | `apps.nubus.enabled` | `true` | Identity Management & Portal |
|
||||||
| Postfix | `postfix.enabled` | `true` | MTA |
|
| OpenProject | `apps.openproject.enabled` | `true` | Project management |
|
||||||
| PostgreSQL | `postgresql.enabled` | `true` | Database |
|
| OX App Suite | `apps.oxAppSuite.enabled` | `true` | Groupware |
|
||||||
| Redis | `redis.enabled` | `true` | Cache Database |
|
| Postfix | `apps.postfix.enabled` | `true` | MTA |
|
||||||
| XWiki | `xwiki.enabled` | `true` | Knowledge management |
|
| PostgreSQL | `apps.postgresql.enabled` | `true` | Database |
|
||||||
|
| Redis | `apps.redis.enabled` | `true` | Cache Database |
|
||||||
|
| XWiki | `apps.xwiki.enabled` | `true` | Knowledge management |
|
||||||
|
|
||||||
Exemplary, Jitsi can be disabled like:
|
Exemplary, Jitsi can be disabled like:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
apps:
|
||||||
jitsi:
|
jitsi:
|
||||||
enabled: false
|
enabled: false
|
||||||
```
|
```
|
||||||
|
|
||||||
## Private registries
|
## Private registries
|
||||||
@@ -139,13 +142,13 @@ like Docker Hub.
|
|||||||
Doing a test deployment will be fine with this setup. In case you want to deploy multiple times a day
|
Doing a test deployment will be fine with this setup. In case you want to deploy multiple times a day
|
||||||
and fetch from the same IP address, you might run into rate limits at Docker Hub. In that case and in cases you
|
and fetch from the same IP address, you might run into rate limits at Docker Hub. In that case and in cases you
|
||||||
prefer the use of a private image registry, you can configure such for
|
prefer the use of a private image registry, you can configure such for
|
||||||
[your target environment](./../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting
|
[your target environment](../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting
|
||||||
- `global.imageRegistry` for a private image registry and
|
- `global.imageRegistry` for a private image registry and
|
||||||
- `global.helmRegistry` for a private Helm chart registry.
|
- `global.helmRegistry` for a private Helm chart registry.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
global:
|
global:
|
||||||
imageRegistry: "my_private_registry.domain.tld"
|
imageRegistry: "my_private_registry.domain.tld"
|
||||||
```
|
```
|
||||||
|
|
||||||
alternatively, you can use an environment variable:
|
alternatively, you can use an environment variable:
|
||||||
@@ -158,16 +161,16 @@ or control repository override fine-granular per registry:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
repositories:
|
repositories:
|
||||||
image:
|
image:
|
||||||
dockerHub: "my_private_registry.domain.tld/docker.io/"
|
dockerHub: "my_private_registry.domain.tld/docker.io/"
|
||||||
registryOpencodeDe: "my_private_registry.domain.tld/registry.opencode.de/"
|
registryOpencodeDe: "my_private_registry.domain.tld/registry.opencode.de/"
|
||||||
```
|
```
|
||||||
|
|
||||||
If authentication is required, you can reference `imagePullSecrets` as follows:
|
If authentication is required, you can reference `imagePullSecrets` as follows:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
global:
|
global:
|
||||||
imagePullSecrets:
|
imagePullSecrets:
|
||||||
- "external-registry"
|
- "external-registry"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -182,8 +185,8 @@ used:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
cluster:
|
cluster:
|
||||||
service:
|
service:
|
||||||
type: "NodePort"
|
type: "NodePort"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Networking
|
### Networking
|
||||||
@@ -192,16 +195,16 @@ If your cluster has not the default `cluster.local` domain configured, you need
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
cluster:
|
cluster:
|
||||||
networking:
|
networking:
|
||||||
domain: "acme.internal"
|
domain: "acme.internal"
|
||||||
```
|
```
|
||||||
|
|
||||||
If your cluster has not the default `10.0.0.0/8` CIDR configured, you need to provide the CIDR via the following:
|
If your cluster has not the default `10.0.0.0/8` CIDR configured, you need to provide the CIDR via the following:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
cluster:
|
cluster:
|
||||||
networking:
|
networking:
|
||||||
cidr:
|
cidr:
|
||||||
- "127.0.0.0/8"
|
- "127.0.0.0/8"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -210,8 +213,8 @@ explicitly configure the related IPs or IP ranges:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
cluster:
|
cluster:
|
||||||
networking:
|
networking:
|
||||||
incomingCIDR:
|
incomingCIDR:
|
||||||
- "172.16.0.0/12"
|
- "172.16.0.0/12"
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -219,11 +222,11 @@ cluster:
|
|||||||
|
|
||||||
By default, the `ingressClassName` is empty to select your default ingress controller. You may want to customize it by
|
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
|
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.
|
[requirements.md](requirements.md)) for reference) within your deployment if that is not the cluster's default ingress.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
ingress:
|
ingress:
|
||||||
ingressClassName: "name-of-my-nginx-ingress"
|
ingressClassName: "name-of-my-nginx-ingress"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Container runtime
|
### Container runtime
|
||||||
@@ -233,30 +236,32 @@ Some apps require specific configurations for the container runtime. You can set
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
cluster:
|
cluster:
|
||||||
container:
|
container:
|
||||||
engine: "containerd"
|
engine: "containerd"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Volumes
|
### Volumes
|
||||||
|
The **StorageClass** must be set by:
|
||||||
When your cluster has a `ReadWriteMany` volume provisioner, you can benefit from the distribution or scaling of apps. By
|
|
||||||
default, only `ReadWriteOnce` is enabled. To enable `ReadWriteMany` you can set:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
cluster:
|
|
||||||
persistence:
|
|
||||||
readWriteMany: true
|
|
||||||
```
|
|
||||||
|
|
||||||
The **StorageClass** can be set by:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
persistence:
|
persistence:
|
||||||
storageClassNames:
|
storageClassNames:
|
||||||
RWX: "my-read-write-many-class"
|
RWX: "my-read-write-many-class"
|
||||||
RWO: "my-read-write-once-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
|
## Connectivity
|
||||||
|
|
||||||
### Ports
|
### Ports
|
||||||
@@ -267,22 +272,22 @@ persistence:
|
|||||||
|
|
||||||
To use the openDesk functionality with its web-based user interface, you need to expose the following ports publicly:
|
To use the openDesk functionality with its web-based user interface, you need to expose the following ports publicly:
|
||||||
|
|
||||||
| Component | Description | Port | Type |
|
| Component | Description | Port | Type |
|
||||||
| ------------------ | ----------------------- | ----: | ---: |
|
| ------------------ | ----------------------- | ----: | ---: |
|
||||||
| openDesk | Kubernetes Ingress | 80 | TCP |
|
| openDesk | Kubernetes Ingress | 80 | TCP |
|
||||||
| openDesk | Kubernetes Ingress | 443 | TCP |
|
| openDesk | Kubernetes Ingress | 443 | TCP |
|
||||||
| Jitsi Video Bridge | ICE Port for video data | 10000 | UDP |
|
| Jitsi Video Bridge | ICE Port for video data | 10000 | UDP |
|
||||||
|
|
||||||
#### Mail clients
|
#### Mail clients
|
||||||
|
|
||||||
To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need public exposure:
|
To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need public exposure:
|
||||||
|
|
||||||
| Component | Description | Port | Type |
|
| Component | Description | Port | Type |
|
||||||
| ------------------ | ----------------------- | ----: | ---: |
|
| ------------------ | ----------------------- | ----: | ---: |
|
||||||
| Dovecot | IMAPS | 993 | TCP |
|
| Dovecot | IMAPS | 993 | TCP |
|
||||||
| | POP3S | 995 | TCP |
|
| | POP3S | 995 | TCP |
|
||||||
| Postfix | SMTP | 25 | TCP |
|
| Postfix | SMTP | 25 | TCP |
|
||||||
| | SMTPS | 587 | TCP |
|
| | SMTPS | 587 | TCP |
|
||||||
|
|
||||||
### Mail/SMTP configuration
|
### Mail/SMTP configuration
|
||||||
|
|
||||||
@@ -291,22 +296,24 @@ the whole subdomain.
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
smtp:
|
smtp:
|
||||||
host: "mail.open.desk"
|
host: "mail.open.desk"
|
||||||
username: "openDesk"
|
username: "openDesk"
|
||||||
password: "secret"
|
password: "secret"
|
||||||
```
|
```
|
||||||
|
|
||||||
Enabling DKIM signing of emails helps to reduce spam and increases trust.
|
Enabling DKIM signing of emails helps to reduce spam and increases trust.
|
||||||
openDesk ships dkimpy-milter as Postfix milter for signing emails.
|
openDesk ships dkimpy-milter as Postfix milter for signing emails.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
apps:
|
||||||
dkimpy:
|
dkimpy:
|
||||||
enable: true
|
enabled: true
|
||||||
dkim:
|
smtp:
|
||||||
key:
|
dkim:
|
||||||
value: "HzZs08QF1O7UiAkcM9T3U7rePPECtSFvWZIvyKqdg8E="
|
key:
|
||||||
selector: "default"
|
value: "HzZs08QF1O7UiAkcM9T3U7rePPECtSFvWZIvyKqdg8E="
|
||||||
useED25519: true # when false, RSA is used
|
selector: "default"
|
||||||
|
useED25519: true # when false, RSA is used
|
||||||
```
|
```
|
||||||
|
|
||||||
### TURN configuration
|
### TURN configuration
|
||||||
@@ -316,14 +323,14 @@ these options:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
turn:
|
turn:
|
||||||
transport: "udp" # or tcp
|
transport: "udp" # or tcp
|
||||||
credentials: "secret"
|
credentials: "secret"
|
||||||
server:
|
server:
|
||||||
host: "turn.open.desk"
|
host: "turn.open.desk"
|
||||||
port: "3478"
|
port: "3478"
|
||||||
tls:
|
tls:
|
||||||
host: "turns.open.desk"
|
host: "turns.open.desk"
|
||||||
port: "5349"
|
port: "5349"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Certificate issuer
|
### Certificate issuer
|
||||||
@@ -333,8 +340,9 @@ secret named `opendesk-certificates-tls` must be present in the application name
|
|||||||
turn off `Certificate` resource creation by:
|
turn off `Certificate` resource creation by:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
apps:
|
||||||
certificates:
|
certificates:
|
||||||
enabled: false
|
enabled: false
|
||||||
```
|
```
|
||||||
|
|
||||||
If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the
|
If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the
|
||||||
@@ -342,15 +350,15 @@ configured cluster issuer:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
certificate:
|
certificate:
|
||||||
issuerRef:
|
issuerRef:
|
||||||
name: "letsencrypt-prod"
|
name: "letsencrypt-prod"
|
||||||
```
|
```
|
||||||
|
|
||||||
Additionally, it is possible to request wildcard certificates by:
|
Additionally, it is possible to request wildcard certificates by:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
certificate:
|
certificate:
|
||||||
wildcard: true
|
wildcard: true
|
||||||
```
|
```
|
||||||
|
|
||||||
## Password seed
|
## Password seed
|
||||||
@@ -415,22 +423,38 @@ If you change the subdomain of `nubus`, you must replace `portal` with the speci
|
|||||||
openDesk deploys with the standard user account `Administrator`, which password you get retrieved as follows:
|
openDesk deploys with the standard user account `Administrator`, which password you get retrieved as follows:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Replace with your namespace
|
# Set your namespace
|
||||||
NAMESPACE=your-namespace
|
NAMESPACE=<your_namespace>
|
||||||
|
|
||||||
# Get password for IAM "Administrator" account
|
# Get password for IAM "Administrator" account
|
||||||
kubectl -n ${NAMESPACE} get secret ums-nubus-credentials -o jsonpath='{.data.administrator_password}' | base64 -d
|
kubectl -n ${NAMESPACE} get secret ums-nubus-credentials -o jsonpath='{.data.administrator_password}' | base64 -d
|
||||||
```
|
```
|
||||||
|
|
||||||
In openDesk Community Edition, you get two more default accounts:
|
Using the aforementioned account, you can either create new accounts manually or make use of the
|
||||||
- `default.admin`: `kubectl -n ${NAMESPACE} get secret ums-nubus-credentials -o jsonpath='{.data.admin_password}' | base64 -d`
|
[openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import/)
|
||||||
- `default.user`: `kubectl -n ${NAMESPACE} get secret ums-nubus-credentials -o jsonpath='{.data.user_password}' | base64 -d`
|
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
|
## Using from external repository
|
||||||
|
|
||||||
Referring to `./helmfile_generic.yaml` from an external
|
Referring to `./helmfile_generic.yaml.gotmpl` from an external
|
||||||
directory or repository is possible. The `helmfile.yaml` that refers to
|
directory or repository is possible. The `helmfile.yaml.gotmpl` that refers to
|
||||||
`./helmfile_generic.yaml` may define custom environments. These custom
|
`./helmfile_generic.yaml.gotmpl` may define custom environments. These custom
|
||||||
environments may overwrite specific configuration values. These
|
environments may overwrite specific configuration values. These
|
||||||
configuration values are:
|
configuration values are:
|
||||||
|
|
||||||
@@ -456,12 +480,13 @@ NAMESPACE=your-namespace
|
|||||||
|
|
||||||
# Uninstall all Helm charts
|
# Uninstall all Helm charts
|
||||||
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
||||||
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
||||||
done
|
done
|
||||||
|
|
||||||
# Delete leftover resources
|
# Delete leftover resources
|
||||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||||
|
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Warning**<br>
|
> **Warning**<br>
|
||||||
|
|||||||
@@ -7,61 +7,365 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
|
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
* [Disclaimer](#disclaimer)
|
* [Disclaimer](#disclaimer)
|
||||||
* [openDesk supported upgrade path](#opendesk-supported-upgrade-path)
|
* [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path)
|
||||||
* [Releases upgrade details](#releases-upgrade-details)
|
* [Manual checks/actions](#manual-checksactions)
|
||||||
|
* [From v1.1.1](#from-v111)
|
||||||
|
* [Pre-upgrade from v1.1.1](#pre-upgrade-from-v111)
|
||||||
|
* [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element)
|
||||||
|
* [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)
|
* [From v0.9.0](#from-v090)
|
||||||
* [Pre-upgrade: Manual steps](#pre-upgrade-manual-steps)
|
* [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: Removal of unnecessary OX-Profiles in Nubus](#configuration-cleanup-removal-of-unnecessary-ox-profiles-in-nubus)
|
||||||
* [Configuration Cleanup: Updated `global.imagePullSecrets`](#configuration-cleanup-updated-globalimagepullsecrets)
|
* [Configuration Cleanup: Updated `global.imagePullSecrets`](#configuration-cleanup-updated-globalimagepullsecrets)
|
||||||
|
* [Changed openDesk defaults: Matrix presence status disabled](#changed-opendesk-defaults-matrix-presence-status-disabled)
|
||||||
* [Changed openDesk defaults: Matrix ID](#changed-opendesk-defaults-matrix-id)
|
* [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: File-share configurability](#changed-opendesk-defaults-file-share-configurability)
|
||||||
* [Changed openDesk defaults: Updated default subdomains in `global.hosts`](#changed-opendesk-defaults-updated-default-subdomains-in-globalhosts)
|
* [Changed openDesk defaults: Updated default subdomains in `global.hosts`](#changed-opendesk-defaults-updated-default-subdomains-in-globalhosts)
|
||||||
* [Changed openDesk defaults: Dedicated group for access to the UDM REST API](#changed-opendesk-defaults-dedicated-group-for-access-to-the-udm-rest-api)
|
* [Changed openDesk defaults: Dedicated group for access to the UDM REST API](#changed-opendesk-defaults-dedicated-group-for-access-to-the-udm-rest-api)
|
||||||
* [Automated migrations](#automated-migrations)
|
* [Post-upgrade from v0.9.0](#post-upgrade-from-v090)
|
||||||
* [Post-upgrade: Manual steps](#post-upgrade-manual-steps)
|
|
||||||
* [Configuration Improvement: Separate user permission for using Video Conference component](#configuration-improvement-separate-user-permission-for-using-video-conference-component)
|
* [Configuration Improvement: Separate user permission for using Video Conference component](#configuration-improvement-separate-user-permission-for-using-video-conference-component)
|
||||||
* [Optional Cleanup](#optional-cleanup)
|
* [Optional Cleanup](#optional-cleanup)
|
||||||
* [From v0.8.1](#from-v081)
|
* [From v0.8.1](#from-v081)
|
||||||
|
* [Pre-upgrade from v0.8.1](#pre-upgrade-from-v081)
|
||||||
* [Updated `cluster.networking.cidr`](#updated-clusternetworkingcidr)
|
* [Updated `cluster.networking.cidr`](#updated-clusternetworkingcidr)
|
||||||
* [Updated customizable template attributes](#updated-customizable-template-attributes)
|
* [Updated customizable template attributes](#updated-customizable-template-attributes)
|
||||||
* [`migrations` S3 bucket](#migrations-s3-bucket)
|
* [`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)
|
* [Related components and artifacts](#related-components-and-artifacts)
|
||||||
* [Development](#development)
|
* [Development](#development)
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
|
|
||||||
# Disclaimer
|
# Disclaimer
|
||||||
|
|
||||||
With openDesk 1.0, we aim to offer hassle-free updates/upgrades.
|
Starting with openDesk 1.0, we aim to offer hassle-free updates/upgrades.
|
||||||
|
|
||||||
But openDesk requires a defined upgrade path that is described in the section [openDesk supported upgrade path](#opendesk-supported-upgrade-path).
|
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).
|
||||||
|
|
||||||
Some upgrades even require manual interaction, which are referenced in the aforementioned section and described further down this document.
|
Manual checks and possible activities are also required by openDesk updates, they are described in the section [Manual update steps](#manual-update-steps).
|
||||||
|
|
||||||
> **Known limitations:**<br>
|
> **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.
|
> 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.
|
||||||
|
|
||||||
# openDesk supported upgrade path
|
# Automated migrations - Overview and mandatory upgrade path
|
||||||
|
|
||||||
When updating your openDesk installation you have to install the releases listed below in the sequential order from
|
The following table gives an overview of the mandatory upgrade path of openDesk for the automated migrations to work as expected.
|
||||||
the lowest version number you are already on to the more current version you are looking to install.
|
|
||||||
|
|
||||||
Explanation of the table's columns:
|
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.
|
||||||
- *Coming from*: Check the column for the release you are currently on.
|
|
||||||
- *Mandatory release*: Defines which release(s) support the upgrade from your currently installed version.
|
|
||||||
- *Automatic migration*: Summary of, or link to openDesk's automatic migration details.
|
|
||||||
- *Manual activities*: Reference to required manual steps to upgrade your openDesk installation to the *Mandatory release*.
|
|
||||||
|
|
||||||
| Coming from | Mandatory (minimum) release | Automatic migration | Manual activities |
|
| Mandatory version |
|
||||||
| ------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
| ----------------- |
|
||||||
| v0.9.0 | v1.x.x | [run_2.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_2.py) | See [From v0.9.0](#from-v090) |
|
| v1.1.x |
|
||||||
| v0.8.1 | v0.9.0 | Initializes migration system | See [From v0.8.1](#from-v081) |
|
| v1.0.0 |
|
||||||
| not supported | v0.8.1 | First release that supporting updates | |
|
| v0.9.0 |
|
||||||
|
| v0.8.1 |
|
||||||
|
|
||||||
# Releases upgrade details
|
> **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.1
|
||||||
|
|
||||||
|
### Pre-upgrade from v1.1.1
|
||||||
|
|
||||||
|
#### Helmfile feature update: App settings wrapped in `apps.` element
|
||||||
|
|
||||||
|
We require now [Helmfile v1.0.0-rc.8](https://github.com/helmfile/helmfile/releases/tag/v1.0.0-rc.8) for the deployment. This enables openDesk to lay the foundation for some significant cleanups where the information for the different apps especially on their `enabled` state is needed.
|
||||||
|
|
||||||
|
Therefore it was required to introduce the `apps` level in [`opendesk_main.yaml.gotmpl`](../helmfile/environments/default/opendesk_main.yaml.gotmpl).
|
||||||
|
|
||||||
|
If you have a deployment where you specify settings that can be found in the aforementioned file, usually to disable components or enable others, please ensure you insert the top-level attribute `apps` like shown in the following example:
|
||||||
|
|
||||||
|
So a setting of:
|
||||||
|
|
||||||
|
```
|
||||||
|
certificates:
|
||||||
|
enabled: false
|
||||||
|
notes:
|
||||||
|
enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
needs to be changed to:
|
||||||
|
|
||||||
|
```
|
||||||
|
apps:
|
||||||
|
certificates:
|
||||||
|
enabled: false
|
||||||
|
notes:
|
||||||
|
enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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
|
## From v0.9.0
|
||||||
|
|
||||||
### Pre-upgrade: Manual steps
|
### Pre-upgrade from v0.9.0
|
||||||
|
|
||||||
#### Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus
|
#### Configuration Cleanup: Removal of unnecessary OX-Profiles in Nubus
|
||||||
|
|
||||||
@@ -103,6 +407,19 @@ global:
|
|||||||
- "external-registry"
|
- "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
|
#### Changed openDesk defaults: Matrix ID
|
||||||
|
|
||||||
Until 0.9.0 openDesk used the LDAP entryUUID of a user to generate the user's Matrix ID. Due to restrictions on the
|
Until 0.9.0 openDesk used the LDAP entryUUID of a user to generate the user's Matrix ID. Due to restrictions on the
|
||||||
@@ -232,15 +549,7 @@ The IAMs admin account `Administrator` is a member of this group by default, but
|
|||||||
|
|
||||||
If you need other accounts to use the API, please assign them to the aforementioned group.
|
If you need other accounts to use the API, please assign them to the aforementioned group.
|
||||||
|
|
||||||
### Automated migrations
|
### Post-upgrade from v0.9.0
|
||||||
|
|
||||||
The `migrations-pre` and `migrations-post` jobs in the openDesk deployment address the automated migration tasks.
|
|
||||||
|
|
||||||
The permissions required to execute the migrations can be found in the migration's Helm chart [`role.yaml'](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/v1.3.5/charts/opendesk-migrations/templates/role.yaml?ref_type=tags#L29)
|
|
||||||
|
|
||||||
The actual actions are described as code comments in the related run module [`run_2.py](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/-/blob/main/odmigs-python/odmigs_runs/run_2.py).
|
|
||||||
|
|
||||||
### Post-upgrade: Manual steps
|
|
||||||
|
|
||||||
#### Configuration Improvement: Separate user permission for using Video Conference component
|
#### Configuration Improvement: Separate user permission for using Video Conference component
|
||||||
|
|
||||||
@@ -272,12 +581,14 @@ kubectl -n ${NAMESPACE} delete pvc ox-connector-ox-contexts-ox-connector-0
|
|||||||
|
|
||||||
## From v0.8.1
|
## From v0.8.1
|
||||||
|
|
||||||
### Updated `cluster.networking.cidr`
|
### 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.
|
- 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)
|
- Reference:[cluster.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/cluster.yaml)
|
||||||
|
|
||||||
### Updated customizable template attributes
|
#### Updated customizable template attributes
|
||||||
|
|
||||||
- Action: Please update your custom deployment values according to the updated default value structure.
|
- Action: Please update your custom deployment values according to the updated default value structure.
|
||||||
- References:
|
- References:
|
||||||
@@ -286,12 +597,34 @@ kubectl -n ${NAMESPACE} delete pvc ox-connector-ox-contexts-ox-connector-0
|
|||||||
- `monitoring.` prefix for `prometheus.*` and `graphana.*`, see [monitoring.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/monitoring.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).
|
- `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
|
#### `migrations` S3 bucket
|
||||||
|
|
||||||
- Action: For self-managed/external S3/object storages, please ensure you add a bucket `migrations` to your S3.
|
- 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)
|
- Reference: `objectstores.migrations` in [objectstores.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/objectstores.yaml)
|
||||||
|
|
||||||
# Related components and artifacts
|
# 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:
|
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:
|
||||||
|
|
||||||
@@ -306,8 +639,11 @@ The status of the upgrade migrations is tracked in the ConfigMap `migrations-sta
|
|||||||
|
|
||||||
When a new upgrade migration is required, ensure to address the following list:
|
When a new upgrade migration is required, ensure to address the following list:
|
||||||
|
|
||||||
- Update the generated release version file [`global.generated.yaml`](../helmfile/environments/default/global.generated.yaml) 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.
|
- 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 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 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).
|
- 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`](../helmfile/environments/default/charts.yaml) and [`images.yaml`](../helmfile/environments/default/images.yaml) to reflect the newer releases of the `opendesk-migrations` Helm chart and container image.
|
- 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.
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ repository or Prometheus operator.
|
|||||||
# Defaults
|
# Defaults
|
||||||
|
|
||||||
All configurable options and their defaults can be found in
|
All configurable options and their defaults can be found in
|
||||||
[`monitoring.yaml`](../helmfile/environments/default/monitoring.yaml).
|
[`monitoring.yaml.gotmpl`](../helmfile/environments/default/monitoring.yaml.gotmpl).
|
||||||
|
|
||||||
# Metrics
|
# Metrics
|
||||||
|
|
||||||
@@ -46,7 +46,10 @@ prometheus:
|
|||||||
|
|
||||||
# Alerts
|
# Alerts
|
||||||
|
|
||||||
Some Helm charts provide a default set of prometheusRules for alerting; enable it by:
|
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
|
```yaml
|
||||||
prometheus:
|
prometheus:
|
||||||
|
|||||||
202
docs/permissions.md
Normal file
@@ -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.
|
||||||
@@ -16,6 +16,7 @@ This section covers the internal system requirements and external service requir
|
|||||||
* [Certificate management](#certificate-management)
|
* [Certificate management](#certificate-management)
|
||||||
* [External services](#external-services)
|
* [External services](#external-services)
|
||||||
* [Deployment](#deployment)
|
* [Deployment](#deployment)
|
||||||
|
* [Footnotes](#footnotes)
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
|
|
||||||
# tl;dr
|
# tl;dr
|
||||||
@@ -24,12 +25,14 @@ openDesk is a Kubernetes-only solution and requires an existing Kubernetes (K8s)
|
|||||||
|
|
||||||
- K8s cluster >= 1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/)
|
- K8s cluster >= 1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/)
|
||||||
- Domain and DNS Service
|
- Domain and DNS Service
|
||||||
- Ingress controller (Ingress NGINX)
|
- Ingress controller (Ingress NGINX) == [4.11.x/1.11.x](https://github.com/kubernetes/ingress-nginx/releases) - tested with 1.11.1 up to 1.11.4
|
||||||
|
- **Note**: We are working on support for more recent versions, as issues have been reported with 1.12.x.
|
||||||
- [Helm](https://helm.sh/) >= v3.9.0
|
- [Helm](https://helm.sh/) >= v3.9.0
|
||||||
- [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v1.0.0-rc5**
|
- [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v1.0.0-rc8**
|
||||||
- [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0
|
- [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0
|
||||||
- Volume provisioner supporting RWO (read-write-once)
|
- Volume provisioner supporting RWO (read-write-once)
|
||||||
- Certificate handling with [cert-manager](https://cert-manager.io/)
|
- Certificate handling with [cert-manager](https://cert-manager.io/)
|
||||||
|
- [OpenKruise](https://openkruise.io/)[^1] >= 1.6
|
||||||
|
|
||||||
# Hardware
|
# Hardware
|
||||||
|
|
||||||
@@ -48,7 +51,8 @@ Any self-hosted or managed K8s cluster >= 1.24 listed in
|
|||||||
|
|
||||||
The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/kubespray) based clusters.
|
The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/kubespray) based clusters.
|
||||||
|
|
||||||
> **Note:** The deployment is not tested against OpenShift.
|
> **Note**<br>
|
||||||
|
> The deployment is not tested against OpenShift.
|
||||||
|
|
||||||
# Ingress controller
|
# Ingress controller
|
||||||
|
|
||||||
@@ -83,19 +87,20 @@ For the development and evaluation of openDesk, we bundle some services. Be awar
|
|||||||
deployments, you need to make use of your own production-grade services; see the
|
deployments, you need to make use of your own production-grade services; see the
|
||||||
[external-services.md](./external-services.md) for configuration details.
|
[external-services.md](./external-services.md) for configuration details.
|
||||||
|
|
||||||
| Group | Type | Version | Tested against |
|
| Group | Type | Version | Tested against |
|
||||||
| -------- | ------------------- | ------- | --------------------- |
|
| -------- | ------------------- | ------- | --------------------- |
|
||||||
| Cache | Memcached | `1.6.x` | Memcached |
|
| Cache | Memcached | `1.6.x` | Memcached |
|
||||||
| | Redis | `7.x.x` | Redis |
|
| | Redis | `7.x.x` | Redis |
|
||||||
| Database | MariaDB | `10.x` | MariaDB |
|
| Database | Cassandra[^1] | `5.0.x` | Cassandra |
|
||||||
| | PostgreSQL | `15.x` | PostgreSQL |
|
| | MariaDB | `10.x` | MariaDB |
|
||||||
| Mail | Mail Transfer Agent | | Postfix |
|
| | PostgreSQL | `15.x` | PostgreSQL |
|
||||||
| | PKI/CI (S/MIME) | | |
|
| Mail | Mail Transfer Agent | | Postfix |
|
||||||
| Security | AntiVirus/ICAP | | ClamAV |
|
| | PKI/CI (S/MIME) | | |
|
||||||
| Storage | K8s ReadWriteOnce | | Ceph / Cloud specific |
|
| Security | AntiVirus/ICAP | | ClamAV |
|
||||||
| | K8s ReadWriteMany | | Ceph / NFS |
|
| Storage | K8s ReadWriteOnce | | Ceph / Cloud specific |
|
||||||
| | Object Storage | | MinIO |
|
| | K8s ReadWriteMany | | Ceph / NFS |
|
||||||
| Voice | TURN | | Coturn |
|
| | Object Storage | | MinIO |
|
||||||
|
| Voice | TURN | | Coturn |
|
||||||
|
|
||||||
# Deployment
|
# Deployment
|
||||||
|
|
||||||
@@ -103,3 +108,7 @@ The deployment of each component is [Helm](https://helm.sh/) based. The 35+ Helm
|
|||||||
templated via [Helmfile](https://helmfile.readthedocs.io/en/latest/) to provide a streamlined deployment experience.
|
templated via [Helmfile](https://helmfile.readthedocs.io/en/latest/) to provide a streamlined deployment experience.
|
||||||
|
|
||||||
Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare the desired against the deployed state.
|
Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare the desired against the deployed state.
|
||||||
|
|
||||||
|
# Footnotes
|
||||||
|
|
||||||
|
[^1]: Required for Dovecot Pro as part of openDesk Enterprise Edition.
|
||||||
|
|||||||
@@ -10,13 +10,13 @@ This document covers the ability to scale applications.
|
|||||||
# Horizontal scalability
|
# Horizontal scalability
|
||||||
|
|
||||||
We are working on generating this document automatically based on the file
|
We are working on generating this document automatically based on the file
|
||||||
[`replicas.yaml`](../helmfile/environments/default/replicas.yaml) that contains necessary annotations.
|
[`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.
|
In the meantime, this file can be used to check the components scaling support/capabilities.
|
||||||
|
|
||||||
# Upstream information
|
# Upstream information
|
||||||
|
|
||||||
While scaling services horizontally is the ideal solution, information about vertical scaling is helpful
|
While scaling services horizontally is the ideal solution, information about vertical scaling is helpful
|
||||||
when defining the application's resources, see [`resources.yaml`](../helmfile/environments/default/resources.yaml) for references.
|
when defining the application's resources, see [`resources.yaml.gotmpl`](../helmfile/environments/default/resources.yaml.gotmpl) for references.
|
||||||
|
|
||||||
Please find below links to the application's upstream resources about scaling:
|
Please find below links to the application's upstream resources about scaling:
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
<!--
|
<!--
|
||||||
SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
SPDX-License-Identifier: Apache-2.0
|
SPDX-License-Identifier: Apache-2.0
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<h1>Kubernetes Security Context</h1>
|
<h1>Kubernetes Security Context</h1>
|
||||||
|
|
||||||
<!-- TOC -->
|
<!-- TOC -->
|
||||||
@@ -63,7 +62,7 @@ containerSecurityContext:
|
|||||||
## privileged
|
## privileged
|
||||||
|
|
||||||
|
|
||||||
Privileged Pods disable most security mechanisms and must be disallowed.
|
Privileged Pods eliminate most security mechanisms and must be disallowed.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
@@ -93,7 +92,7 @@ containerSecurityContext:
|
|||||||
## seccompProfile
|
## 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.
|
The seccompProfile must be explicitly set to one of the allowed values. An unconfined profile and the complete absence of the profile are prohibited.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
@@ -113,7 +112,7 @@ containerSecurityContext:
|
|||||||
## readOnlyRootFilesystem
|
## readOnlyRootFilesystem
|
||||||
|
|
||||||
|
|
||||||
Containers should have an immutable file systems, so that attackers could not modify application code or download malicious code.
|
Containers should have an immutable file systems, so that attackers can not modify application code or download malicious code.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
@@ -133,10 +132,10 @@ containerSecurityContext:
|
|||||||
# Status quo
|
# Status quo
|
||||||
|
|
||||||
|
|
||||||
openDesk aims to achieve that all security relevant settings are explicitly templated and comply with security recommendations.
|
openDesk aims to ensure 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.
|
The rendered manifests are also validated against Kyverno [policies](/.kyverno/policies) in CI to ensure that the provided values inside openDesk are properly templated by the Helm charts.
|
||||||
|
|
||||||
|
|
||||||
This list gives you an overview of templated security settings and if they comply with security standards:
|
This list gives you an overview of templated security settings and if they comply with security standards:
|
||||||
@@ -144,11 +143,11 @@ This list gives you an overview of templated security settings and if they compl
|
|||||||
|
|
||||||
- **yes**: Value is set to `true`
|
- **yes**: Value is set to `true`
|
||||||
- **no**: Value is set to `false`
|
- **no**: Value is set to `false`
|
||||||
- **n/a**: No explicitly templated in openDesk and default is used.
|
- **n/a**: Not explicitly templated in openDesk; default is used.
|
||||||
|
|
||||||
| process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities |
|
| process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities |
|
||||||
| ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ |
|
| ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ |
|
||||||
| **collabora**/collabora-online | :x: | yes | no | no | yes | 100 | 101 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT","MKNOD"] |
|
| **collabora**/collabora-online | :x: | yes | no | no | yes | 100 | 101 | yes | no ["CHOWN","FOWNER","SYS_CHROOT"] |
|
||||||
| **cryptpad**/cryptpad | :x: | no | no | no | yes | 4001 | 4001 | yes | yes |
|
| **cryptpad**/cryptpad | :x: | no | no | no | yes | 4001 | 4001 | yes | yes |
|
||||||
| **element**/matrix-neoboard-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
| **element**/matrix-neoboard-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||||
| **element**/matrix-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
| **element**/matrix-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||||
@@ -164,14 +163,41 @@ This list gives you an overview of templated security settings and if they compl
|
|||||||
| **jitsi**/jitsi | :white_check_mark: | no | no | yes | yes | 1993 | 1993 | 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/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/jicofo | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||||
|
| **jitsi**/jitsi/jitsi/jigasi | :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/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/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/jitsi/web | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||||
| **jitsi**/jitsi/patchJVB | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
| **jitsi**/jitsi/patchJVB | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
| **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 65532 | 65532 | yes | yes |
|
| **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 101 | 101 | yes | yes |
|
||||||
| **nextcloud**/opendesk-nextcloud/apache2 | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
| **nextcloud**/opendesk-nextcloud/aio | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||||
| **nextcloud**/opendesk-nextcloud/exporter | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
| **nextcloud**/opendesk-nextcloud/exporter | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
||||||
| **nextcloud**/opendesk-nextcloud/php | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
| **notes**/impress/backend | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
|
| **notes**/impress/frontend | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
|
| **notes**/impress/yProvider | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
|
| **nubus**/intercom-service | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/intercom-service/provisioning | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
|
||||||
|
| **nubus**/opendesk-keycloak-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/keycloak | :x: | no | n/a | no | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusGuardian/authorizationApi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusGuardian/managementApi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusGuardian/managementUi | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusGuardian/openPolicyAgent | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusKeycloakBootstrap | :x: | no | n/a | no | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusKeycloakExtensions/handler | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
|
||||||
|
| **nubus**/ums/nubusKeycloakExtensions/proxy | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
|
||||||
|
| **nubus**/ums/nubusLdapNotifier | :x: | no | n/a | yes | yes | 101 | 102 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusNotificationsApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusPortalConsumer | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
|
||||||
|
| **nubus**/ums/nubusPortalFrontend | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusPortalServer | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusProvisioning | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusProvisioning/nats | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusSelfServiceConsumer | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusStackDataUms | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusUdmListener | :x: | no | n/a | yes | yes | 102 | 65534 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusUdmRestApi | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusUmcGateway | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **nubus**/ums/nubusUmcServer | :x: | no | n/a | yes | no | 0 | 0 | yes | yes |
|
||||||
| **open-xchange**/dovecot | :x: | no | n/a | yes | n/a | n/a | n/a | yes | no ["CHOWN","DAC_OVERRIDE","KILL","NET_BIND_SERVICE","SETGID","SETUID","SYS_CHROOT"] |
|
| **open-xchange**/dovecot | :x: | no | n/a | yes | n/a | n/a | n/a | yes | no ["CHOWN","DAC_OVERRIDE","KILL","NET_BIND_SERVICE","SETGID","SETUID","SYS_CHROOT"] |
|
||||||
| **open-xchange**/open-xchange/appsuite/core-documentconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
|
| **open-xchange**/open-xchange/appsuite/core-documentconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
|
||||||
| **open-xchange**/open-xchange/appsuite/core-guidedtours | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
| **open-xchange**/open-xchange/appsuite/core-guidedtours | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
@@ -183,34 +209,26 @@ This list gives you an overview of templated security settings and if they compl
|
|||||||
| **open-xchange**/open-xchange/appsuite/guard-ui | :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/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 |
|
| **open-xchange**/open-xchange/public-sector-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **open-xchange**/opendesk-open-xchange-bootstrap | :x: | no | n/a | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **opendesk-migrations-post**/opendesk-migrations-post | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **opendesk-migrations-pre**/opendesk-migrations-pre | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **opendesk-openproject-bootstrap**/opendesk-openproject-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||||
|
| **opendesk-services**/opendesk-static-files | :x: | no | n/a | yes | yes | 101 | 101 | yes | yes |
|
||||||
| **openproject**/openproject | :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 |
|
| **services-external**/cassandra | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | 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-external**/clamav | :x: | no | no | yes | no | 0 | 0 | yes | no |
|
||||||
| **services**/clamav | :x: | no | no | yes | no | 0 | 0 | yes | no |
|
| **services-external**/clamav-simple | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||||
| **services**/clamav-simple | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
| **services-external**/clamav/clamd | :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-external**/clamav/freshclam | :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-external**/clamav/icap | :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-external**/clamav/milter | :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-external**/mariadb | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
| **services**/mariadb | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
| **services-external**/memcached | :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-external**/minio | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||||
| **services**/minio | :x: | no | no | no | yes | 1000 | 0 | yes | yes |
|
| **services-external**/opendesk-dkimpy-milter | :x: | yes | no | yes | yes | 1000 | 1000 | yes | no |
|
||||||
| **services**/postfix | :x: | yes | yes | no | no | 0 | 0 | yes | no |
|
| **services-external**/postfix | :x: | yes | yes | no | no | 0 | 0 | yes | no |
|
||||||
| **services**/postgresql | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
| **services-external**/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 |
|
| **services-external**/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 |
|
| **xwiki**/xwiki | :x: | no | no | no | yes | 100 | 101 | yes | yes |
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
141
docs/testing.md
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1>Testing</h1>
|
||||||
|
|
||||||
|
<!-- TOC -->
|
||||||
|
* [Overview](#overview)
|
||||||
|
* [Test concept](#test-concept)
|
||||||
|
* [Rely on upstream applications QA](#rely-on-upstream-applications-qa)
|
||||||
|
* [Run minimal functional QA (end-to-end tests)](#run-minimal-functional-qa-end-to-end-tests)
|
||||||
|
* [Run extensive load- and performance tests](#run-extensive-load--and-performance-tests)
|
||||||
|
* [Base performance testing](#base-performance-testing)
|
||||||
|
* [Load testing to saturation point](#load-testing-to-saturation-point)
|
||||||
|
* [Load testing up to a defined user count](#load-testing-up-to-a-defined-user-count)
|
||||||
|
* [Overload/recovery tests](#overloadrecovery-tests)
|
||||||
|
* [Reporting and test results](#reporting-and-test-results)
|
||||||
|
* [Allure TestOps](#allure-testops)
|
||||||
|
<!-- TOC -->
|
||||||
|
|
||||||
|
# Overview
|
||||||
|
|
||||||
|
The following section provides an overview of the testing approach adopted to ensure the quality and reliability of openDesk. This concept balances leveraging existing quality assurance (QA) processes with targeted testing efforts tailored to the specific needs of openDesk. The outlined strategy focuses on three key areas:
|
||||||
|
|
||||||
|
1. Relying on application QA: Utilizing the existing QA processes of the applications to ensure baseline functionality and quality standards.
|
||||||
|
2. Minimal functional QA: Executing end-to-end tests to validate critical workflows and ensure that key functionalities operate as expected.
|
||||||
|
3. Extensive load and performance testing: Conducting comprehensive load and performance tests to assess openDesk's scalability and response under varying usage conditions.
|
||||||
|
|
||||||
|
These efforts are designed to complement each other, minimizing redundancy while ensuring robust testing coverage.
|
||||||
|
|
||||||
|
# Test concept
|
||||||
|
|
||||||
|
## Rely on upstream applications QA
|
||||||
|
|
||||||
|
openDesk contains applications from different suppliers, as a general approach, we rely on the testing
|
||||||
|
conducted by these suppliers for their respective applications.
|
||||||
|
|
||||||
|
We review the supplier's QA measures on a regular basis, to ensure a reliable and sufficient QA of the underlying applications.
|
||||||
|
|
||||||
|
We receive the release notes early before a new application release is integrated into openDesk, so
|
||||||
|
we are able to check the existence of a sufficient set of test scases.
|
||||||
|
The suppliers create a set of test cases for each new functionality.
|
||||||
|
|
||||||
|
## Run minimal functional QA (end-to-end tests)
|
||||||
|
|
||||||
|
To ensure the functioning of all applications, we run a minimal set of testcases to check the
|
||||||
|
basic functionality of openDesk and all integrated applications.
|
||||||
|
|
||||||
|
Furthermore, we analyze all features/usecases which are implemented by a set of more than one
|
||||||
|
applications.
|
||||||
|
All these features are not testable naturally by the suppliers, so we develop testcases
|
||||||
|
for such features.
|
||||||
|
|
||||||
|
The openDesk application owners prioritize then this list of end-to-end-testcases, and we
|
||||||
|
implement these testcases in the [test automation framework](https://gitlab.opencode.de/bmi/opendesk/deployment/e2e-tests).
|
||||||
|
|
||||||
|
## Run extensive load- and performance tests
|
||||||
|
|
||||||
|
We want to deliver openDesk as an application-grade software with the ability to serve a large user base.
|
||||||
|
|
||||||
|
We create and perform extensive load- and performance tests for every release of openDesk.
|
||||||
|
|
||||||
|
Our approach consists of different layers of load testing.
|
||||||
|
|
||||||
|
### Base performance testing
|
||||||
|
|
||||||
|
For these tests we define a set of "normal", not too complicated user-interactions with openDesk.
|
||||||
|
|
||||||
|
For each testcase in this set, we measure the duration of the whole testcase (and steps inside the
|
||||||
|
testcase) on a given, unloaded environment, installed with a predefined setup and openDesk release.
|
||||||
|
|
||||||
|
As a result, we receive the total runtime of one iteration of the given testcase, the runtime of each
|
||||||
|
step inside the testcase, the error rate and min/max/median runtimes.
|
||||||
|
|
||||||
|
Most importantly, the environment should not be used by other users or background tasks, so it should
|
||||||
|
be an environment being mostly in idle state.
|
||||||
|
|
||||||
|
The results can be compared with the results of the previous release, so we can see if changes
|
||||||
|
in software components improve or decrease the performance of a testcase.
|
||||||
|
|
||||||
|
### Load testing to saturation point
|
||||||
|
|
||||||
|
These tests are performed to ensure the correct processing and user interactions even in
|
||||||
|
high-load scenarios.
|
||||||
|
|
||||||
|
We use the same test cases as in the base performance tests.
|
||||||
|
|
||||||
|
Now we measure the duration on a well-defined environment while the system is being used
|
||||||
|
by a predefined number of test users in parallel. This number will be scaled up.
|
||||||
|
|
||||||
|
Our goal is to see constant runtimes of each testcase iteration, while the total throughput
|
||||||
|
of requests increases consistently with the number of users in parallel usage of the system.
|
||||||
|
|
||||||
|
At a distinct point, a further increase of the number of users leads to no more increase of the
|
||||||
|
total throughput, but instead leads to an increase in the runtime of each testcase iteration.
|
||||||
|
|
||||||
|
This point, the saturation point, is the load limit of the environment. Up to this point the
|
||||||
|
environment and the installed software packages can handle the load. More load over this point
|
||||||
|
leads to increased response times and increased error rates.
|
||||||
|
|
||||||
|
### Load testing up to a defined user count
|
||||||
|
|
||||||
|
For interested partners, that are looking into large scale openDesk deployments,
|
||||||
|
we offer a load testing analysis based on defined scenarios to be discussed together with the partner in a workshop.
|
||||||
|
|
||||||
|
This way, we can help to decide on the appropriate sizing for the planned openDesk usage scenario.
|
||||||
|
|
||||||
|
### Overload/recovery tests
|
||||||
|
|
||||||
|
If necessary, we perform overload tests, which will saturate the system with multiple
|
||||||
|
test cases until no further increase in throughput is visible. Then we add even more load
|
||||||
|
until the first HTTP requests run into timeouts or errors.
|
||||||
|
After a few minutes, we reduce the load below the saturation point.
|
||||||
|
Now we can check if the system is able to recover from the overload status.
|
||||||
|
|
||||||
|
# Reporting and test results
|
||||||
|
|
||||||
|
We perform testruns every night on every of our environments.
|
||||||
|
|
||||||
|
For each environment, we define so called profiles, these contains the features enabled
|
||||||
|
per environment.
|
||||||
|
|
||||||
|
For example: Testing the email features in an environment without deployment of Open-Xchange makes no sense at all.
|
||||||
|
|
||||||
|
Also we test the whole system via a browser with `language=DE` and another browser with `language=EN`.
|
||||||
|
|
||||||
|
The test results will be saved in an [Allure TestOps](https://qameta.io/) server, so interested persons
|
||||||
|
are able to view the test results in detail.
|
||||||
|
|
||||||
|
## Allure TestOps
|
||||||
|
|
||||||
|
The Allure TestOps [server](https://testops.opendesk.run/) is currently only accessible to project members.
|
||||||
|
|
||||||
|
The relevant project is called *opendesk*.
|
||||||
|
|
||||||
|
To get an overview, click in the left symbol list onto the symbol "Rocket" to
|
||||||
|
check all relevant launches.
|
||||||
|
|
||||||
|
Now you can, e.g., see the launch #1733, and directly check for the success
|
||||||
|
of this launch.
|
||||||
@@ -143,13 +143,16 @@ As a standard, the openDesk platform development team uses [reuse.software](http
|
|||||||
|
|
||||||
openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this:
|
openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this:
|
||||||
```
|
```
|
||||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
# SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
```
|
```
|
||||||
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace).
|
The way to mark the license header as a comment differs between the various file types. Please find matching examples for all types across the [deployment automation repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace).
|
||||||
|
|
||||||
> **Note**<br>
|
> **Note**<br>
|
||||||
> If an `SPDX-FileCopyrightText` already exists, do not replace but add an additional line based on the above example.
|
> If a `SPDX-FileCopyrightText` already exists with the copyright owner described above but with an past year (e.g. 2024), please update this copyright header line to cover (up to and including) the current year, e.g. `2024-2025`.
|
||||||
|
|
||||||
|
> **Note**<br>
|
||||||
|
> If line(s) with `SPDX-FileCopyrightText` containing a different copyright owner exist in the file you are working on, do not replace existing one(s) but add an additional header above these.
|
||||||
|
|
||||||
## Development workflow
|
## Development workflow
|
||||||
|
|
||||||
@@ -235,7 +238,7 @@ The Standard Quality Gate addresses quality assurance steps that should be execu
|
|||||||
1. Linting
|
1. Linting
|
||||||
- Blocking
|
- Blocking
|
||||||
- Licensing: [reuse](https://github.com/fsfe/reuse-tool)
|
- Licensing: [reuse](https://github.com/fsfe/reuse-tool)
|
||||||
- openDesk specific: Especially `images.yaml` and `charts.yaml`, find more details in [development.md](./development.md).
|
- openDesk specific: Especially `images.yaml.gotmpl` and `charts.yaml.gotmpl`, find more details in [development.md](./development.md).
|
||||||
- Non-Blocking
|
- Non-Blocking
|
||||||
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
|
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
|
||||||
- Formal: Yaml
|
- Formal: Yaml
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ helmfiles:
|
|||||||
#
|
#
|
||||||
# Use this format from a remote repository
|
# Use this format from a remote repository
|
||||||
#
|
#
|
||||||
# - path: "git::https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git@helmfile_generic.yaml?ref=v0.7.1"
|
# - path: "git::https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git@helmfile_generic.yaml.gotmpl?ref=v0.7.1"
|
||||||
# values:
|
# values:
|
||||||
# - {{ toYaml .Values | nindent 8 }}
|
# - {{ toYaml .Values | nindent 8 }}
|
||||||
# */}}
|
# */}}
|
||||||
|
|||||||
@@ -10,7 +10,17 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.collabora.registry }}/{{ .Values.charts.collabora.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .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: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .Values.global.helmRegistry | default .Values.charts.collaboraController.registry }}/{{ .Values.charts.collaboraController.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "collabora-online"
|
- name: "collabora-online"
|
||||||
@@ -18,10 +28,26 @@ releases:
|
|||||||
version: "{{ .Values.charts.collabora.version }}"
|
version: "{{ .Values.charts.collabora.version }}"
|
||||||
values:
|
values:
|
||||||
- "values.yaml.gotmpl"
|
- "values.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.collaboraOnline | default "additionalValues: false" }}
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
installed: {{ .Values.collabora.enabled }}
|
- "values-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.collaboraOnline }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.collabora.enabled }}
|
||||||
|
- name: "collabora-controller"
|
||||||
|
chart: "collabora-controller-repo/{{ .Values.charts.collaboraController.name }}"
|
||||||
|
version: "{{ .Values.charts.collaboraController.version }}"
|
||||||
|
values:
|
||||||
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
- "values-coco-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.collaboraController }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.collaboraController.enabled }}
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "collabora"
|
component: "collabora"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
63
helmfile/apps/collabora/values-coco-enterprise.yaml.gotmpl
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
controller:
|
||||||
|
enableHashmapParallelization: true
|
||||||
|
ingressUrl: "https://{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||||
|
namespacedRole: true
|
||||||
|
# CoolController uses `app.kubernetes.io/name` label to find deployment resource
|
||||||
|
# openDesk uses `fullnameOverride` in Collabora Deployment that updates `metadata.name` not the `app.kubernetes.io/name`
|
||||||
|
# Therefore we use the default of `collabora-online` for the `resourceName`
|
||||||
|
resourceName: "collabora-online"
|
||||||
|
statsInterval: 2000
|
||||||
|
watchNamespace: {{ (.Values.apps.collabora.namespace | default .Release.Namespace | quote) }}
|
||||||
|
|
||||||
|
documentMigrator:
|
||||||
|
enabled: true
|
||||||
|
coolMemoryUtilization: {{ .Values.enterpriseFeatures.collabora.autoscaling.targetMemoryUtilizationPercentage }}
|
||||||
|
coolMemoryLimit: {{ .Values.resources.collabora.limits.memory }}
|
||||||
|
|
||||||
|
leaderElection:
|
||||||
|
enabled: {{ if gt .Values.replicas.collaboraController 1 }}true{{ else }}false{{ end }}
|
||||||
|
|
||||||
|
image:
|
||||||
|
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collaboraController.registry }}/{{ .Values.images.collaboraController.repository }}"
|
||||||
|
tag: {{ .Values.images.collaboraController.tag | quote }}
|
||||||
|
imagePullSecrets:
|
||||||
|
{{- range .Values.global.imagePullSecrets }}
|
||||||
|
- name: {{ . | quote }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName | quote }}
|
||||||
|
hosts:
|
||||||
|
- host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||||
|
paths:
|
||||||
|
- path: "/controller"
|
||||||
|
pathType: "Prefix"
|
||||||
|
|
||||||
|
podAnnotations: {}
|
||||||
|
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities:
|
||||||
|
drop:
|
||||||
|
- ALL
|
||||||
|
privileged: false
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
runAsNonRoot: true
|
||||||
|
runAsGroup: 2000
|
||||||
|
runAsUser: 1000
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
seLinuxOptions:
|
||||||
|
|
||||||
|
replicaCount: {{ .Values.replicas.collaboraController }}
|
||||||
|
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.collaboraController | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
...
|
||||||
15
helmfile/apps/collabora/values-enterprise.yaml.gotmpl
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
image:
|
||||||
|
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"
|
||||||
|
autoscaling:
|
||||||
|
enabled: {{ .Values.apps.collaboraController.enabled }}
|
||||||
|
minReplicas: {{ .Values.enterpriseFeatures.collabora.autoscaling.minReplicas }}
|
||||||
|
maxReplicas: {{ .Values.enterpriseFeatures.collabora.autoscaling.maxReplicas }}
|
||||||
|
targetMemoryUtilizationPercentage: {{ .Values.enterpriseFeatures.collabora.autoscaling.targetMemoryUtilizationPercentage }}
|
||||||
|
targetCPUUtilizationPercentage: {{ .Values.enterpriseFeatures.collabora.autoscaling.targetCPUUtilizationPercentage }}
|
||||||
|
scaleDownDisabled: {{ .Values.enterpriseFeatures.collabora.autoscaling.scaleDownDisabled }}
|
||||||
|
...
|
||||||
@@ -8,28 +8,35 @@ autoscaling:
|
|||||||
enabled: false
|
enabled: false
|
||||||
|
|
||||||
collabora:
|
collabora:
|
||||||
|
aliasgroups:
|
||||||
|
- host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
|
||||||
|
env:
|
||||||
|
- name: "POD_NAME"
|
||||||
|
valueFrom:
|
||||||
|
fieldRef:
|
||||||
|
fieldPath: "metadata.name"
|
||||||
extra_params: >
|
extra_params: >
|
||||||
--o:ssl.enable=false
|
--o:ssl.enable=false
|
||||||
--o:ssl.termination=true
|
--o:ssl.termination=true
|
||||||
--o:fetch_update_check=0
|
--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:remote_font_config.url=https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/apps/richdocuments/settings/fonts.json
|
||||||
--o:net.proto={{ if eq .Values.cluster.networking.ipFamilies "DualStack" }}all{{ else }}{{ .Values.cluster.networking.ipFamilies }}{{ end }}
|
--o:net.proto={{ if eq .Values.cluster.networking.ipFamilies "DualStack" }}all{{ else }}{{ .Values.cluster.networking.ipFamilies }}{{ end }}
|
||||||
|
{{- if .Values.debug.enabled }}
|
||||||
|
--o:logging.level=debug
|
||||||
|
{{- else }}
|
||||||
|
--o:logging.anonymize.anonymize_user_data=true
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.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"
|
username: "collabora-internal-admin"
|
||||||
password: {{ .Values.secrets.collabora.adminPassword | quote }}
|
password: {{ .Values.secrets.collabora.adminPassword | quote }}
|
||||||
aliasgroups:
|
|
||||||
- host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
|
|
||||||
|
|
||||||
fullnameOverride: "collabora"
|
fullnameOverride: "collabora"
|
||||||
|
|
||||||
grafana:
|
|
||||||
dashboards:
|
|
||||||
enabled: {{ .Values.monitoring.grafana.dashboards.enabled }}
|
|
||||||
labels:
|
|
||||||
{{ .Values.monitoring.grafana.dashboards.labels | toYaml | nindent 6 }}
|
|
||||||
annotations:
|
|
||||||
{{ .Values.monitoring.grafana.dashboards.annotations | toYaml | nindent 6 }}
|
|
||||||
|
|
||||||
image:
|
image:
|
||||||
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"
|
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"
|
||||||
tag: {{ .Values.images.collabora.tag | quote }}
|
tag: {{ .Values.images.collabora.tag | quote }}
|
||||||
@@ -42,8 +49,11 @@ imagePullSecrets:
|
|||||||
|
|
||||||
ingress:
|
ingress:
|
||||||
annotations:
|
annotations:
|
||||||
# Ingress NGINX
|
{{- if .Values.apps.collaboraController.enabled }}
|
||||||
|
nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_RouteToken"
|
||||||
|
{{- else }}
|
||||||
nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_WOPISrc"
|
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-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
|
||||||
nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.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/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}"
|
||||||
@@ -52,32 +62,6 @@ ingress:
|
|||||||
location /cool/getMetrics { deny all; return 403; }
|
location /cool/getMetrics { deny all; return 403; }
|
||||||
location /cool/adminws/ { deny all; return 403; }
|
location /cool/adminws/ { deny all; return 403; }
|
||||||
location /browser/dist/admin/admin.html { deny all; return 403; }
|
location /browser/dist/admin/admin.html { deny all; return 403; }
|
||||||
# NGINX
|
|
||||||
nginx.org/websocket-services: "collabora"
|
|
||||||
nginx.org/lb-method: "hash $arg_WOPISrc consistent"
|
|
||||||
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
|
||||||
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
|
||||||
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
|
|
||||||
nginx.org/server-snippets: |
|
|
||||||
# block admin and metrics endpoint from outside by default
|
|
||||||
location /cool/getMetrics { deny all; return 403; }
|
|
||||||
location /cool/adminws/ { deny all; return 403; }
|
|
||||||
location /browser/dist/admin/admin.html { deny all; return 403; }
|
|
||||||
# HAProxy
|
|
||||||
haproxy.org/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
|
||||||
haproxy.org/backend-config-snippet: |
|
|
||||||
balance url_param WOPISrc check_post
|
|
||||||
hash-type consistent
|
|
||||||
# HAProxy - Community: https://haproxy-ingress.github.io/
|
|
||||||
haproxy-ingress.github.io/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
|
||||||
haproxy-ingress.github.io/balance-algorithm: "url_param WOPISrc check_post"
|
|
||||||
haproxy-ingress.github.io/config-backend: |
|
|
||||||
hash-type consistent
|
|
||||||
# block admin urls from outside
|
|
||||||
acl admin_url path_beg /cool/getMetrics
|
|
||||||
acl admin_url path_beg /cool/adminws/
|
|
||||||
acl admin_url path_beg /browser/dist/admin/admin.html
|
|
||||||
http-request deny if admin_url
|
|
||||||
enabled: {{ .Values.ingress.enabled }}
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
className: {{ .Values.ingress.ingressClassName | quote }}
|
className: {{ .Values.ingress.ingressClassName | quote }}
|
||||||
hosts:
|
hosts:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.cryptpad.registry }}/{{ .Values.charts.cryptpad.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.cryptpad.registry }}/{{ .Values.charts.cryptpad.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "cryptpad"
|
- name: "cryptpad"
|
||||||
@@ -18,10 +18,12 @@ releases:
|
|||||||
version: "{{ .Values.charts.cryptpad.version }}"
|
version: "{{ .Values.charts.cryptpad.version }}"
|
||||||
values:
|
values:
|
||||||
- "values.yaml.gotmpl"
|
- "values.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.cryptpad | default "additionalValues: false" }}
|
{{- range .Values.customization.release.cryptpad }}
|
||||||
installed: {{ .Values.cryptpad.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.cryptpad.enabled }}
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "cryptpad"
|
component: "cryptpad"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -10,36 +10,35 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.element.registry }}/{{ .Values.charts.element.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.element.registry }}/{{ .Values.charts.element.repository }}"
|
||||||
- name: "element-well-known-repo"
|
- name: "element-well-known-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.elementWellKnown.verify }}
|
verify: {{ .Values.charts.elementWellKnown.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.elementWellKnown.registry }}/{{ .Values.charts.elementWellKnown.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.elementWellKnown.registry }}/{{ .Values.charts.elementWellKnown.repository }}"
|
||||||
- name: "synapse-web-repo"
|
- name: "synapse-web-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.synapseWeb.verify }}
|
verify: {{ .Values.charts.synapseWeb.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseWeb.registry }}/{{ .Values.charts.synapseWeb.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.synapseWeb.registry }}/{{ .Values.charts.synapseWeb.repository }}"
|
||||||
- name: "synapse-repo"
|
- name: "synapse-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.synapse.verify }}
|
verify: {{ .Values.charts.synapse.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapse.registry }}/{{ .Values.charts.synapse.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.synapse.registry }}/{{ .Values.charts.synapse.repository }}"
|
||||||
|
|
||||||
- name: "synapse-create-account-repo"
|
- name: "synapse-create-account-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.synapseCreateAccount.verify }}
|
verify: {{ .Values.charts.synapseCreateAccount.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseCreateAccount.registry }}/{{ .Values.charts.synapseCreateAccount.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.synapseCreateAccount.registry }}/{{ .Values.charts.synapseCreateAccount.repository }}"
|
||||||
|
|
||||||
# openDesk Matrix Widgets
|
# openDesk Matrix Widgets
|
||||||
# Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-matrix-widgets
|
# Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-matrix-widgets
|
||||||
@@ -49,35 +48,68 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixUserVerificationService.registry }}/{{ .Values.charts.matrixUserVerificationService.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.matrixUserVerificationService.registry }}/{{ .Values.charts.matrixUserVerificationService.repository }}"
|
||||||
- name: "matrix-neoboard-widget-repo"
|
- name: "matrix-neoboard-widget-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
||||||
- name: "matrix-neochoice-widget-repo"
|
- name: "matrix-neochoice-widget-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
||||||
- name: "matrix-neodatefix-widget-repo"
|
- name: "matrix-neodatefix-widget-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.matrixNeodatefixWidget.verify }}
|
verify: {{ .Values.charts.matrixNeodatefixWidget.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixWidget.registry }}/{{ .Values.charts.matrixNeodatefixWidget.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixWidget.registry }}/{{ .Values.charts.matrixNeodatefixWidget.repository }}"
|
||||||
- name: "matrix-neodatefix-bot-repo"
|
- name: "matrix-neodatefix-bot-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.matrixNeodatefixBot.verify }}
|
verify: {{ .Values.charts.matrixNeodatefixBot.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixBot.registry }}/{{ .Values.charts.matrixNeodatefixBot.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .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: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .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: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .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: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .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: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .Values.global.helmRegistry | default .Values.charts.synapsePipe.registry }}/{{ .Values.charts.synapsePipe.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "opendesk-element"
|
- name: "opendesk-element"
|
||||||
@@ -85,8 +117,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.element.version }}"
|
version: "{{ .Values.charts.element.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-element.yaml.gotmpl"
|
- "values-element.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskElement | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskElement }}
|
||||||
installed: {{ .Values.element.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-well-known"
|
- name: "opendesk-well-known"
|
||||||
@@ -94,8 +128,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.elementWellKnown.version }}"
|
version: "{{ .Values.charts.elementWellKnown.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-well-known.yaml.gotmpl"
|
- "values-well-known.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskWellKnown | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskWellKnown }}
|
||||||
installed: {{ .Values.element.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-synapse-web"
|
- name: "opendesk-synapse-web"
|
||||||
@@ -103,8 +139,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.synapseWeb.version }}"
|
version: "{{ .Values.charts.synapseWeb.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-synapse-web.yaml.gotmpl"
|
- "values-synapse-web.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskSynapseWeb | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskSynapseWeb }}
|
||||||
installed: {{ .Values.element.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-synapse"
|
- name: "opendesk-synapse"
|
||||||
@@ -112,8 +150,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.synapse.version }}"
|
version: "{{ .Values.charts.synapse.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-synapse.yaml.gotmpl"
|
- "values-synapse.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskSynapse | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskSynapse }}
|
||||||
installed: {{ .Values.element.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-matrix-user-verification-service-bootstrap"
|
- name: "opendesk-matrix-user-verification-service-bootstrap"
|
||||||
@@ -121,7 +161,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-user-verification-service-bootstrap.yaml.gotmpl"
|
- "values-matrix-user-verification-service-bootstrap.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixUserVerificationServiceBootstrap }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-matrix-user-verification-service"
|
- name: "opendesk-matrix-user-verification-service"
|
||||||
@@ -129,7 +172,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.matrixUserVerificationService.version }}"
|
version: "{{ .Values.charts.matrixUserVerificationService.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-user-verification-service.yaml.gotmpl"
|
- "values-matrix-user-verification-service.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixUserVerificationService }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "matrix-neoboard-widget"
|
- name: "matrix-neoboard-widget"
|
||||||
@@ -137,15 +183,21 @@ releases:
|
|||||||
version: "{{ .Values.charts.matrixNeoboardWidget.version }}"
|
version: "{{ .Values.charts.matrixNeoboardWidget.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-neoboard-widget.yaml.gotmpl"
|
- "values-matrix-neoboard-widget.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixNeoboardWidget }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "matrix-neochoice-widget"
|
- name: "matrix-neochoice-widget"
|
||||||
chart: "matrix-neochoice-widget-repo/{{ .Values.charts.matrixNeochoiseWidget.name }}"
|
chart: "matrix-neochoice-widget-repo/{{ .Values.charts.matrixNeochoiceWidget.name }}"
|
||||||
version: "{{ .Values.charts.matrixNeochoiseWidget.version }}"
|
version: "{{ .Values.charts.matrixNeochoiceWidget.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-neochoice-widget.yaml.gotmpl"
|
- "values-matrix-neochoice-widget.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixNeochoiceWidget }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "matrix-neodatefix-widget"
|
- name: "matrix-neodatefix-widget"
|
||||||
@@ -153,7 +205,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.matrixNeodatefixWidget.version }}"
|
version: "{{ .Values.charts.matrixNeodatefixWidget.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-neodatefix-widget.yaml.gotmpl"
|
- "values-matrix-neodatefix-widget.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixNeodatefixWidget }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "matrix-neodatefix-bot-bootstrap"
|
- name: "matrix-neodatefix-bot-bootstrap"
|
||||||
@@ -161,7 +216,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-neodatefix-bot-bootstrap.yaml.gotmpl"
|
- "values-matrix-neodatefix-bot-bootstrap.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixNeodatefixBotBootstrap }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.element.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "matrix-neodatefix-bot"
|
- name: "matrix-neodatefix-bot"
|
||||||
@@ -169,10 +227,91 @@ releases:
|
|||||||
version: "{{ .Values.charts.matrixNeodatefixBot.version }}"
|
version: "{{ .Values.charts.matrixNeodatefixBot.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-matrix-neodatefix-bot.yaml.gotmpl"
|
- "values-matrix-neodatefix-bot.yaml.gotmpl"
|
||||||
installed: {{ .Values.element.enabled }}
|
{{- range .Values.customization.release.matrixNeodatefixBot }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.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:
|
||||||
|
- "values-synapse-admin.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAdmin }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-adminbot-bootstrap"
|
||||||
|
chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
|
||||||
|
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-adminbot-bootstrap.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAdminbotBootstrap }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-adminbot-pipe"
|
||||||
|
chart: "synapse-pipe-repo/{{ .Values.charts.synapsePipe.name }}"
|
||||||
|
version: "{{ .Values.charts.synapsePipe.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-adminbot-pipe.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAdminbotPipe }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-adminbot-web"
|
||||||
|
chart: "synapse-adminbot-web-repo/{{ .Values.charts.synapseAdminbotWeb.name }}"
|
||||||
|
version: "{{ .Values.charts.synapseAdminbotWeb.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-adminbot-web.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAdminbotWeb }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-auditbot-bootstrap"
|
||||||
|
chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
|
||||||
|
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-auditbot-bootstrap.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAuditbotBootstrap }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-auditbot-pipe"
|
||||||
|
chart: "synapse-pipe-repo/{{ .Values.charts.synapsePipe.name }}"
|
||||||
|
version: "{{ .Values.charts.synapsePipe.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-auditbot-pipe.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseAuditbotPipe }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementAdmin.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
- name: "opendesk-synapse-groupsync"
|
||||||
|
chart: "synapse-groupsync-repo/{{ .Values.charts.synapseGroupsync.name }}"
|
||||||
|
version: "{{ .Values.charts.synapseGroupsync.version }}"
|
||||||
|
values:
|
||||||
|
- "values-synapse-groupsync.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendeskSynapseGroupsync }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.elementGroupsync.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "element"
|
component: "element"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ configuration:
|
|||||||
- org.matrix.msc2762.receive.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
|
- org.matrix.msc3973.user_directory_search
|
||||||
|
|
||||||
welcomeUserId: "@meetings-bot:{{ .Values.global.domain }}"
|
welcomeUserId: "@meetings-bot:{{ .Values.global.matrixDomain | default .Values.global.domain }}"
|
||||||
|
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
allowPrivilegeEscalation: false
|
allowPrivilegeEscalation: false
|
||||||
@@ -149,6 +149,7 @@ resources:
|
|||||||
{{ .Values.resources.element | toYaml | nindent 2 }}
|
{{ .Values.resources.element | toYaml | nindent 2 }}
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
|
title: "Chat - {{ .Values.theme.texts.productName }}"
|
||||||
{{ .Values.theme | toYaml | nindent 2 }}
|
{{ .Values.theme | toYaml | nindent 2 }}
|
||||||
|
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -54,4 +54,7 @@ resources:
|
|||||||
theme:
|
theme:
|
||||||
{{ .Values.theme | toYaml | nindent 2 }}
|
{{ .Values.theme | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
nginx:
|
||||||
|
ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
|
||||||
|
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -54,4 +54,7 @@ theme:
|
|||||||
resources:
|
resources:
|
||||||
{{ .Values.resources.matrixNeoChoiceWidget | toYaml | nindent 2 }}
|
{{ .Values.resources.matrixNeoChoiceWidget | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
nginx:
|
||||||
|
ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
|
||||||
|
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -81,8 +81,8 @@ liveness sample:
|
|||||||
enabled: true
|
enabled: true
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
size: {{ .Values.persistence.size.matrixNeoDateFixBot | quote }}
|
size: {{ .Values.persistence.storages.matrixNeoDateFixBot.size | quote }}
|
||||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
storageClass: {{ coalesce .Values.persistence.storages.matrixNeoDateFixBot.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
|
||||||
|
|
||||||
podAnnotations: {}
|
podAnnotations: {}
|
||||||
|
|
||||||
|
|||||||
@@ -59,4 +59,7 @@ resources:
|
|||||||
theme:
|
theme:
|
||||||
{{ .Values.theme | toYaml | nindent 2 }}
|
{{ .Values.theme | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
nginx:
|
||||||
|
ipv4Only: {{ if eq .Values.cluster.networking.ipFamilies "IPv4" }}true{{ else }}false{{ end }}
|
||||||
|
|
||||||
...
|
...
|
||||||
|
|||||||
87
helmfile/apps/element/values-synapse-admin.yaml.gotmpl
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
adminBot:
|
||||||
|
backupPhrase: {{ .Values.secrets.matrixAdminBot.backupPassphrase | quote }}
|
||||||
|
#name: "adminbot"
|
||||||
|
#secretName: "matrix-adminbot-account"
|
||||||
|
#secretKey: "access_token"
|
||||||
|
auditBot:
|
||||||
|
backupPhrase: {{ .Values.secrets.matrixAuditBot.backupPassphrase | quote }}
|
||||||
|
#name: "auditbot"
|
||||||
|
database:
|
||||||
|
host: {{ .Values.databases.synapse.host | quote }}
|
||||||
|
port: {{ .Values.databases.synapse.port }}
|
||||||
|
name: {{ .Values.databases.synapse.name | quote }}
|
||||||
|
user: {{ .Values.databases.synapse.username | quote }}
|
||||||
|
password:
|
||||||
|
value: {{ .Values.databases.synapse.password | default .Values.secrets.postgresql.matrixUser | quote }}
|
||||||
|
requireAuth: {{ .Values.databases.synapse.requireAuth }}
|
||||||
|
channelBinding: {{ .Values.databases.synapse.channelBinding | quote }}
|
||||||
|
connectTimeout: {{ .Values.databases.synapse.connectTimeout }}
|
||||||
|
clientEncoding: {{ .Values.databases.synapse.clientEncoding | quote }}
|
||||||
|
keepalives: {{ .Values.databases.synapse.keepalives }}
|
||||||
|
keepalivesIdle: {{ .Values.databases.synapse.keepalivesIdle }}
|
||||||
|
keepalivesInterval: {{ .Values.databases.synapse.keepalivesInterval }}
|
||||||
|
keepalivesCount: {{ .Values.databases.synapse.keepalivesCount }}
|
||||||
|
replication: {{ .Values.databases.synapse.replication }}
|
||||||
|
gssencmode: {{ .Values.databases.synapse.gssencmode | quote }}
|
||||||
|
sslmode: {{ .Values.databases.synapse.sslmode | quote }}
|
||||||
|
sslcompression: {{ .Values.databases.synapse.sslcompression }}
|
||||||
|
sslMinProtocolVersion: {{ .Values.databases.synapse.sslMinProtocolVersion | quote }}
|
||||||
|
connectionPoolMin: {{ .Values.databases.synapse.connectionPoolMin }}
|
||||||
|
connectionPoolMax: {{ .Values.databases.synapse.connectionPoolMax }}
|
||||||
|
# Settings regarding homeserver.
|
||||||
|
homeserver:
|
||||||
|
# -- URL of synapse deployment. As default the url of synapse will be used.
|
||||||
|
#baseUrl: ""
|
||||||
|
serverName: {{ .Values.global.matrixDomain | default .Values.global.domain | quote }}
|
||||||
|
ldap:
|
||||||
|
base: {{ .Values.ldap.baseDn | quote }}
|
||||||
|
bind_dn: "uid=ldapsearch_element,cn=users,{{ .Values.ldap.baseDn }}"
|
||||||
|
bind_password: {{ .Values.secrets.nubus.ldapSearch.element | quote }}
|
||||||
|
filter: "(memberOf=cn=managed-by-attribute-LivecollaborationAdmin,cn=groups,{{ .Values.ldap.baseDn }})"
|
||||||
|
uri: {{ printf "ldap://%s:389" .Values.ldap.host | quote }}
|
||||||
|
cron:
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementSyncAdmins.registry | quote }}
|
||||||
|
repository: {{ .Values.images.elementSyncAdmins.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementSyncAdmins.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
#fullnameOverride: "opendesk-synapse-admin"
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementSynapseAdmin.registry | quote }}
|
||||||
|
repository: {{ .Values.images.elementSynapseAdmin.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementSynapseAdmin.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
ingress:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
tls:
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
{{- if .Values.certificate.selfSigned }}
|
||||||
|
extraEnvVars:
|
||||||
|
- 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 }}
|
||||||
|
...
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
username: "adminbot"
|
||||||
|
pod: "opendesk-synapse-0"
|
||||||
|
secretName: "matrix-adminbot-account"
|
||||||
|
password: {{ .Values.secrets.matrixAdminBot.password | quote }}
|
||||||
|
pipeConfig:
|
||||||
|
enabled: true
|
||||||
|
type: "admin"
|
||||||
|
secretName: "matrix-adminbot-config"
|
||||||
|
asToken: {{ .Values.secrets.matrixAdminBot.synapseAsToken | quote }}
|
||||||
|
hsToken: {{ .Values.secrets.matrixAdminBot.synapseAsToken | quote }}
|
||||||
|
serviceUrl: "http://opendesk-synapse-web:8008"
|
||||||
|
backupPassphrase: {{ .Values.secrets.matrixAdminBot.backupPassphrase | quote }}
|
||||||
|
homeserverName: {{ .Values.global.matrixDomain | default .Values.global.domain | quote }}
|
||||||
|
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-adminbot-bootstrap"
|
||||||
|
...
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
secretName: "matrix-adminbot-config"
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementPipe.registry | quote }}
|
||||||
|
url: {{ .Values.images.elementPipe.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementPipe.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
fullnameOverride: "opendesk-synapse-adminbot-pipe"
|
||||||
|
...
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
homeserver:
|
||||||
|
serverName: {{ .Values.global.matrixDomain | default .Values.global.domain }}
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementAdminBot.registry | quote }}
|
||||||
|
repository: {{ .Values.images.elementAdminBot.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementAdminBot.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
ingress:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
tls:
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
...
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
username: "auditbot"
|
||||||
|
pod: "opendesk-synapse-0"
|
||||||
|
secretName: "matrix-auditbot-account"
|
||||||
|
password: {{ .Values.secrets.matrixAuditBot.password | quote }}
|
||||||
|
pipeConfig:
|
||||||
|
enabled: true
|
||||||
|
type: "admin"
|
||||||
|
secretName: "matrix-auditbot-config"
|
||||||
|
asToken: {{ .Values.secrets.matrixAuditBot.synapseAsToken | quote }}
|
||||||
|
hsToken: {{ .Values.secrets.matrixAuditBot.synapseAsToken | quote }}
|
||||||
|
serviceUrl: "http://opendesk-synapse-web:8008"
|
||||||
|
backupPassphrase: {{ .Values.secrets.matrixAuditBot.backupPassphrase | quote }}
|
||||||
|
homeserverName: {{ .Values.global.matrixDomain | default .Values.global.domain | quote }}
|
||||||
|
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-auditbot-bootstrap"
|
||||||
|
...
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
secretName: "matrix-auditbot-config"
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementPipe.registry | quote }}
|
||||||
|
url: {{ .Values.images.elementPipe.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementPipe.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
fullnameOverride: "opendesk-synapse-auditbot-pipe"
|
||||||
|
...
|
||||||
56
helmfile/apps/element/values-synapse-groupsync.yaml.gotmpl
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
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:
|
||||||
|
asToken: {{ .Values.secrets.matrixGroupsync.synapseAsToken | quote }}
|
||||||
|
dryRun: false
|
||||||
|
hsToken: {{ .Values.secrets.matrixGroupsync.synapseAsToken | quote }}
|
||||||
|
id: "gps"
|
||||||
|
homeserverName: {{ .Values.global.matrixDomain | default .Values.global.domain | quote }}
|
||||||
|
registrationSharedSecret: {{ .Values.secrets.synapse.registrationSharedSecret | quote }}
|
||||||
|
runOnce: false
|
||||||
|
username: "groupsyncbot"
|
||||||
|
ldap:
|
||||||
|
attributes:
|
||||||
|
name: "description"
|
||||||
|
uid: "uid"
|
||||||
|
base: {{ .Values.ldap.baseDn | quote }}
|
||||||
|
bind_dn: "uid=ldapsearch_element,cn=users,{{ .Values.ldap.baseDn }}"
|
||||||
|
bind_password: {{ .Values.secrets.nubus.ldapSearch.element | quote }}
|
||||||
|
check_interval_seconds: 60
|
||||||
|
type: mapped-ldap
|
||||||
|
uri: "ldap://ums-ldap-server:389"
|
||||||
|
spaces:
|
||||||
|
- groups:
|
||||||
|
- externalId: "cn=managed-by-attribute-LivecollaborationAdmin,cn=groups,{{ .Values.ldap.baseDn }}"
|
||||||
|
powerLevel: 50
|
||||||
|
- externalId: "cn=managed-by-attribute-Livecollaboration,cn=groups,{{ .Values.ldap.baseDn }}"
|
||||||
|
id: "c3122e32-4e05-4bf8-8a5d-66679076ed36"
|
||||||
|
name: "openDesk"
|
||||||
|
subspaces:
|
||||||
|
- groups:
|
||||||
|
- externalId: "cn=managed-by-attribute-LivecollaborationAdmin,cn=groups,{{ .Values.ldap.baseDn }}"
|
||||||
|
powerLevel: 50
|
||||||
|
id: "e7889d96-5baa-4e21-be6e-12c66b2e9565"
|
||||||
|
name: "openDesk Element Admins"
|
||||||
|
provisionerDefaultRooms:
|
||||||
|
- id: "c3122e32-4e05-4bf8-8a5d-66679076ed36"
|
||||||
|
properties:
|
||||||
|
name: "openDesk"
|
||||||
|
# Name of group sync service (default opendesk-synapse-groupsync)
|
||||||
|
groupSyncService: "opendesk-synapse-groupsync"
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.elementGroupsync.registry | quote }}
|
||||||
|
url: {{ .Values.images.elementGroupsync.repository | quote }}
|
||||||
|
tag: {{ .Values.images.elementGroupsync.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
...
|
||||||
@@ -27,9 +27,26 @@ configuration:
|
|||||||
|
|
||||||
database:
|
database:
|
||||||
host: {{ .Values.databases.synapse.host | quote }}
|
host: {{ .Values.databases.synapse.host | quote }}
|
||||||
|
port: {{ .Values.databases.synapse.port }}
|
||||||
name: {{ .Values.databases.synapse.name | quote }}
|
name: {{ .Values.databases.synapse.name | quote }}
|
||||||
user: {{ .Values.databases.synapse.username | quote }}
|
user: {{ .Values.databases.synapse.username | quote }}
|
||||||
password: {{ .Values.databases.synapse.password | default .Values.secrets.postgresql.matrixUser | quote }}
|
password:
|
||||||
|
value: {{ .Values.databases.synapse.password | default .Values.secrets.postgresql.matrixUser | quote }}
|
||||||
|
requireAuth: {{ .Values.databases.synapse.requireAuth }}
|
||||||
|
channelBinding: {{ .Values.databases.synapse.channelBinding | quote }}
|
||||||
|
connectTimeout: {{ .Values.databases.synapse.connectTimeout }}
|
||||||
|
clientEncoding: {{ .Values.databases.synapse.clientEncoding | quote }}
|
||||||
|
keepalives: {{ .Values.databases.synapse.keepalives }}
|
||||||
|
keepalivesIdle: {{ .Values.databases.synapse.keepalivesIdle }}
|
||||||
|
keepalivesInterval: {{ .Values.databases.synapse.keepalivesInterval }}
|
||||||
|
keepalivesCount: {{ .Values.databases.synapse.keepalivesCount }}
|
||||||
|
replication: {{ .Values.databases.synapse.replication }}
|
||||||
|
gssencmode: {{ .Values.databases.synapse.gssencmode | quote }}
|
||||||
|
sslmode: {{ .Values.databases.synapse.sslmode | quote }}
|
||||||
|
sslcompression: {{ .Values.databases.synapse.sslcompression }}
|
||||||
|
sslMinProtocolVersion: {{ .Values.databases.synapse.sslMinProtocolVersion | quote }}
|
||||||
|
connectionPoolMin: {{ .Values.databases.synapse.connectionPoolMin }}
|
||||||
|
connectionPoolMax: {{ .Values.databases.synapse.connectionPoolMax }}
|
||||||
|
|
||||||
homeserver:
|
homeserver:
|
||||||
serverName: {{ .Values.global.matrixDomain | default .Values.global.domain }}
|
serverName: {{ .Values.global.matrixDomain | default .Values.global.domain }}
|
||||||
@@ -43,8 +60,8 @@ configuration:
|
|||||||
regex: "@.*"
|
regex: "@.*"
|
||||||
url: null
|
url: null
|
||||||
sender_localpart: intercom-service
|
sender_localpart: intercom-service
|
||||||
- as_token: {{ .Values.secrets.oxAppsuite.synapseAsToken | quote }}
|
- as_token: {{ .Values.secrets.oxAppSuite.synapseAsToken | quote }}
|
||||||
hs_token: {{ .Values.secrets.oxAppsuite.synapseAsToken | quote }}
|
hs_token: {{ .Values.secrets.oxAppSuite.synapseAsToken | quote }}
|
||||||
id: ox-appsuite
|
id: ox-appsuite
|
||||||
namespaces:
|
namespaces:
|
||||||
users:
|
users:
|
||||||
@@ -52,6 +69,60 @@ configuration:
|
|||||||
regex: "@.*"
|
regex: "@.*"
|
||||||
url: null
|
url: null
|
||||||
sender_localpart: ox-appsuite
|
sender_localpart: ox-appsuite
|
||||||
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
{{- if .Values.apps.elementAdmin.enabled }}
|
||||||
|
- as_token: {{ .Values.secrets.matrixAdminBot.synapseAsToken | quote }}
|
||||||
|
hs_token: {{ .Values.secrets.matrixAdminBot.synapseAsToken | quote }}
|
||||||
|
id: "element-adminbot-pipe"
|
||||||
|
namespaces:
|
||||||
|
rooms:
|
||||||
|
- exclusive: false
|
||||||
|
regex: "!.*:{{ .Values.global.domain }}"
|
||||||
|
users:
|
||||||
|
- exclusive: false
|
||||||
|
regex: "@.*:.*"
|
||||||
|
- exclusive: true
|
||||||
|
regex: "@adminbot:{{ .Values.global.domain }}"
|
||||||
|
de.sorunome.msc2409.push_ephemeral: true
|
||||||
|
org.matrix.msc3202: true
|
||||||
|
url: "http://opendesk-synapse-adminbot-pipe:9995"
|
||||||
|
rate_limited: false
|
||||||
|
sender_localpart: "adminbot-sendernotinuse"
|
||||||
|
- as_token: {{ .Values.secrets.matrixAuditBot.synapseAsToken | quote }}
|
||||||
|
hs_token: {{ .Values.secrets.matrixAuditBot.synapseAsToken | quote }}
|
||||||
|
id: "element-auditbot-pipe"
|
||||||
|
namespaces:
|
||||||
|
rooms:
|
||||||
|
- exclusive: false
|
||||||
|
regex: "!.*:{{ .Values.global.domain }}"
|
||||||
|
users:
|
||||||
|
- exclusive: false
|
||||||
|
regex: "@.*:.*"
|
||||||
|
- exclusive: true
|
||||||
|
regex: "@auditbot:{{ .Values.global.domain }}"
|
||||||
|
de.sorunome.msc2409.push_ephemeral: true
|
||||||
|
org.matrix.msc3202: true
|
||||||
|
url: "http://opendesk-synapse-auditbot-pipe:9995"
|
||||||
|
rate_limited: false
|
||||||
|
sender_localpart: "auditbot-sendernotinuse"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.elementGroupsync.enabled }}
|
||||||
|
- as_token: {{ .Values.secrets.matrixGroupsync.synapseAsToken | quote }}
|
||||||
|
hs_token: {{ .Values.secrets.matrixGroupsync.synapseAsToken | quote }}
|
||||||
|
id: "gps"
|
||||||
|
namespaces:
|
||||||
|
rooms:
|
||||||
|
- exclusive: false
|
||||||
|
regex: "!.*:{{ .Values.global.domain }}"
|
||||||
|
users:
|
||||||
|
- exclusive: false
|
||||||
|
regex: '@.*:{{ .Values.global.domain }}'
|
||||||
|
url: "http://opendesk-synapse-groupsync:10010"
|
||||||
|
rate_limited: false
|
||||||
|
sender_localpart: "groupsyncbot"
|
||||||
|
{{- end }}
|
||||||
|
registrationSharedSecret: {{ .Values.secrets.synapse.registrationSharedSecret | quote }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
presence:
|
presence:
|
||||||
enabled: {{ .Values.functional.dataProtection.matrixPresence.enabled }}
|
enabled: {{ .Values.functional.dataProtection.matrixPresence.enabled }}
|
||||||
@@ -61,7 +132,7 @@ configuration:
|
|||||||
|
|
||||||
smtp:
|
smtp:
|
||||||
senderAddress: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.domain }}"
|
senderAddress: "{{ .Values.smtp.localpartNoReply }}@{{ .Values.global.domain }}"
|
||||||
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
|
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
|
||||||
port: 25
|
port: 25
|
||||||
tls: false
|
tls: false
|
||||||
starttls: false
|
starttls: false
|
||||||
@@ -137,6 +208,8 @@ extraVolumeMounts:
|
|||||||
|
|
||||||
federation:
|
federation:
|
||||||
enabled: {{ .Values.functional.externalServices.matrix.federation.enabled }}
|
enabled: {{ .Values.functional.externalServices.matrix.federation.enabled }}
|
||||||
|
domainAllowList:
|
||||||
|
{{ .Values.functional.externalServices.matrix.federation.domainAllowList | toYaml | nindent 4 }}
|
||||||
ingress:
|
ingress:
|
||||||
host: "{{ .Values.global.hosts.synapseFederation }}.{{ .Values.global.domain }}"
|
host: "{{ .Values.global.hosts.synapseFederation }}.{{ .Values.global.domain }}"
|
||||||
enabled: {{ .Values.ingress.enabled }}
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
@@ -159,8 +232,8 @@ image:
|
|||||||
tag: {{ .Values.images.synapse.tag | quote }}
|
tag: {{ .Values.images.synapse.tag | quote }}
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
size: {{ .Values.persistence.size.synapse | quote }}
|
size: {{ .Values.persistence.storages.synapse.size | quote }}
|
||||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
storageClass: {{ coalesce .Values.persistence.storages.synapse.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
|
||||||
|
|
||||||
podAnnotations: {}
|
podAnnotations: {}
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.jitsi.registry }}/{{ .Values.charts.jitsi.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.jitsi.registry }}/{{ .Values.charts.jitsi.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "jitsi"
|
- name: "jitsi"
|
||||||
@@ -18,11 +18,13 @@ releases:
|
|||||||
version: "{{ .Values.charts.jitsi.version }}"
|
version: "{{ .Values.charts.jitsi.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-jitsi.yaml.gotmpl"
|
- "values-jitsi.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.jitsi | default "additionalValues: false" }}
|
{{- range .Values.customization.release.jitsi }}
|
||||||
installed: {{ .Values.jitsi.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.jitsi.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "jitsi"
|
component: "jitsi"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -63,6 +63,7 @@ settings:
|
|||||||
keycloakClientId: "opendesk-jitsi"
|
keycloakClientId: "opendesk-jitsi"
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
|
title: "Videokonferenz - {{ .Values.theme.texts.productName }}"
|
||||||
{{ .Values.theme | toYaml | nindent 2 }}
|
{{ .Values.theme | toYaml | nindent 2 }}
|
||||||
|
|
||||||
jitsi:
|
jitsi:
|
||||||
@@ -84,7 +85,7 @@ jitsi:
|
|||||||
- secretName: {{ .Values.ingress.tls.secretName | quote }}
|
- secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
hosts:
|
hosts:
|
||||||
- "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
- "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||||
extraConfigJs:
|
extraConfig:
|
||||||
doNotStoreRoom: {{ not .Values.functional.dataProtection.jitsiRoomHistory.enabled }}
|
doNotStoreRoom: {{ not .Values.functional.dataProtection.jitsiRoomHistory.enabled }}
|
||||||
extraEnvs:
|
extraEnvs:
|
||||||
TURN_ENABLE: "1"
|
TURN_ENABLE: "1"
|
||||||
@@ -137,8 +138,8 @@ jitsi:
|
|||||||
resources:
|
resources:
|
||||||
{{ .Values.resources.prosody | toYaml | nindent 6 }}
|
{{ .Values.resources.prosody | toYaml | nindent 6 }}
|
||||||
persistence:
|
persistence:
|
||||||
size: {{ .Values.persistence.size.prosody | quote }}
|
size: {{ .Values.persistence.storages.prosody.size | quote }}
|
||||||
storageClassName: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
storageClassName: {{ coalesce .Values.persistence.storages.prosody.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
|
||||||
securityContext:
|
securityContext:
|
||||||
allowPrivilegeEscalation: false
|
allowPrivilegeEscalation: false
|
||||||
capabilities: {}
|
capabilities: {}
|
||||||
@@ -174,6 +175,35 @@ jitsi:
|
|||||||
type: "RuntimeDefault"
|
type: "RuntimeDefault"
|
||||||
seLinuxOptions:
|
seLinuxOptions:
|
||||||
{{ .Values.seLinuxOptions.jicofo | toYaml | nindent 8 }}
|
{{ .Values.seLinuxOptions.jicofo | toYaml | nindent 8 }}
|
||||||
|
jigasi:
|
||||||
|
replicaCount: {{ .Values.replicas.jigasi }}
|
||||||
|
enabled: {{ .Values.sip.jigasi.enabled }}
|
||||||
|
image:
|
||||||
|
repository: "{{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.jigasi.registry }}/{{ .Values.images.jigasi.repository }}"
|
||||||
|
tag: {{ .Values.images.jigasi.tag | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
extraEnvs:
|
||||||
|
JIGASI_SIP_PASSWORD: {{ .Values.sip.jigasi.password | quote }}
|
||||||
|
JIGASI_SIP_PORT: {{ .Values.sip.jigasi.port | quote }}
|
||||||
|
JIGASI_SIP_SERVER: {{ .Values.sip.jigasi.server | quote }}
|
||||||
|
JIGASI_SIP_TRANSPORT: {{ .Values.sip.jigasi.transport | quote }}
|
||||||
|
JIGASI_SIP_URI: {{ .Values.sip.jigasi.uri | quote }}
|
||||||
|
xmpp:
|
||||||
|
password: {{ .Values.secrets.jitsi.jigasiXmppPassword | quote }}
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.jigasi | toYaml | nindent 6 }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities: {}
|
||||||
|
privileged: false
|
||||||
|
readOnlyRootFilesystem: false
|
||||||
|
runAsGroup: 0
|
||||||
|
runAsNonRoot: false
|
||||||
|
runAsUser: 0
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
seLinuxOptions:
|
||||||
|
{{ .Values.seLinuxOptions.jigasi | toYaml | nindent 8 }}
|
||||||
jvb:
|
jvb:
|
||||||
replicaCount: {{ .Values.replicas.jvb }}
|
replicaCount: {{ .Values.replicas.jvb }}
|
||||||
# The `useNodeIP` option provided by the upstream charts does not support all relevant scenarios, but since
|
# The `useNodeIP` option provided by the upstream charts does not support all relevant scenarios, but since
|
||||||
@@ -189,7 +219,7 @@ jitsi:
|
|||||||
resources:
|
resources:
|
||||||
{{ .Values.resources.jvb | toYaml | nindent 6 }}
|
{{ .Values.resources.jvb | toYaml | nindent 6 }}
|
||||||
service:
|
service:
|
||||||
type: {{ .Values.cluster.service.type | quote }}
|
type: {{ coalesce .Values.service.type.jitsiVideoBridge .Values.cluster.service.type | quote }}
|
||||||
securityContext:
|
securityContext:
|
||||||
allowPrivilegeEscalation: false
|
allowPrivilegeEscalation: false
|
||||||
capabilities: {}
|
capabilities: {}
|
||||||
|
|||||||
@@ -10,14 +10,14 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.nextcloudManagement.registry }}/{{ .Values.charts.nextcloudManagement.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.nextcloudManagement.registry }}/{{ .Values.charts.nextcloudManagement.repository }}"
|
||||||
- name: "nextcloud-repo"
|
- name: "nextcloud-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.nextcloud.verify }}
|
verify: {{ .Values.charts.nextcloud.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.nextcloud.registry }}/{{ .Values.charts.nextcloud.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.nextcloud.registry }}/{{ .Values.charts.nextcloud.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "opendesk-nextcloud-management"
|
- name: "opendesk-nextcloud-management"
|
||||||
@@ -25,22 +25,32 @@ releases:
|
|||||||
version: "{{ .Values.charts.nextcloudManagement.version }}"
|
version: "{{ .Values.charts.nextcloudManagement.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-nextcloud-mgmt.yaml.gotmpl"
|
- "values-nextcloud-mgmt.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskNextcloudManagement | default "additionalValues: false" }}
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
- "values-nextcloud-mgmt-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.opendeskNextcloudManagement }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
waitForJobs: true
|
waitForJobs: true
|
||||||
wait: true
|
wait: true
|
||||||
installed: {{ .Values.nextcloud.enabled }}
|
installed: {{ .Values.apps.nextcloud.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
- name: "opendesk-nextcloud"
|
- name: "opendesk-nextcloud"
|
||||||
chart: "nextcloud-repo/{{ .Values.charts.nextcloud.name }}"
|
chart: "nextcloud-repo/{{ .Values.charts.nextcloud.name }}"
|
||||||
version: "{{ .Values.charts.nextcloud.version }}"
|
version: "{{ .Values.charts.nextcloud.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-nextcloud.yaml.gotmpl"
|
- "values-nextcloud.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskNextcloud | default "additionalValues: false" }}
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
- "values-nextcloud-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.opendeskNextcloud }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
needs:
|
needs:
|
||||||
- "opendesk-nextcloud-management"
|
- "opendesk-nextcloud-management"
|
||||||
installed: {{ .Values.nextcloud.enabled }}
|
installed: {{ .Values.apps.nextcloud.enabled }}
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "nextcloud"
|
component: "nextcloud"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
aio:
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }}
|
||||||
|
...
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.nextcloud.registry | quote }}
|
||||||
|
configuration:
|
||||||
|
enterprise:
|
||||||
|
subscriptionKey: {{ if .Values.enterpriseKeys.nextcloud.subscriptionKey }}{{ .Values.enterpriseKeys.nextcloud.subscriptionKey | quote }}{{ end }}
|
||||||
|
subscriptionData: {{ if .Values.enterpriseKeys.nextcloud.subscriptionData}}{{ .Values.enterpriseKeys.nextcloud.subscriptionData | quote }}{{ end }}
|
||||||
|
...
|
||||||
@@ -12,48 +12,94 @@ global:
|
|||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||||
|
|
||||||
additionalAnnotations:
|
additionalAnnotations:
|
||||||
intents.otterize.com/service-name: "opendesk-nextcloud-php"
|
intents.otterize.com/service-name: "opendesk-nextcloud-management"
|
||||||
|
|
||||||
cleanup:
|
cleanup:
|
||||||
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
||||||
|
|
||||||
configuration:
|
configuration:
|
||||||
administrator:
|
administrator:
|
||||||
|
# The admin user is (currently) required to bootstrap the OpenProject <> Nextcloud integration.
|
||||||
|
enabled: true
|
||||||
username:
|
username:
|
||||||
value: "nextcloud"
|
value: "nextcloud"
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.secrets.nextcloud.adminPassword | quote }}
|
value: {{ .Values.secrets.nextcloud.adminPassword | quote }}
|
||||||
|
|
||||||
antivirus:
|
antivirus:
|
||||||
{{- if .Values.clamavDistributed.enabled }}
|
{{- if .Values.antivirus.icap.host }}
|
||||||
|
host: {{ .Values.antivirus.icap.host | quote }}
|
||||||
|
port: {{ .Values.antivirus.icap.port | quote }}
|
||||||
|
{{- else }}
|
||||||
|
{{- if .Values.apps.clamavDistributed.enabled }}
|
||||||
host: "clamav-icap"
|
host: "clamav-icap"
|
||||||
{{- else if .Values.clamavSimple.enabled }}
|
{{- else if .Values.apps.clamavSimple.enabled }}
|
||||||
host: "clamav-simple"
|
host: "clamav-simple"
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
port: 1344
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
auth:
|
auth:
|
||||||
enabled: true
|
enabled: true
|
||||||
username:
|
username:
|
||||||
value: "default"
|
value: {{ .Values.cache.nextcloud.username }}
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.cache.nextcloud.password | default .Values.secrets.redis.password | quote }}
|
value: {{ .Values.cache.nextcloud.password | default .Values.secrets.redis.password | quote }}
|
||||||
host: {{ .Values.cache.nextcloud.host | quote }}
|
host: {{ .Values.cache.nextcloud.host | quote }}
|
||||||
port: {{ .Values.cache.nextcloud.port | quote }}
|
port: {{ .Values.cache.nextcloud.port | quote }}
|
||||||
|
tls: {{ .Values.cache.nextcloud.tls }}
|
||||||
|
|
||||||
|
feature:
|
||||||
|
apps:
|
||||||
|
contacts:
|
||||||
|
enabled: false
|
||||||
|
cryptpad:
|
||||||
|
enabled: {{ .Values.apps.cryptpad.enabled }}
|
||||||
|
filesZip:
|
||||||
|
enabled: true
|
||||||
|
groupfolders:
|
||||||
|
enabled: true
|
||||||
|
integrationOpenproject:
|
||||||
|
enabled: {{ .Values.apps.openproject.enabled }}
|
||||||
|
spreed:
|
||||||
|
enabled: true
|
||||||
|
circles:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
collabora:
|
collabora:
|
||||||
# internalWopiUrl: ""
|
# internalWopiUrl: ""
|
||||||
wopiAllowlist: {{ join ", " ( concat .Values.cluster.networking.cidr .Values.cluster.networking.incomingCIDR ) | quote }}
|
wopiAllowlist: {{ join ", " ( concat .Values.cluster.networking.cidr .Values.cluster.networking.incomingCIDR ) | quote }}
|
||||||
|
|
||||||
database:
|
database:
|
||||||
|
{{ if eq .Values.databases.nextcloud.type "mariadb" }}
|
||||||
|
type: "mysql"
|
||||||
|
{{ else if eq .Values.databases.nextcloud.type "postgresql" }}
|
||||||
|
type: "pgsql"
|
||||||
|
{{ else }}
|
||||||
|
{{ .Values.databases.nextcloud.type | quote }}
|
||||||
|
{{ end }}
|
||||||
host: {{ .Values.databases.nextcloud.host | quote }}
|
host: {{ .Values.databases.nextcloud.host | quote }}
|
||||||
port: {{ .Values.databases.nextcloud.port | quote }}
|
port: {{ .Values.databases.nextcloud.port | quote }}
|
||||||
|
name: {{ .Values.databases.nextcloud.name | quote }}
|
||||||
auth:
|
auth:
|
||||||
username:
|
username:
|
||||||
value: "nextcloud_user"
|
value: {{ .Values.databases.nextcloud.username | quote }}
|
||||||
password:
|
password:
|
||||||
|
{{- if or (eq .Values.databases.nextcloud.type "mariadb") (eq .Values.databases.nextcloud.type "mysql") }}
|
||||||
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.mariadb.nextcloudUser | quote }}
|
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.mariadb.nextcloudUser | quote }}
|
||||||
|
{{- else if or (eq .Values.databases.nextcloud.type "postgresql") (eq .Values.databases.nextcloud.type "psql") }}
|
||||||
|
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.postgresql.nextcloudUser | quote }}
|
||||||
|
{{- else }}
|
||||||
|
value: {{ .Values.databases.nextcloud.password | quote }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
ldap:
|
ldap:
|
||||||
host: {{ .Values.ldap.host | quote }}
|
host: {{ .Values.ldap.host | quote }}
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.secrets.nubus.ldapSearch.nextcloud | quote }}
|
value: {{ .Values.secrets.nubus.ldapSearch.nextcloud | quote }}
|
||||||
adminGroupName: "managed-by-attribute-FileshareAdmin"
|
adminGroupName: "managed-by-attribute-FileshareAdmin"
|
||||||
|
|
||||||
objectstore:
|
objectstore:
|
||||||
auth:
|
auth:
|
||||||
accessKey:
|
accessKey:
|
||||||
@@ -67,16 +113,19 @@ configuration:
|
|||||||
port: {{ .Values.objectstores.nextcloud.port | quote }}
|
port: {{ .Values.objectstores.nextcloud.port | quote }}
|
||||||
pathStyle: {{ .Values.objectstores.nextcloud.pathStyle | quote }}
|
pathStyle: {{ .Values.objectstores.nextcloud.pathStyle | quote }}
|
||||||
useSSL: {{ .Values.objectstores.nextcloud.useSSL | quote }}
|
useSSL: {{ .Values.objectstores.nextcloud.useSSL | quote }}
|
||||||
|
|
||||||
oidc:
|
oidc:
|
||||||
username:
|
username:
|
||||||
value: "opendesk-nextcloud"
|
value: "opendesk-nextcloud"
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.secrets.keycloak.clientSecret.ncoidc | quote }}
|
value: {{ .Values.secrets.keycloak.clientSecret.ncoidc | quote }}
|
||||||
|
|
||||||
opendeskIntegration:
|
opendeskIntegration:
|
||||||
username:
|
username:
|
||||||
value: "opendesk_username"
|
value: "opendesk_username"
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.secrets.centralnavigation.apiKey | quote }}
|
value: {{ .Values.secrets.centralnavigation.apiKey | quote }}
|
||||||
|
|
||||||
sharing:
|
sharing:
|
||||||
allowLinks: {{ .Values.functional.filestore.sharing.external.enabled }}
|
allowLinks: {{ .Values.functional.filestore.sharing.external.enabled }}
|
||||||
allowMailNotification: {{ .Values.functional.filestore.sharing.external.enabled }}
|
allowMailNotification: {{ .Values.functional.filestore.sharing.external.enabled }}
|
||||||
@@ -89,6 +138,8 @@ configuration:
|
|||||||
defaultExternalExpireEnabled: {{ .Values.functional.filestore.sharing.external.expiry.activeByDefault }}
|
defaultExternalExpireEnabled: {{ .Values.functional.filestore.sharing.external.expiry.activeByDefault }}
|
||||||
defaultExternalExpireEnforced: {{ .Values.functional.filestore.sharing.external.expiry.enforced }}
|
defaultExternalExpireEnforced: {{ .Values.functional.filestore.sharing.external.expiry.enforced }}
|
||||||
defaultExternalExpireDays: {{ .Values.functional.filestore.sharing.external.expiry.defaultDays | quote }}
|
defaultExternalExpireDays: {{ .Values.functional.filestore.sharing.external.expiry.defaultDays | quote }}
|
||||||
|
sendPasswordMail: {{ .Values.functional.filestore.sharing.external.sendPasswordMail | quote }}
|
||||||
|
|
||||||
smtp:
|
smtp:
|
||||||
auth:
|
auth:
|
||||||
enabled: false
|
enabled: false
|
||||||
@@ -96,12 +147,13 @@ configuration:
|
|||||||
value: ""
|
value: ""
|
||||||
password:
|
password:
|
||||||
value: ""
|
value: ""
|
||||||
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
|
host: {{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain | quote }}
|
||||||
port: 25
|
port: 25
|
||||||
fromAddress: {{ .Values.smtp.localpartNoReply | quote }}
|
fromAddress: {{ .Values.smtp.localpartNoReply | quote }}
|
||||||
mailDomain: "{{ .Values.global.domain }}"
|
mailDomain: "{{ .Values.global.domain }}"
|
||||||
security: ""
|
security: ""
|
||||||
skipVerifyPeer: true
|
skipVerifyPeer: true
|
||||||
|
|
||||||
quota:
|
quota:
|
||||||
default: "{{ .Values.functional.filestore.quota.default }} GB"
|
default: "{{ .Values.functional.filestore.quota.default }} GB"
|
||||||
retentionObligation:
|
retentionObligation:
|
||||||
@@ -131,6 +183,7 @@ podSecurityContext:
|
|||||||
|
|
||||||
debug:
|
debug:
|
||||||
loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }}
|
loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }}
|
||||||
|
bootstrap: {{ .Values.debug.enabled }}
|
||||||
|
|
||||||
{{- if .Values.certificate.selfSigned }}
|
{{- if .Values.certificate.selfSigned }}
|
||||||
extraEnvVars:
|
extraEnvVars:
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ global:
|
|||||||
exporter:
|
exporter:
|
||||||
enabled: true
|
enabled: true
|
||||||
configuration:
|
configuration:
|
||||||
|
server: "http://opendesk-nextcloud-aio"
|
||||||
token:
|
token:
|
||||||
value: {{ .Values.secrets.nextcloud.metricsToken | quote }}
|
value: {{ .Values.secrets.nextcloud.metricsToken | quote }}
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
@@ -49,25 +50,40 @@ exporter:
|
|||||||
|
|
||||||
aio:
|
aio:
|
||||||
additionalAnnotations:
|
additionalAnnotations:
|
||||||
intents.otterize.com/service-name: "opendesk-nextcloud"
|
intents.otterize.com/service-name: "opendesk-nextcloud-aio"
|
||||||
configuration:
|
configuration:
|
||||||
cache:
|
cache:
|
||||||
auth:
|
auth:
|
||||||
enabled: true
|
enabled: true
|
||||||
username:
|
username:
|
||||||
value: "default"
|
value: {{ .Values.cache.nextcloud.username }}
|
||||||
password:
|
password:
|
||||||
value: {{ .Values.cache.nextcloud.password | default .Values.secrets.redis.password | quote }}
|
value: {{ .Values.cache.nextcloud.password | default .Values.secrets.redis.password | quote }}
|
||||||
host: {{ .Values.cache.nextcloud.host | quote }}
|
host: {{ .Values.cache.nextcloud.host | quote }}
|
||||||
port: {{ .Values.cache.nextcloud.port | quote }}
|
port: {{ .Values.cache.nextcloud.port | quote }}
|
||||||
|
tls: {{ .Values.cache.nextcloud.tls }}
|
||||||
database:
|
database:
|
||||||
|
{{ if eq .Values.databases.nextcloud.type "mariadb" }}
|
||||||
|
type: "mysql"
|
||||||
|
{{ else if eq .Values.databases.nextcloud.type "postgresql" }}
|
||||||
|
type: "pgsql"
|
||||||
|
{{ else }}
|
||||||
|
{{ .Values.databases.nextcloud.type | quote }}
|
||||||
|
{{ end }}
|
||||||
host: {{ .Values.databases.nextcloud.host | quote }}
|
host: {{ .Values.databases.nextcloud.host | quote }}
|
||||||
port: {{ .Values.databases.nextcloud.port | quote }}
|
port: {{ .Values.databases.nextcloud.port | quote }}
|
||||||
|
name: {{ .Values.databases.nextcloud.name | quote }}
|
||||||
auth:
|
auth:
|
||||||
username:
|
username:
|
||||||
value: "nextcloud_user"
|
value: {{ .Values.databases.nextcloud.username | quote }}
|
||||||
password:
|
password:
|
||||||
|
{{- if or (eq .Values.databases.nextcloud.type "mariadb") (eq .Values.databases.nextcloud.type "mysql") }}
|
||||||
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.mariadb.nextcloudUser | quote }}
|
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.mariadb.nextcloudUser | quote }}
|
||||||
|
{{- else if or (eq .Values.databases.nextcloud.type "postgresql") (eq .Values.databases.nextcloud.type "psql") }}
|
||||||
|
value: {{ .Values.databases.nextcloud.password | default .Values.secrets.postgresql.nextcloudUser | quote }}
|
||||||
|
{{- else }}
|
||||||
|
value: {{ .Values.databases.nextcloud.password | quote }}
|
||||||
|
{{- end }}
|
||||||
trustedProxy: {{ join " " .Values.cluster.networking.cidr | quote }}
|
trustedProxy: {{ join " " .Values.cluster.networking.cidr | quote }}
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
allowPrivilegeEscalation: false
|
allowPrivilegeEscalation: false
|
||||||
@@ -86,6 +102,9 @@ aio:
|
|||||||
{{ .Values.seLinuxOptions.nextcloud | toYaml | nindent 6 }}
|
{{ .Values.seLinuxOptions.nextcloud | toYaml | nindent 6 }}
|
||||||
cron:
|
cron:
|
||||||
successfulJobsHistoryLimit: {{ if .Values.debug.enabled }}"3"{{ else }}"0"{{ end }}
|
successfulJobsHistoryLimit: {{ if .Values.debug.enabled }}"3"{{ else }}"0"{{ end }}
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.nextcloudCron | toYaml | nindent 6 }}
|
||||||
|
|
||||||
debug:
|
debug:
|
||||||
loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }}
|
loglevel: {{ if .Values.debug.enabled }}"0"{{ else }}"2"{{ end }}
|
||||||
{{- if .Values.certificate.selfSigned }}
|
{{- if .Values.certificate.selfSigned }}
|
||||||
|
|||||||
31
helmfile/apps/notes/helmfile-child.yaml.gotmpl
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
---
|
||||||
|
repositories:
|
||||||
|
# Notes
|
||||||
|
# Source: https://github.com/numerique-gouv/impress
|
||||||
|
- name: "notes-repo"
|
||||||
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
|
verify: {{ .Values.charts.notes.verify }}
|
||||||
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
|
oci: true
|
||||||
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.notes.registry }}/{{ .Values.charts.notes.repository }}"
|
||||||
|
|
||||||
|
releases:
|
||||||
|
- name: "impress"
|
||||||
|
chart: "notes-repo/{{ .Values.charts.notes.name }}"
|
||||||
|
version: "{{ .Values.charts.notes.version }}"
|
||||||
|
wait: true
|
||||||
|
values:
|
||||||
|
- "values.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.notes }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.notes.enabled }}
|
||||||
|
timeout: 1800
|
||||||
|
|
||||||
|
commonLabels:
|
||||||
|
deploy-stage: "component-1"
|
||||||
|
component: "notes"
|
||||||
|
...
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
230
helmfile/apps/notes/values.yaml.gotmpl
Normal file
@@ -0,0 +1,230 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
image:
|
||||||
|
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.notesBackend.registry) (.Values.images.notesBackend.repository) | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
tag: {{ .Values.images.notesBackend.tag }}
|
||||||
|
credentials:
|
||||||
|
name: {{ .Values.global.imagePullSecrets | first | quote }}
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName }}
|
||||||
|
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
|
||||||
|
tls:
|
||||||
|
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
|
||||||
|
ingressCollaborationWS:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName }}
|
||||||
|
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
|
||||||
|
path: "/collaboration/ws/"
|
||||||
|
tls:
|
||||||
|
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
annotations:
|
||||||
|
nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Can-Edit, X-User-Id"
|
||||||
|
nginx.ingress.kubernetes.io/auth-url: https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/documents/collaboration-auth/
|
||||||
|
nginx.ingress.kubernetes.io/enable-websocket: "true"
|
||||||
|
nginx.ingress.kubernetes.io/proxy-read-timeout: "86400"
|
||||||
|
nginx.ingress.kubernetes.io/proxy-send-timeout: "86400"
|
||||||
|
nginx.ingress.kubernetes.io/upstream-hash-by: $arg_room
|
||||||
|
|
||||||
|
ingressAdmin:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName }}
|
||||||
|
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
|
||||||
|
tls:
|
||||||
|
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
|
||||||
|
ingressMedia:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName }}
|
||||||
|
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
|
||||||
|
annotations:
|
||||||
|
nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Amz-Date, X-Amz-Content-SHA256"
|
||||||
|
nginx.ingress.kubernetes.io/auth-url: "https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/documents/retrieve-auth/"
|
||||||
|
nginx.ingress.kubernetes.io/upstream-vhost: {{ .Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
|
||||||
|
nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
|
||||||
|
nginx.ingress.kubernetes.io/use-regex: "true"
|
||||||
|
nginx.ingress.kubernetes.io/rewrite-target: /{{ .Values.objectstores.notes.bucket }}/$1
|
||||||
|
nginx.ingress.kubernetes.io/session-cookie-path: /media
|
||||||
|
tls:
|
||||||
|
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
|
||||||
|
ingressCollaborationApi:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
className: {{ .Values.ingress.ingressClassName }}
|
||||||
|
host: "{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}"
|
||||||
|
path: /collaboration/api/
|
||||||
|
tls:
|
||||||
|
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
|
||||||
|
|
||||||
|
serviceMedia:
|
||||||
|
host: {{ .Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
|
||||||
|
port: {{ .Values.objectstores.notes.port | default 443 }}
|
||||||
|
|
||||||
|
frontend:
|
||||||
|
image:
|
||||||
|
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.notesFrontend.registry) (.Values.images.notesFrontend.repository) | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
tag: {{ .Values.images.notesFrontend.tag }}
|
||||||
|
envVars:
|
||||||
|
PORT: 8080
|
||||||
|
NEXT_PUBLIC_API_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
NEXT_PUBLIC_Y_PROVIDER_URL: {{ printf "wss://%s.%s/ws" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
NEXT_PUBLIC_MEDIA_URL: {{ printf "https://%s" (.Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain)) | quote }}
|
||||||
|
runtimeEnvs:
|
||||||
|
ICS_BASE_URL: {{ printf "https://%s.%s" .Values.global.hosts.intercomService .Values.global.domain | quote }}
|
||||||
|
PORTAL_BASE_URL: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
|
||||||
|
replicas: {{ .Values.replicas.notesFrontend }}
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.notesFrontend | toYaml | nindent 4 }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities:
|
||||||
|
drop:
|
||||||
|
- "ALL"
|
||||||
|
privileged: false
|
||||||
|
runAsUser: 1001
|
||||||
|
runAsGroup: 1001
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
runAsNonRoot: true
|
||||||
|
seLinuxOptions:
|
||||||
|
{{ .Values.seLinuxOptions.notesFrontend | toYaml | nindent 6 }}
|
||||||
|
|
||||||
|
yProvider:
|
||||||
|
image:
|
||||||
|
repository: {{ printf "%s/%s" (coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.notesYProvider.registry) (.Values.images.notesYProvider.repository) | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
tag: {{ .Values.images.notesYProvider.tag }}
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.notesYProvider | toYaml | nindent 4 }}
|
||||||
|
replicas: {{ .Values.replicas.notesYProvider }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities:
|
||||||
|
drop:
|
||||||
|
- "ALL"
|
||||||
|
privileged: false
|
||||||
|
runAsUser: 1001
|
||||||
|
runAsGroup: 1001
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
runAsNonRoot: true
|
||||||
|
seLinuxOptions:
|
||||||
|
{{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }}
|
||||||
|
envVars:
|
||||||
|
COLLABORATION_LOGGING: {{ if .Values.debug.enabled }}"true"{{ else }}"false"{{ end }}
|
||||||
|
COLLABORATION_SERVER_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
COLLABORATION_SERVER_SECRET: {{ .Values.secrets.notes.collaborationSecret | quote }}
|
||||||
|
Y_PROVIDER_API_KEY: {{ .Values.secrets.notes.collaborationSecret | quote }}
|
||||||
|
|
||||||
|
oidc:
|
||||||
|
clientId: "opendesk-notes"
|
||||||
|
clientSecret: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
|
||||||
|
|
||||||
|
aiApiKey: {{ .Values.ai.apiKey }}
|
||||||
|
aiBaseUrl: {{ .Values.ai.endpoint }}
|
||||||
|
|
||||||
|
djangoSuperUserEmail: "default.admin@{{ .Values.global.domain }}"
|
||||||
|
djangoSuperUserPass: {{ .Values.secrets.notes.superuser }}
|
||||||
|
djangoSecretKey: {{ .Values.secrets.notes.djangoSecretKey }}
|
||||||
|
|
||||||
|
backend:
|
||||||
|
replicas: {{ .Values.replicas.notesBackend }}
|
||||||
|
envVars:
|
||||||
|
DB_HOST: {{ .Values.databases.notes.host | quote }}
|
||||||
|
DB_NAME: {{ .Values.databases.notes.name | quote }}
|
||||||
|
DB_USER: {{ .Values.databases.notes.username | quote }}
|
||||||
|
DB_PASSWORD: {{ .Values.databases.notes.password | default .Values.secrets.postgresql.notesUser | quote }}
|
||||||
|
DB_PORT: {{ .Values.databases.notes.port | quote }}
|
||||||
|
POSTGRES_DB: {{ .Values.databases.notes.name | quote }}
|
||||||
|
POSTGRES_USER: {{ .Values.databases.notes.username | quote }}
|
||||||
|
POSTGRES_PASSWORD: {{ .Values.databases.notes.password | default .Values.secrets.postgresql.notesUser | quote }}
|
||||||
|
FRONTEND_THEME: "openDesk"
|
||||||
|
REDIS_URL: "redis://default:{{ .Values.cache.notes.password | default .Values.secrets.redis.password }}@{{ .Values.cache.notes.host }}:{{ .Values.cache.notes.port }}/7"
|
||||||
|
AWS_S3_ENDPOINT_URL: {{ printf "https://%s" (.Values.objectstores.notes.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain)) | quote }}
|
||||||
|
AWS_S3_ACCESS_KEY_ID: {{ .Values.objectstores.notes.username }}
|
||||||
|
AWS_S3_SECRET_ACCESS_KEY: {{ .Values.objectstores.notes.secretKey | default .Values.secrets.minio.notesUser | quote }}
|
||||||
|
AWS_STORAGE_BUCKET_NAME: {{ .Values.objectstores.notes.bucket }}
|
||||||
|
DJANGO_CSRF_TRUSTED_ORIGINS: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
DJANGO_CONFIGURATION: Production
|
||||||
|
DJANGO_ALLOWED_HOSTS: "*"
|
||||||
|
DJANGO_SECRET_KEY: {{ .Values.secrets.notes.djangoSecretKey }}
|
||||||
|
DJANGO_SETTINGS_MODULE: impress.settings
|
||||||
|
DJANGO_SUPERUSER_PASSWORD: {{ .Values.secrets.notes.superuser }}
|
||||||
|
DJANGO_EMAIL_HOST: "postfix"
|
||||||
|
DJANGO_EMAIL_PORT: 25
|
||||||
|
DJANGO_EMAIL_USE_SSL: False
|
||||||
|
OIDC_RP_CLIENT_ID: "opendesk-notes"
|
||||||
|
OIDC_RP_CLIENT_SECRET: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
|
||||||
|
OIDC_OP_JWKS_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/certs"
|
||||||
|
OIDC_OP_AUTHORIZATION_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/auth"
|
||||||
|
OIDC_OP_TOKEN_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token"
|
||||||
|
OIDC_OP_USER_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/userinfo"
|
||||||
|
OIDC_OP_LOGOUT_ENDPOINT: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/logout"
|
||||||
|
OIDC_RP_SIGN_ALGO: RS256
|
||||||
|
OIDC_RP_SCOPES: "openid opendesk-notes-scope"
|
||||||
|
USER_OIDC_FIELD_TO_SHORTNAME: "given_name"
|
||||||
|
USER_OIDC_FIELDS_TO_FULLNAME: "given_name family_name"
|
||||||
|
OIDC_REDIRECT_ALLOWED_HOSTS: {{ printf "https://%s.%s/*" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
OIDC_AUTH_REQUEST_EXTRA_PARAMS: "{}"
|
||||||
|
OIDC_RENEW_ID_TOKEN: "False"
|
||||||
|
LOGIN_REDIRECT_URL: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
LOGIN_REDIRECT_URL_FAILURE: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
|
||||||
|
LOGOUT_REDIRECT_URL: {{ printf "https://%s.%s" .Values.global.hosts.nubus .Values.global.domain | quote }}
|
||||||
|
AI_BASE_URL: {{ .Values.ai.endpoint | quote }}
|
||||||
|
AI_API_KEY: {{ .Values.ai.apiKey | quote }}
|
||||||
|
AI_MODEL: {{ .Values.ai.model | quote }}
|
||||||
|
Y_PROVIDER_API_KEY: {{ .Values.secrets.notes.collaborationSecret | quote }}
|
||||||
|
Y_PROVIDER_API_BASE_URL: {{ printf "https://%s.%s/api/" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
COLLABORATION_API_URL: {{ printf "https://%s.%s/collaboration/api/" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
COLLABORATION_SERVER_ORIGIN: {{ printf "https://%s.%s" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
COLLABORATION_SERVER_SECRET: {{ .Values.secrets.notes.collaborationSecret | quote }}
|
||||||
|
COLLABORATION_WS_URL: {{ printf "wss://%s.%s/collaboration/ws/" .Values.global.hosts.notes .Values.global.domain | quote }}
|
||||||
|
migrate:
|
||||||
|
command:
|
||||||
|
- "/bin/sh"
|
||||||
|
- "-c"
|
||||||
|
- |
|
||||||
|
python manage.py migrate --no-input &&
|
||||||
|
python manage.py create_demo --force
|
||||||
|
restartPolicy: Never
|
||||||
|
|
||||||
|
createsuperuser:
|
||||||
|
command:
|
||||||
|
- "/bin/sh"
|
||||||
|
- "-c"
|
||||||
|
- |
|
||||||
|
python manage.py createsuperuser --email default.admin@{{ .Values.global.domain }} --password {{ .Values.secrets.notes.superuser }}
|
||||||
|
restartPolicy: Never
|
||||||
|
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.notesBackend | toYaml | nindent 4 }}
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities:
|
||||||
|
drop:
|
||||||
|
- "ALL"
|
||||||
|
privileged: false
|
||||||
|
runAsUser: 1001
|
||||||
|
runAsGroup: 1001
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
runAsNonRoot: true
|
||||||
|
seLinuxOptions:
|
||||||
|
{{ .Values.seLinuxOptions.notesBackend | toYaml | nindent 6 }}
|
||||||
|
...
|
||||||
@@ -10,7 +10,7 @@ repositories:
|
|||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url:
|
url:
|
||||||
"{{ .Values.global.helmRegistry | default .Values.charts.nubus.registry }}/{{ .Values.charts.nubus.repository }}"
|
"{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.nubus.registry }}/{{ .Values.charts.nubus.repository }}"
|
||||||
# Intercom Service
|
# Intercom Service
|
||||||
# Source: https://gitlab.souvap-univention.de/souvap/tooling/charts/intercom-service
|
# Source: https://gitlab.souvap-univention.de/souvap/tooling/charts/intercom-service
|
||||||
- name: "intercom-service-repo"
|
- name: "intercom-service-repo"
|
||||||
@@ -19,7 +19,7 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.intercomService.registry }}/{{ .Values.charts.intercomService.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.intercomService.registry }}/{{ .Values.charts.intercomService.repository }}"
|
||||||
# openDesk Keycloak Bootstrap Chart
|
# openDesk Keycloak Bootstrap Chart
|
||||||
- name: "opendesk-keycloak-bootstrap-repo"
|
- name: "opendesk-keycloak-bootstrap-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
@@ -27,7 +27,24 @@ repositories:
|
|||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.opendeskKeycloakBootstrap.registry }}/{{ .Values.charts.opendeskKeycloakBootstrap.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.opendeskKeycloakBootstrap.registry }}/{{ .Values.charts.opendeskKeycloakBootstrap.repository }}"
|
||||||
|
# openDesk 2FA Helpdesk Chart
|
||||||
|
- name: "opendesk-2fa-helpdesk-repo"
|
||||||
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
|
verify: {{ .Values.charts.opendesk2FAHelpdesk.verify }}
|
||||||
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
|
oci: true
|
||||||
|
# url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.opendesk2FAHelpdesk.registry }}/{{ .Values.charts.opendesk2FAHelpdesk.repository }}"
|
||||||
|
url: "{{ .Values.charts.opendesk2FAHelpdesk.registry }}/{{ .Values.charts.opendesk2FAHelpdesk.repository }}"
|
||||||
|
# NGINX S3 Gateway Chart
|
||||||
|
- name: "nginx-s3-gateway-repo"
|
||||||
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
|
verify: {{ .Values.charts.nginxS3Gateway.verify }}
|
||||||
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
|
oci: true
|
||||||
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.nginxS3Gateway.registry }}/{{ .Values.charts.nginxS3Gateway.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
# Univention Management Stack Umbrella Chart
|
# Univention Management Stack Umbrella Chart
|
||||||
@@ -36,10 +53,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.nubus.version }}"
|
version: "{{ .Values.charts.nubus.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-nubus.yaml.gotmpl"
|
- "values-nubus.yaml.gotmpl"
|
||||||
- "values-opendesk-customization.yaml.gotmpl"
|
{{- range .Values.customization.release.ums }}
|
||||||
- "values-opendesk-images.yaml.gotmpl"
|
- {{ . }}
|
||||||
- {{ .Values.customization.release.ums | default "additionalValues: false" }}
|
{{- end }}
|
||||||
installed: {{ .Values.nubus.enabled }}
|
installed: {{ .Values.apps.nubus.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
# Intercom-Service
|
# Intercom-Service
|
||||||
- name: "intercom-service"
|
- name: "intercom-service"
|
||||||
@@ -47,8 +64,10 @@ releases:
|
|||||||
version: "{{ .Values.charts.intercomService.version }}"
|
version: "{{ .Values.charts.intercomService.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-intercom-service.yaml.gotmpl"
|
- "values-intercom-service.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.intercomService | default "additionalValues: false" }}
|
{{- range .Values.customization.release.intercomService }}
|
||||||
installed: {{ .Values.nubus.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.nubus.enabled }}
|
||||||
|
|
||||||
# openDesk Keycloak Bootstrap Chart
|
# openDesk Keycloak Bootstrap Chart
|
||||||
- name: "opendesk-keycloak-bootstrap"
|
- name: "opendesk-keycloak-bootstrap"
|
||||||
@@ -56,13 +75,39 @@ releases:
|
|||||||
version: "{{ .Values.charts.opendeskKeycloakBootstrap.version }}"
|
version: "{{ .Values.charts.opendeskKeycloakBootstrap.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-opendesk-keycloak-bootstrap.yaml.gotmpl"
|
- "values-opendesk-keycloak-bootstrap.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskKeycloakBootstrap | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskKeycloakBootstrap }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
needs:
|
needs:
|
||||||
- "ums"
|
- "ums"
|
||||||
installed: {{ .Values.nubus.enabled }}
|
installed: {{ .Values.apps.nubus.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
# openDesk 2FA Helpdesk Chart
|
||||||
|
- name: "opendesk-2fa-helpdesk-backend"
|
||||||
|
chart: "opendesk-2fa-helpdesk-repo/{{ .Values.charts.opendesk2FAHelpdesk.name }}"
|
||||||
|
version: "{{ .Values.charts.opendesk2FAHelpdesk.version }}"
|
||||||
|
values:
|
||||||
|
- "values-opendesk-2fa-helpdesk.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.opendesk2FAHelpdesk}}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.nubus.enabled }}
|
||||||
|
timeout: 900
|
||||||
|
|
||||||
|
# NGINX S3 Gateway (when cluster minio is not used)
|
||||||
|
- name: "nubus"
|
||||||
|
chart: "nginx-s3-gateway-repo/{{ .Values.charts.nginxS3Gateway.name }}"
|
||||||
|
version: "{{ .Values.charts.nginxS3Gateway.version }}"
|
||||||
|
values:
|
||||||
|
- "values-nginx-s3-gateway.yaml.gotmpl"
|
||||||
|
{{- range .Values.customization.release.nginxS3Gateway }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ not .Values.apps.minio.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "nubus"
|
component: "nubus"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -32,7 +32,12 @@ extraVolumeMounts:
|
|||||||
- name: "trusted-cert-secret-volume"
|
- name: "trusted-cert-secret-volume"
|
||||||
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
||||||
subPath: "ca-certificates.crt"
|
subPath: "ca-certificates.crt"
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
extraEnvVars:
|
extraEnvVars:
|
||||||
|
- name: "REDIS_USER"
|
||||||
|
value: {{ .Values.cache.intercomService.username }}
|
||||||
|
{{- if .Values.certificate.selfSigned }}
|
||||||
- name: "NODE_EXTRA_CA_CERTS"
|
- name: "NODE_EXTRA_CA_CERTS"
|
||||||
value: "/etc/ssl/certs/ca-certificates.crt"
|
value: "/etc/ssl/certs/ca-certificates.crt"
|
||||||
{{- end }}
|
{{- end }}
|
||||||
@@ -48,7 +53,8 @@ ics:
|
|||||||
secret: {{ .Values.secrets.intercom.secret | quote }}
|
secret: {{ .Values.secrets.intercom.secret | quote }}
|
||||||
issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
|
issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
|
||||||
originRegex: "{{ .Values.global.domain }}"
|
originRegex: "{{ .Values.global.domain }}"
|
||||||
userUniqueMapper: {{ if .Values.functional.chat.matrix.profile.useImmutableIdentifierForLocalpart }}"entryuuid"{{ else }}"phoenixusername"{{ end }}
|
userUniqueMapper: {{ if .Values.functional.chat.matrix.profile.useImmutableIdentifierForLocalpart }}"opendesk_useruuid"{{ else }}"opendesk_username"{{ end }}
|
||||||
|
usernameClaim: "opendesk_username"
|
||||||
keycloak:
|
keycloak:
|
||||||
realm: {{ .Values.platform.realm | quote }}
|
realm: {{ .Values.platform.realm | quote }}
|
||||||
default:
|
default:
|
||||||
@@ -72,6 +78,9 @@ ics:
|
|||||||
oci: true
|
oci: true
|
||||||
url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
|
url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
|
||||||
audience: "opendesk-oxappsuite"
|
audience: "opendesk-oxappsuite"
|
||||||
|
xwiki:
|
||||||
|
subdomain: {{ .Values.global.hosts.xwiki | quote }}
|
||||||
|
audience: "opendesk-xwiki"
|
||||||
nextcloud:
|
nextcloud:
|
||||||
origin: {{ .Values.global.hosts.nextcloud | quote }}
|
origin: {{ .Values.global.hosts.nextcloud | quote }}
|
||||||
subdomain: {{ .Values.global.hosts.nextcloud | quote }}
|
subdomain: {{ .Values.global.hosts.nextcloud | quote }}
|
||||||
@@ -98,7 +107,9 @@ podSecurityContext:
|
|||||||
fsGroupChangePolicy: "Always"
|
fsGroupChangePolicy: "Always"
|
||||||
|
|
||||||
provisioning:
|
provisioning:
|
||||||
enabled: true
|
# intercom OIDC client is created by opendesk-keycloak-bootstrap, as we have control over the
|
||||||
|
# client's claims this way.
|
||||||
|
enabled: false
|
||||||
config:
|
config:
|
||||||
nubusBaseUrl: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}"
|
nubusBaseUrl: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}"
|
||||||
keycloak:
|
keycloak:
|
||||||
@@ -125,6 +136,8 @@ provisioning:
|
|||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloakBootstrap.registry | quote }}
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloakBootstrap.registry | quote }}
|
||||||
repository: {{ .Values.images.nubusKeycloakBootstrap.repository | quote }}
|
repository: {{ .Values.images.nubusKeycloakBootstrap.repository | quote }}
|
||||||
tag: {{ .Values.images.nubusKeycloakBootstrap.tag | quote }}
|
tag: {{ .Values.images.nubusKeycloakBootstrap.tag | quote }}
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.intercomService | toYaml | nindent 4 }}
|
||||||
securityContext:
|
securityContext:
|
||||||
seccompProfile:
|
seccompProfile:
|
||||||
type: "RuntimeDefault"
|
type: "RuntimeDefault"
|
||||||
|
|||||||
39
helmfile/apps/nubus/values-nginx-s3-gateway.yaml.gotmpl
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nginxS3Gateway.registry | quote }}
|
||||||
|
repository: {{ .Values.images.nginxS3Gateway.repository | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
tag: {{ .Values.images.nginxS3Gateway.tag | quote }}
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: {{ .Values.ingress.enabled }}
|
||||||
|
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||||
|
host: "{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}"
|
||||||
|
annotations:
|
||||||
|
nginx.ingress.kubernetes.io/rewrite-target: "/portal-assets/icons/$2/$3"
|
||||||
|
nginx.ingress.kubernetes.io/use-regex: "true"
|
||||||
|
path: "/univention/(portal|selfservice)/icons/(logos|entries)/(.*)$"
|
||||||
|
tls:
|
||||||
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
|
|
||||||
|
configuration:
|
||||||
|
bucket: {{ .Values.objectstores.nubus.bucket | quote }}
|
||||||
|
endpoint: {{ .Values.objectstores.nubus.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
|
||||||
|
port: 443
|
||||||
|
region: {{ .Values.objectstores.nubus.region | quote }}
|
||||||
|
style: "path"
|
||||||
|
credentials:
|
||||||
|
accessKey:
|
||||||
|
value: {{ .Values.objectstores.nubus.username | quote }}
|
||||||
|
secretKey:
|
||||||
|
value: {{ .Values.objectstores.nubus.secretKey | default .Values.secrets.minio.umsUser | quote }}
|
||||||
|
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.nginxS3Gateway | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
replicaCount: {{ .Values.replicas.nginxS3Gateway }}
|
||||||
|
...
|
||||||
770
helmfile/apps/nubus/values-opendesk-2fa-helpdesk.yaml.gotmpl
Normal file
@@ -0,0 +1,770 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
global:
|
||||||
|
domain: "{{ .Values.global.domain }}"
|
||||||
|
hosts:
|
||||||
|
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||||
|
imagePullSecrets:
|
||||||
|
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||||
|
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.opendesk2FAHelpdesk.registry | quote }}
|
||||||
|
repository: {{ .Values.images.opendesk2FAHelpdesk.repository | quote }}
|
||||||
|
tag: {{ .Values.images.opendesk2FAHelpdesk.tag | quote }}
|
||||||
|
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
|
||||||
|
cleanup:
|
||||||
|
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
||||||
|
keepPVCOnDelete: {{ .Values.debug.cleanup.keepPVCOnDelete }}
|
||||||
|
|
||||||
|
config:
|
||||||
|
clientAccessRestrictions:
|
||||||
|
{{- if .Values.apps.element.enabled }}
|
||||||
|
matrix:
|
||||||
|
client: "opendesk-matrix"
|
||||||
|
scope: "opendesk-matrix-scope"
|
||||||
|
role: "opendesk-matrix-access-control"
|
||||||
|
group: "managed-by-attribute-Livecollaboration"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.jitsi.enabled }}
|
||||||
|
jitsi:
|
||||||
|
client: "opendesk-jitsi"
|
||||||
|
scope: "opendesk-jitsi-scope"
|
||||||
|
role: "opendesk-jitsi-access-control"
|
||||||
|
group: "managed-by-attribute-Videoconference"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.xwiki.enabled }}
|
||||||
|
xwiki:
|
||||||
|
client: "opendesk-xwiki"
|
||||||
|
scope: "opendesk-xwiki-scope"
|
||||||
|
role: "opendesk-xwiki-access-control"
|
||||||
|
group: "managed-by-attribute-Knowledgemanagement"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.openproject.enabled }}
|
||||||
|
openproject:
|
||||||
|
client: "opendesk-openproject"
|
||||||
|
scope: "opendesk-openproject-scope"
|
||||||
|
role: "opendesk-openproject-access-control"
|
||||||
|
group: "managed-by-attribute-Projectmanagement"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.nextcloud.enabled }}
|
||||||
|
nextcloud:
|
||||||
|
client: "opendesk-nextcloud"
|
||||||
|
scope: "opendesk-nextcloud-scope"
|
||||||
|
role: "opendesk-nextcloud-access-control"
|
||||||
|
group: "managed-by-attribute-Fileshare"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.oxAppSuite.enabled }}
|
||||||
|
oxAppSuite:
|
||||||
|
client: "opendesk-oxappsuite"
|
||||||
|
scope: "opendesk-oxappsuite-scope"
|
||||||
|
role: "opendesk-oxappsuite-access-control"
|
||||||
|
group: "managed-by-attribute-Groupware"
|
||||||
|
dovecot:
|
||||||
|
client: "opendesk-dovecot"
|
||||||
|
scope: "opendesk-dovecot-scope"
|
||||||
|
role: "opendesk-dovecot-access-control"
|
||||||
|
group: "managed-by-attribute-Groupware"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.notes.enabled }}
|
||||||
|
notes:
|
||||||
|
client: "opendesk-notes"
|
||||||
|
scope: "opendesk-notes-scope"
|
||||||
|
role: "opendesk-notes-access-control"
|
||||||
|
group: "managed-by-attribute-Notes"
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
custom:
|
||||||
|
clientScopes:
|
||||||
|
{{ .Values.functional.authentication.oidc.clientScopes | toYaml | nindent 6 }}
|
||||||
|
clients:
|
||||||
|
{{ .Values.functional.authentication.oidc.clients | toYaml | nindent 6 }}
|
||||||
|
managed:
|
||||||
|
clientScopes: [ 'acr', 'web-origins', 'email', 'profile', 'microprofile-jwt', 'role_list',
|
||||||
|
'offline_access', 'roles', 'address', 'phone' ]
|
||||||
|
clients: [ 'guardian-management-api', 'guardian-scripts', 'guardian-ui', 'UMC', '${client_account}',
|
||||||
|
'${client_account-console}', '${client_admin-cli}', '${client_broker}', '${client_realm-management}',
|
||||||
|
'${client_security-admin-console}' ]
|
||||||
|
# keycloak:
|
||||||
|
# adminUser: "kcadmin"
|
||||||
|
# adminPassword: {{ .Values.secrets.keycloak.adminPassword | quote }}
|
||||||
|
# realm: {{ .Values.platform.realm | quote }}
|
||||||
|
# intraCluster:
|
||||||
|
# enabled: true
|
||||||
|
# internalBaseUrl: "http://ums-keycloak.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}:8080"
|
||||||
|
# twoFactorSettings:
|
||||||
|
# additionalGroups: {{ .Values.functional.authentication.twoFactor.groups }}
|
||||||
|
# precreateGroups: [ 'Domain Admins', 'Domain Users', '2fa-users', 'IAM API - Full Access',
|
||||||
|
# {{ if .Values.apps.nextcloud.enabled }}'managed-by-attribute-Fileshare', 'managed-by-attribute-FileshareAdmin',{{ end }}
|
||||||
|
# {{ if .Values.apps.xwiki.enabled }}'managed-by-attribute-Knowledgemanagement', 'managed-by-attribute-KnowledgemanagementAdmin',{{ end }}
|
||||||
|
# {{ if .Values.apps.element.enabled }}'managed-by-attribute-Livecollaboration', 'managed-by-attribute-LivecollaborationAdmin',{{ end }}
|
||||||
|
# {{ if .Values.apps.openproject.enabled }}'managed-by-attribute-Projectmanagement', 'managed-by-attribute-ProjectmanagementAdmin',{{ end }}
|
||||||
|
# {{ if .Values.apps.jitsi.enabled }}'managed-by-attribute-Videoconference',{{ end }}
|
||||||
|
# {{ if .Values.apps.oxAppSuite.enabled }}'managed-by-attribute-Groupware',{{ end }}
|
||||||
|
# {{ if .Values.apps.notes.enabled }}'managed-by-attribute-Notes',{{ end }}
|
||||||
|
# ]
|
||||||
|
|
||||||
|
opendesk:
|
||||||
|
# We use client specific scopes as we bind them to Keycloak role membership which itself is linked
|
||||||
|
# to LDAP group membership to ensure a user cannot access an application without the required
|
||||||
|
# group membership.
|
||||||
|
clientScopes:
|
||||||
|
- name: "read_contacts"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
- name: "write_contacts"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
{{ if .Values.apps.openproject.enabled }}
|
||||||
|
- name: "opendesk-openproject-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's OpenProject instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendeskProjectmanagementAdmin"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "opendeskProjectmanagementAdmin"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "openproject_admin"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "given name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "firstName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "given_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "family name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "lastName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "family_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.jitsi.enabled }}
|
||||||
|
- name: "opendesk-jitsi-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Jitsi instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "full name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-full-name-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
id.token.claim: true
|
||||||
|
introspection.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.nextcloud.enabled }}
|
||||||
|
- name: "opendesk-nextcloud-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Nextcloud instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "context"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "oxContextIDNum"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "context"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.element.enabled }}
|
||||||
|
- name: "opendesk-matrix-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Matrix instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "full name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-full-name-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
id.token.claim: true
|
||||||
|
introspection.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.xwiki.enabled }}
|
||||||
|
- name: "opendesk-xwiki-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's XWiki instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "full name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-full-name-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
id.token.claim: true
|
||||||
|
introspection.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.oxAppSuite.enabled }}
|
||||||
|
- name: "opendesk-dovecot-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Dovecot instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk-oxappsuite-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's OX Appuite instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "context"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "oxContextIDNum"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "context"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.notes.enabled }}
|
||||||
|
- name: "opendesk-notes-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Notes instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "given name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "firstName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "given_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "family name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "lastName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "family_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
clients:
|
||||||
|
- name: "opendesk-intercom"
|
||||||
|
clientId: "opendesk-intercom"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/callback"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.revoke.offline.tokens: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/backchannel-logout"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "intercom-audience"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-audience-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
included.client.audience: "opendesk-intercom"
|
||||||
|
id.token.claim: false
|
||||||
|
access.token.claim: true
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "offline_access"
|
||||||
|
{{ if .Values.apps.notes.enabled }}
|
||||||
|
- name: "opendesk-notes"
|
||||||
|
clientId: "opendesk-notes"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/callback/"
|
||||||
|
standardFlowEnabled: true
|
||||||
|
implicitFlowEnabled: false
|
||||||
|
alwaysDisplayInConsole: false
|
||||||
|
bearerOnly: false
|
||||||
|
directAccessGrantsEnabled: true
|
||||||
|
serviceAccountsEnabled: false
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
surrogateAuthRequired: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.revoke.offline.tokens: false
|
||||||
|
backchannel.logout.session.required: false
|
||||||
|
client.introspection.response.allow.jwt.claim.enabled: false
|
||||||
|
client.use.lightweight.access.token.enabled: false
|
||||||
|
client_credentials.use_refresh_token: false
|
||||||
|
display.on.consent.screen: false
|
||||||
|
oauth2.device.authorization.grant.enabled: false
|
||||||
|
oidc.ciba.grant.enabled: false
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/*"
|
||||||
|
require.pushed.authorization.requests: false
|
||||||
|
tls.client.certificate.bound.access.tokens: false
|
||||||
|
token.response.type.bearer.lower-case: false
|
||||||
|
use.jwks.url: false
|
||||||
|
use.refresh.tokens: false
|
||||||
|
# it is probably not even required to set this value explicitly.
|
||||||
|
user.info.response.signature.alg: "RS256"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-notes-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.oxAppSuite.enabled }}
|
||||||
|
- name: "opendesk-dovecot"
|
||||||
|
clientId: "opendesk-dovecot"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.dovecot | quote }}
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: false
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-dovecot-scope"
|
||||||
|
- name: "opendesk-oxappsuite"
|
||||||
|
clientId: "opendesk-oxappsuite"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.as8oidc | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/ajax/oidc/backchannel_logout"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-oxappsuite-scope"
|
||||||
|
- "read_contacts"
|
||||||
|
- "write_contacts"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.jitsi.enabled }}
|
||||||
|
- name: "opendesk-jitsi"
|
||||||
|
clientId: "opendesk-jitsi"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: true
|
||||||
|
fullScopeAllowed: true
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-jitsi-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.element.enabled }}
|
||||||
|
- name: "opendesk-matrix"
|
||||||
|
clientId: "opendesk-matrix"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.matrix | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
standardFlowEnabled: true
|
||||||
|
directAccessGrantsEnabled: true
|
||||||
|
serviceAccountsEnabled: true
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}/_synapse/client/oidc/backchannel_logout"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-matrix-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.nextcloud.enabled }}
|
||||||
|
- name: "opendesk-nextcloud"
|
||||||
|
clientId: "opendesk-nextcloud"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.ncoidc | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/apps/user_oidc/backchannel-logout/opendesk"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-nextcloud-scope"
|
||||||
|
- "read_contacts"
|
||||||
|
- "write_contacts"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.openproject.enabled }}
|
||||||
|
- name: "opendesk-openproject"
|
||||||
|
clientId: "opendesk-openproject"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.openproject | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.openproject }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
serviceAccountsEnabled: true
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.openproject }}.{{ .Values.global.domain }}/auth/keycloak/backchannel-logout"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openproject }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-openproject-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.xwiki.enabled }}
|
||||||
|
- name: "opendesk-xwiki"
|
||||||
|
clientId: "opendesk-xwiki"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.xwiki | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.xwiki }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: false
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.xwiki }}.{{ .Values.global.domain }}/oidc/authenticator/backchannel_logout"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.xwiki }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-xwiki-scope"
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
containerSecurityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities:
|
||||||
|
drop:
|
||||||
|
- "ALL"
|
||||||
|
enabled: true
|
||||||
|
privileged: false
|
||||||
|
runAsUser: 1000
|
||||||
|
runAsGroup: 1000
|
||||||
|
seccompProfile:
|
||||||
|
type: "RuntimeDefault"
|
||||||
|
readOnlyRootFilesystem: true
|
||||||
|
runAsNonRoot: true
|
||||||
|
seLinuxOptions:
|
||||||
|
{{ .Values.seLinuxOptions.opendesk2FAHelpdesk | toYaml | nindent 4 }}
|
||||||
|
|
||||||
|
additionalAnnotations:
|
||||||
|
argocd.argoproj.io/hook: "Sync"
|
||||||
|
argocd.argoproj.io/hook-delete-policy: "BeforeHookCreation"
|
||||||
|
|
||||||
|
podAnnotations:
|
||||||
|
intents.otterize.com/service-name: "ums-keycloak-bootstrap"
|
||||||
|
|
||||||
|
podSecurityContext:
|
||||||
|
enabled: true
|
||||||
|
fsGroup: 1000
|
||||||
|
fsGroupChangePolicy: "OnRootMismatch"
|
||||||
|
|
||||||
|
resources:
|
||||||
|
{{ .Values.resources.opendesk2FAHelpdesk | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
{{- if .Values.certificate.selfSigned }}
|
||||||
|
extraVolumes:
|
||||||
|
- name: "trusted-cert-secret-volume"
|
||||||
|
secret:
|
||||||
|
secretName: "opendesk-certificates-ca-tls"
|
||||||
|
items:
|
||||||
|
- key: "ca.crt"
|
||||||
|
path: "ca-certificates.crt"
|
||||||
|
extraVolumeMounts:
|
||||||
|
- name: "trusted-cert-secret-volume"
|
||||||
|
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
||||||
|
subPath: "ca-certificates.crt"
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
...
|
||||||
@@ -1,719 +0,0 @@
|
|||||||
{{/*
|
|
||||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
SPDX-License-Identifier: Apache-2.0
|
|
||||||
*/}}
|
|
||||||
---
|
|
||||||
keycloak:
|
|
||||||
enabled: true
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: false
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsKeycloak | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-keycloak"
|
|
||||||
replicaCount: {{ .Values.replicas.keycloak }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsKeycloak | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusGuardian:
|
|
||||||
authorizationApi:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-guardian-authorization-api"
|
|
||||||
podSecurityContext:
|
|
||||||
fsGroup: 1000
|
|
||||||
fsGroupChangePolicy: "Always"
|
|
||||||
replicaCount: {{ .Values.replicas.umsGuardianAuthorizationApi }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsGuardianAuthorizationApi | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- ALL
|
|
||||||
privileged: false
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsGroup: 1000
|
|
||||||
runAsNonRoot: true
|
|
||||||
runAsUser: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: RuntimeDefault
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsGuardianAuthorizationApi | toYaml | nindent 8 }}
|
|
||||||
managementApi:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-guardian-management-api"
|
|
||||||
podSecurityContext:
|
|
||||||
fsGroup: 1000
|
|
||||||
fsGroupChangePolicy: "Always"
|
|
||||||
replicaCount: {{ .Values.replicas.umsGuardianManagementApi }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsGuardianManagementApi | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- ALL
|
|
||||||
privileged: false
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsGroup: 1000
|
|
||||||
runAsNonRoot: true
|
|
||||||
runAsUser: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: RuntimeDefault
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsGuardianManagementApi | toYaml | nindent 8 }}
|
|
||||||
managementUi:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-guardian-management-ui"
|
|
||||||
replicaCount: {{ .Values.replicas.umsGuardianManagementUi }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsGuardianManagementUi | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- ALL
|
|
||||||
privileged: false
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsGroup: 1000
|
|
||||||
runAsNonRoot: true
|
|
||||||
runAsUser: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: RuntimeDefault
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsGuardianManagementUi | toYaml | nindent 8 }}
|
|
||||||
openPolicyAgent:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
podSecurityContext:
|
|
||||||
fsGroup: 1000
|
|
||||||
fsGroupChangePolicy: "Always"
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-ums-open-policy-agent"
|
|
||||||
replicaCount: {{ .Values.replicas.umsGuardianOpenPolicyAgent }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsOpenPolicyAgent | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- ALL
|
|
||||||
privileged: false
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsGroup: 1000
|
|
||||||
runAsNonRoot: true
|
|
||||||
runAsUser: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: RuntimeDefault
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsGuardianOpenPolicyAgent | toYaml | nindent 8 }}
|
|
||||||
provisioning:
|
|
||||||
# Using openDesk keycloak provisioning
|
|
||||||
enabled: false
|
|
||||||
|
|
||||||
nubusNotificationsApi:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-notifications-api"
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsNotificationsApi | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
replicaCount: {{ .Values.replicas.umsNotificationsApi }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsNotificationsApi | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusUmcServer:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-umc-server"
|
|
||||||
containerSecurityContext:
|
|
||||||
enabled: true
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
runAsUser: 0
|
|
||||||
runAsGroup: 0
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: false
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUmcServer | toYaml | nindent 6 }}
|
|
||||||
containerSecurityContextInit:
|
|
||||||
enabled: true
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
runAsUser: 0
|
|
||||||
runAsGroup: 0
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: false
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUmcServer | toYaml | nindent 6 }}
|
|
||||||
containerSecurityContextSssd:
|
|
||||||
enabled: true
|
|
||||||
allowPrivilegeEscalation: true
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
add:
|
|
||||||
- "DAC_OVERRIDE"
|
|
||||||
- "SETGID"
|
|
||||||
- "AUDIT_WRITE"
|
|
||||||
- "SETUID"
|
|
||||||
- "CHOWN"
|
|
||||||
- "SETPCAP"
|
|
||||||
- "FOWNER"
|
|
||||||
- "FSETID"
|
|
||||||
- "KILL"
|
|
||||||
- "MKNOD"
|
|
||||||
- "NET_BIND_SERVICE"
|
|
||||||
- "SYS_CHROOT"
|
|
||||||
runAsUser: 0
|
|
||||||
runAsGroup: 0
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: false
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUmcServer | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
proxy:
|
|
||||||
replicaCount: {{ .Values.replicas.umsUmcServerProxy }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsUmcServer }}
|
|
||||||
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsUmcServer | toYaml | nindent 4 }}
|
|
||||||
selfService:
|
|
||||||
passwordresetEmailBody: |
|
|
||||||
Sehr geehrte Benutzerin, sehr geehrter Benutzer,
|
|
||||||
|
|
||||||
Ihr Benutzername für {domainname} lautet: {username}
|
|
||||||
|
|
||||||
Sie erhalten diese Nachricht, da Sie Ihr Passwort zurücksetzen möchten oder weil Ihr Benutzer neu im System angelegt wurde.
|
|
||||||
|
|
||||||
Klicken Sie bitte auf den folgenden Link, um Ihr Passwort zu setzen:
|
|
||||||
https://{fqdn}/univention/portal/#/selfservice/newpassword/?token={token}&username={username}
|
|
||||||
|
|
||||||
Der genannte Link ist nur 48 Stunden gültig, danach fordern Sie ihn bitte erneut an unter:
|
|
||||||
https://{fqdn}/univention/portal/#/selfservice/passwordforgotten
|
|
||||||
|
|
||||||
Mit freundlichen Grüßen
|
|
||||||
Ihr {domainname} Passwort-Service
|
|
||||||
|
|
||||||
nubusKeycloakExtensions:
|
|
||||||
handler:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsKeycloakExtensionsHandler }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-keycloak-extensions-handler"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsKeycloakExtensionHandler | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsKeycloakExtensionHandler | toYaml | nindent 8 }}
|
|
||||||
proxy:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsKeycloakExtensionsProxy }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-keycloak-extensions-proxy"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsKeycloakExtensionProxy | toYaml | nindent 6 }}
|
|
||||||
securityContext:
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsKeycloakExtensionHandler | toYaml | nindent 8 }}
|
|
||||||
|
|
||||||
nubusPortalConsumer:
|
|
||||||
portalConsumer:
|
|
||||||
image:
|
|
||||||
pullSecrets:
|
|
||||||
{{- range .Values.global.imagePullSecrets }}
|
|
||||||
- name: {{ . | quote }}
|
|
||||||
{{- end }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-portal-consumer"
|
|
||||||
replicaCount: {{ .Values.replicas.umsPortalConsumer }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsPortalConsumer | toYaml | nindent 4 }}
|
|
||||||
resourcesWaitForDependency:
|
|
||||||
{{ .Values.resources.umsPortalConsumerDependencies | toYaml | nindent 4 }}
|
|
||||||
persistence:
|
|
||||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
|
||||||
size: {{ .Values.persistence.size.nubus.portalConsumer | quote }}
|
|
||||||
securityContext:
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsPortalConsumer | toYaml | nindent 6 }}
|
|
||||||
{{- if .Values.certificate.selfSigned }}
|
|
||||||
extraVolumes:
|
|
||||||
- name: "trusted-cert-secret-volume"
|
|
||||||
secret:
|
|
||||||
secretName: "opendesk-certificates-ca-tls"
|
|
||||||
items:
|
|
||||||
- key: "ca.crt"
|
|
||||||
path: "ca-certificates.crt"
|
|
||||||
- key: "ca.crt"
|
|
||||||
path: "cacert.pem"
|
|
||||||
extraVolumeMounts:
|
|
||||||
- name: "trusted-cert-secret-volume"
|
|
||||||
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
subPath: "ca-certificates.crt"
|
|
||||||
waitForDependency:
|
|
||||||
extraVolumeMounts:
|
|
||||||
- name: "trusted-cert-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
subPath: "ca-certificates.crt"
|
|
||||||
- name: "trusted-cert-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/usr/local/lib/python3.7/dist-packages/certifi/cacert.pem"
|
|
||||||
subPath: "cacert.pem"
|
|
||||||
extraEnvVars:
|
|
||||||
- name: "REQUESTS_CA_BUNDLE"
|
|
||||||
value: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
- name: "DEFAULT_CA_BUNDLE_PATH"
|
|
||||||
value: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
- name: "SSL_CERT_FILE"
|
|
||||||
value: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
{{- end }}
|
|
||||||
|
|
||||||
nubusUdmListener:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 102
|
|
||||||
runAsGroup: 65534
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUdmListener | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsUdmListener }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsUdmListener | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusPortalServer:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-portal-server"
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsPortalServer | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
replicaCount: {{ .Values.replicas.umsPortalServer }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsPortalServer | toYaml | nindent 4 }}
|
|
||||||
{{- if .Values.certificate.selfSigned }}
|
|
||||||
extraVolumes:
|
|
||||||
- name: "trusted-cert-crt-secret-volume"
|
|
||||||
secret:
|
|
||||||
secretName: "opendesk-certificates-ca-tls"
|
|
||||||
items:
|
|
||||||
- key: "ca.crt"
|
|
||||||
path: "ca-certificates.crt"
|
|
||||||
- key: "ca.crt"
|
|
||||||
path: "cacert.pem"
|
|
||||||
extraVolumeMounts:
|
|
||||||
- name: "trusted-cert-crt-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/etc/ssl/certs/ca-certificates.crt"
|
|
||||||
subPath: "ca-certificates.crt"
|
|
||||||
- name: "trusted-cert-crt-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/usr/local/lib/python3.7/dist-packages/certifi/cacert.pem"
|
|
||||||
subPath: "cacert.pem"
|
|
||||||
- name: "trusted-cert-crt-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/usr/lib/python3/dist-packages/botocore/cacert.pem"
|
|
||||||
subPath: "cacert.pem"
|
|
||||||
- name: "trusted-cert-crt-secret-volume"
|
|
||||||
readOnly: true
|
|
||||||
mountPath: "/usr/lib/python3/dist-packages/certifi/cacert.pem"
|
|
||||||
subPath: "cacert.pem"
|
|
||||||
{{- end }}
|
|
||||||
|
|
||||||
nubusLdapNotifier:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 101
|
|
||||||
runAsGroup: 102
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsLdapNotifier | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-ldap-notifier"
|
|
||||||
replicaCount: {{ .Values.replicas.umsLdapNotifier }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsLdapNotifier | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusLdapServer:
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
highAvailabilityMode: false
|
|
||||||
replicaCountPrimary: 1
|
|
||||||
replicaCountSecondary: 0 # {{ .Values.replicas.umsLdapServerSecondary }}
|
|
||||||
replicaCountProxy: 0 # {{ .Values.replicas.umsLdapServerProxy }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-ldap-server"
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
initResources: {{ .Values.resources.umsLdapServer | toYaml | nindent 4 }}
|
|
||||||
resources: {{ .Values.resources.umsLdapServer | toYaml | nindent 4 }}
|
|
||||||
persistence:
|
|
||||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
|
||||||
size: {{ .Values.persistence.size.nubus.ldapServerData | quote }}
|
|
||||||
extraVolumes:
|
|
||||||
- name: "migration-scripts"
|
|
||||||
secret:
|
|
||||||
secretName: "ums-ldap-server-migration"
|
|
||||||
defaultMode: 0555
|
|
||||||
extraVolumeMounts:
|
|
||||||
- name: "migration-scripts"
|
|
||||||
mountPath: "/entrypoint.d/30-purge.sh"
|
|
||||||
subPath: "30-purge.sh"
|
|
||||||
- name: "migration-scripts"
|
|
||||||
mountPath: "/entrypoint.d/95-slapadd-24-ldiff.sh"
|
|
||||||
subPath: "95-slapadd-24-ldif.sh"
|
|
||||||
extraSecrets:
|
|
||||||
- name: "ums-ldap-server-migration"
|
|
||||||
stringData:
|
|
||||||
30-purge.sh: |
|
|
||||||
#!/usr/bin/env bash
|
|
||||||
me=$(basename "$0")
|
|
||||||
echo "- Running ${me}"
|
|
||||||
if [ -f /var/lib/univention-ldap/ldap-24-export.ldif ]; then
|
|
||||||
echo "- Cleaning up /var/lib/univention-ldap."
|
|
||||||
cd /var/lib/univention-ldap
|
|
||||||
rm -rf internal
|
|
||||||
rm -rf ldap
|
|
||||||
ls -l
|
|
||||||
else
|
|
||||||
echo "- File /var/lib/univention-ldap/ldap-24-export.ldif not found."
|
|
||||||
fi
|
|
||||||
95-slapadd-24-ldif.sh: |
|
|
||||||
#!/usr/bin/env bash
|
|
||||||
me=$(basename "$0")
|
|
||||||
echo "- Running ${me}"
|
|
||||||
ls -l /var/lib/univention-ldap
|
|
||||||
if [ -f /var/lib/univention-ldap/ldap-24-export.ldif ]; then
|
|
||||||
echo "- slapadd-ing /var/lib/univention-ldap/ldap-24-export.ldif"
|
|
||||||
ls -l /var/lib/univention-ldap/
|
|
||||||
rm -rf /var/lib/univention-ldap/ldap
|
|
||||||
rm -rf /var/lib/univention-ldap/internal
|
|
||||||
echo "- deleted /var/lib/univention-ldap/ldap and /var/lib/univention-ldap/internal"
|
|
||||||
ls -l /var/lib/univention-ldap/
|
|
||||||
mkdir /var/lib/univention-ldap/ldap
|
|
||||||
mkdir /var/lib/univention-ldap/internal
|
|
||||||
echo "- created /var/lib/univention-ldap/ldap and /var/lib/univention-ldap/internal"
|
|
||||||
ls -l /var/lib/univention-ldap/
|
|
||||||
/usr/sbin/slapadd -v -l /var/lib/univention-ldap/ldap-24-export.ldif
|
|
||||||
echo "- slapadd executed"
|
|
||||||
ls -l /var/lib/univention-ldap/
|
|
||||||
mv /var/lib/univention-ldap/ldap-24-export.ldif /var/lib/univention-ldap/ldap-24-export.ldif-imported
|
|
||||||
echo "- import file renamed"
|
|
||||||
ls -l /var/lib/univention-ldap/
|
|
||||||
else
|
|
||||||
echo "- File /var/lib/univention-ldap/ldap-24-export.ldif not found."
|
|
||||||
fi
|
|
||||||
nubusPortalFrontend:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-portal-frontend"
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsPortalFrontend | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
replicaCount: {{ .Values.replicas.umsPortalFrontend }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsPortalFrontend | toYaml | nindent 4 }}
|
|
||||||
portalFrontend:
|
|
||||||
branding:
|
|
||||||
css: {{ .Values.theme.styles.portalCss | toJson }}
|
|
||||||
# Requires .ico, .svg does not work.
|
|
||||||
favicon: {{ .Values.theme.imagery.faviconIcoB64 | toJson }}
|
|
||||||
# The actual `logo` is set in customizing image, the logo down here is for for waiting spinner.
|
|
||||||
logo: {{ .Values.theme.imagery.portalWaitingSpinnerSvgB64 | toJson }}
|
|
||||||
backgroundImage: {{ .Values.theme.imagery.portalLogoBackgroundSvgB64 | toJson }}
|
|
||||||
|
|
||||||
nubusStackDataUms:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsStackDataUms | toYaml | nindent 6 }}
|
|
||||||
pullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-stack-data-ums"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsStackDataUms | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusSelfServiceConsumer:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsSelfserviceConsumer | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-selfservice-listener"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsSelfserviceConsumer | toYaml | nindent 4 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsSelfserviceConsumer }}
|
|
||||||
|
|
||||||
nubusUdmRestApi:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-udm-rest-api"
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUdmRestApi | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
serviceAccount:
|
|
||||||
annotations:
|
|
||||||
intended.usage: "compliance"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsUdmRestApi | toYaml | nindent 4 }}
|
|
||||||
initResources:
|
|
||||||
{{ .Values.resources.umsUdmRestApiInit | toYaml | nindent 4 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsUdmRestApi }}
|
|
||||||
|
|
||||||
nubusUmcGateway:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsUmcGateway | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
replicaCount: {{ .Values.replicas.umsUmcGateway }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsUmcGateway | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusKeycloakBootstrap:
|
|
||||||
containerSecurityContext:
|
|
||||||
enabled: true
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
readOnlyRootFilesystem: false
|
|
||||||
runAsGroup: 1000
|
|
||||||
runAsNonRoot: true
|
|
||||||
runAsUser: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsKeycloakBootstrap | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
podAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-keycloak-bootstrap"
|
|
||||||
serviceAccount:
|
|
||||||
annotations:
|
|
||||||
intended.usage: "compliance"
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsKeycloakBootstrap | toYaml | nindent 4 }}
|
|
||||||
|
|
||||||
nubusProvisioning:
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsProvisioning | toYaml | nindent 6 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
|
||||||
replicaCount:
|
|
||||||
dispatcher: {{ .Values.replicas.umsProvisioningDispatcher }}
|
|
||||||
udmTransformer: {{ .Values.replicas.umsProvisioningUdmTransformer }}
|
|
||||||
prefill: {{ .Values.replicas.umsProvisioningPrefill }}
|
|
||||||
api: {{ .Values.replicas.umsProvisioningApi }}
|
|
||||||
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
nats:
|
|
||||||
config:
|
|
||||||
cluster:
|
|
||||||
replicas: {{ .Values.replicas.umsProvisioningNats }}
|
|
||||||
containerSecurityContext:
|
|
||||||
allowPrivilegeEscalation: false
|
|
||||||
capabilities:
|
|
||||||
drop:
|
|
||||||
- "ALL"
|
|
||||||
enabled: true
|
|
||||||
runAsUser: 1000
|
|
||||||
runAsGroup: 1000
|
|
||||||
seccompProfile:
|
|
||||||
type: "RuntimeDefault"
|
|
||||||
readOnlyRootFilesystem: true
|
|
||||||
runAsNonRoot: true
|
|
||||||
seLinuxOptions:
|
|
||||||
{{ .Values.seLinuxOptions.umsProvisioningNats | toYaml | nindent 8 }}
|
|
||||||
imagePullSecrets:
|
|
||||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 6 }}
|
|
||||||
persistence:
|
|
||||||
size: {{ .Values.persistence.size.nubus.provisioningNats }}
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsProvisioningNats | toYaml | nindent 6 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-nats"
|
|
||||||
serviceAccount:
|
|
||||||
create: true
|
|
||||||
api:
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsProvisioningApi | toYaml | nindent 6 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-api"
|
|
||||||
dispatcher:
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsProvisioningDispatcher | toYaml | nindent 6 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-dispatcher"
|
|
||||||
prefill:
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsProvisioningPrefill | toYaml | nindent 6 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-prefill"
|
|
||||||
registerConsumers:
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-register-consumers"
|
|
||||||
udmTransformer:
|
|
||||||
resources:
|
|
||||||
{{ .Values.resources.umsProvisioningUdmTransformer | toYaml | nindent 6 }}
|
|
||||||
additionalAnnotations:
|
|
||||||
intents.otterize.com/service-name: "ums-provisioning-udm-transformer"
|
|
||||||
resources:
|
|
||||||
registerConsumers:
|
|
||||||
{{ .Values.resources.umsProvisioningRegisterConsumers | toYaml | nindent 6 }}
|
|
||||||
@@ -1,260 +0,0 @@
|
|||||||
{{/*
|
|
||||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
SPDX-License-Identifier: Apache-2.0
|
|
||||||
*/}}
|
|
||||||
---
|
|
||||||
global:
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
keycloak:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloak.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusKeycloak.repository }}
|
|
||||||
tag: {{ .Values.images.nubusKeycloak.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusKeycloakBootstrap:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloakBootstrap.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusKeycloakBootstrap.repository }}
|
|
||||||
tag: {{ .Values.images.nubusKeycloakBootstrap.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusKeycloakExtensions:
|
|
||||||
handler:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloakExtensionHandler.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusKeycloakExtensionHandler.repository }}
|
|
||||||
tag: {{ .Values.images.nubusKeycloakExtensionHandler.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
proxy:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusKeycloakExtensionProxy.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusKeycloakExtensionProxy.repository }}
|
|
||||||
tag: {{ .Values.images.nubusKeycloakExtensionProxy.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusLdapNotifier:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusLdapNotifier.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusLdapNotifier.repository }}
|
|
||||||
tag: {{ .Values.images.nubusLdapNotifier.tag }}
|
|
||||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusLdapServer:
|
|
||||||
ldapServer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusLdapServer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusLdapServer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusLdapServer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
dhInitcontainer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusLdapServerDhInitContainer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusLdapServerDhInitContainer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusLdapServerDhInitContainer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
waitForDependency:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusWaitForDependency.repository }}
|
|
||||||
tag: {{ .Values.images.nubusWaitForDependency.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusNotificationsApi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusNotificationsApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusNotificationsApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusNotificationsApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusPortalFrontend:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusPortalFrontend.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusPortalFrontend.repository }}
|
|
||||||
tag: {{ .Values.images.nubusPortalFrontend.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusPortalConsumer:
|
|
||||||
portalConsumer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusPortalConsumer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusPortalConsumer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusPortalConsumer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
waitForDependency:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusWaitForDependency.repository }}
|
|
||||||
tag: {{ .Values.images.nubusWaitForDependency.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusPortalServer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusPortalServer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusPortalServer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusPortalServer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusProvisioning:
|
|
||||||
api:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningEventsAndConsumerApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningEventsAndConsumerApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningEventsAndConsumerApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
dispatcher:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningDispatcher.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningDispatcher.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningDispatcher.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
udmTransformer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningUdmTransformer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningUdmTransformer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningUdmTransformer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
prefill:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningPrefill.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningPrefill.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningPrefill.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
registerConsumers:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusWaitForDependency.repository }}
|
|
||||||
tag: {{ .Values.images.nubusWaitForDependency.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
nats:
|
|
||||||
nats:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nubusNats.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusNats.repository }}
|
|
||||||
tag: {{ .Values.images.nubusNats.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
reloader:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nubusNatsReloader.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusNatsReloader.repository }}
|
|
||||||
tag: {{ .Values.images.nubusNatsReloader.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
natsBox:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nubusNatsBox.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusNatsBox.repository }}
|
|
||||||
tag: {{ .Values.images.nubusNatsBox.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusProvisioningEventsAndConsumerApi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningEventsAndConsumerApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningEventsAndConsumerApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningEventsAndConsumerApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusProvisioningPrefill:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningPrefill.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningPrefill.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningPrefill.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusUdmListener:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusProvisioningUdmListener.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusProvisioningUdmListener.repository }}
|
|
||||||
tag: {{ .Values.images.nubusProvisioningUdmListener.tag }}
|
|
||||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusSelfServiceConsumer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusSelfServiceConsumer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusSelfServiceConsumer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusSelfServiceConsumer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
waitForDependency:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusWaitForDependency.repository }}
|
|
||||||
tag: {{ .Values.images.nubusWaitForDependency.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusUdmRestApi:
|
|
||||||
udmRestApi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusUdmRestApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusUdmRestApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusUdmRestApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusUmcGateway:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusUmcGateway.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusUmcGateway.repository }}
|
|
||||||
tag: {{ .Values.images.nubusUmcGateway.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusUmcServer:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusUmcServer.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusUmcServer.repository }}
|
|
||||||
tag: {{ .Values.images.nubusUmcServer.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
proxy:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.nubusUmcServerProxy.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusUmcServerProxy.repository }}
|
|
||||||
tag: {{ .Values.images.nubusUmcServerProxy.tag }}
|
|
||||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusWaitForDependency:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusWaitForDependency.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusWaitForDependency.repository }}
|
|
||||||
tag: {{ .Values.images.nubusWaitForDependency.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
|
|
||||||
nubusGuardian:
|
|
||||||
provisioning:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianProvisioning.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusGuardianProvisioning.repository }}
|
|
||||||
tag: {{ .Values.images.nubusGuardianProvisioning.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
authorizationApi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianAuthorizationApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusGuardianAuthorizationApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusGuardianAuthorizationApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
managementApi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianManagementApi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusGuardianManagementApi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusGuardianManagementApi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
managementUi:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusGuardianManagementUi.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusGuardianManagementUi.repository }}
|
|
||||||
tag: {{ .Values.images.nubusGuardianManagementUi.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
openPolicyAgent:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusOpenPolicyAgent.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusOpenPolicyAgent.repository }}
|
|
||||||
tag: {{ .Values.images.nubusOpenPolicyAgent.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
|
|
||||||
nubusStackDataUms:
|
|
||||||
image:
|
|
||||||
registry: {{ coalesce .Values.repositories.image.registryOpencodeDe .Values.global.imageRegistry .Values.images.nubusDataLoader.registry | quote }}
|
|
||||||
repository: {{ .Values.images.nubusDataLoader.repository }}
|
|
||||||
tag: {{ .Values.images.nubusDataLoader.tag }}
|
|
||||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
|
||||||
@@ -21,14 +21,73 @@ cleanup:
|
|||||||
keepPVCOnDelete: {{ .Values.debug.cleanup.keepPVCOnDelete }}
|
keepPVCOnDelete: {{ .Values.debug.cleanup.keepPVCOnDelete }}
|
||||||
|
|
||||||
config:
|
config:
|
||||||
|
clientAccessRestrictions:
|
||||||
|
{{- if .Values.apps.element.enabled }}
|
||||||
|
matrix:
|
||||||
|
client: "opendesk-matrix"
|
||||||
|
scope: "opendesk-matrix-scope"
|
||||||
|
role: "opendesk-matrix-access-control"
|
||||||
|
group: "managed-by-attribute-Livecollaboration"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.jitsi.enabled }}
|
||||||
|
jitsi:
|
||||||
|
client: "opendesk-jitsi"
|
||||||
|
scope: "opendesk-jitsi-scope"
|
||||||
|
role: "opendesk-jitsi-access-control"
|
||||||
|
group: "managed-by-attribute-Videoconference"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.xwiki.enabled }}
|
||||||
|
xwiki:
|
||||||
|
client: "opendesk-xwiki"
|
||||||
|
scope: "opendesk-xwiki-scope"
|
||||||
|
role: "opendesk-xwiki-access-control"
|
||||||
|
group: "managed-by-attribute-Knowledgemanagement"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.openproject.enabled }}
|
||||||
|
openproject:
|
||||||
|
client: "opendesk-openproject"
|
||||||
|
scope: "opendesk-openproject-scope"
|
||||||
|
role: "opendesk-openproject-access-control"
|
||||||
|
group: "managed-by-attribute-Projectmanagement"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.nextcloud.enabled }}
|
||||||
|
nextcloud:
|
||||||
|
client: "opendesk-nextcloud"
|
||||||
|
scope: "opendesk-nextcloud-scope"
|
||||||
|
role: "opendesk-nextcloud-access-control"
|
||||||
|
group: "managed-by-attribute-Fileshare"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.oxAppSuite.enabled }}
|
||||||
|
oxAppSuite:
|
||||||
|
client: "opendesk-oxappsuite"
|
||||||
|
scope: "opendesk-oxappsuite-scope"
|
||||||
|
role: "opendesk-oxappsuite-access-control"
|
||||||
|
group: "managed-by-attribute-Groupware"
|
||||||
|
dovecot:
|
||||||
|
client: "opendesk-dovecot"
|
||||||
|
scope: "opendesk-dovecot-scope"
|
||||||
|
role: "opendesk-dovecot-access-control"
|
||||||
|
group: "managed-by-attribute-Groupware"
|
||||||
|
{{- end }}
|
||||||
|
{{- if .Values.apps.notes.enabled }}
|
||||||
|
notes:
|
||||||
|
client: "opendesk-notes"
|
||||||
|
scope: "opendesk-notes-scope"
|
||||||
|
role: "opendesk-notes-access-control"
|
||||||
|
group: "managed-by-attribute-Notes"
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
custom:
|
custom:
|
||||||
clientScopes:
|
clientScopes:
|
||||||
{{ .Values.functional.authentication.oidc.clientScopes | toYaml | nindent 6 }}
|
{{ .Values.functional.authentication.oidc.clientScopes | toYaml | nindent 6 }}
|
||||||
clients:
|
clients:
|
||||||
{{ .Values.functional.authentication.oidc.clients | toYaml | nindent 6 }}
|
{{ .Values.functional.authentication.oidc.clients | toYaml | nindent 6 }}
|
||||||
managed:
|
managed:
|
||||||
clientScopes: [ 'acr', 'web-origins', 'email', 'profile', 'microprofile-jwt', 'role_list', 'offline_access', 'roles', 'address', 'phone' ]
|
clientScopes: [ 'acr', 'web-origins', 'email', 'profile', 'microprofile-jwt', 'role_list',
|
||||||
clients: [ 'opendesk-intercom', 'guardian-management-api', 'guardian-scripts', 'guardian-ui', 'UMC', '${client_account}', '${client_account-console}', '${client_admin-cli}', '${client_broker}', '${client_realm-management}', '${client_security-admin-console}' ]
|
'offline_access', 'roles', 'address', 'phone' ]
|
||||||
|
clients: [ 'guardian-management-api', 'guardian-scripts', 'guardian-ui', 'UMC', '${client_account}',
|
||||||
|
'${client_account-console}', '${client_admin-cli}', '${client_broker}', '${client_realm-management}',
|
||||||
|
'${client_security-admin-console}' ]
|
||||||
keycloak:
|
keycloak:
|
||||||
adminUser: "kcadmin"
|
adminUser: "kcadmin"
|
||||||
adminPassword: {{ .Values.secrets.keycloak.adminPassword | quote }}
|
adminPassword: {{ .Values.secrets.keycloak.adminPassword | quote }}
|
||||||
@@ -38,16 +97,26 @@ config:
|
|||||||
internalBaseUrl: "http://ums-keycloak.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}:8080"
|
internalBaseUrl: "http://ums-keycloak.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}:8080"
|
||||||
twoFactorSettings:
|
twoFactorSettings:
|
||||||
additionalGroups: {{ .Values.functional.authentication.twoFactor.groups }}
|
additionalGroups: {{ .Values.functional.authentication.twoFactor.groups }}
|
||||||
|
precreateGroups: [ 'Domain Admins', 'Domain Users', '2fa-users', 'IAM API - Full Access',
|
||||||
|
{{ if .Values.apps.nextcloud.enabled }}'managed-by-attribute-Fileshare', 'managed-by-attribute-FileshareAdmin',{{ end }}
|
||||||
|
{{ if .Values.apps.xwiki.enabled }}'managed-by-attribute-Knowledgemanagement', 'managed-by-attribute-KnowledgemanagementAdmin',{{ end }}
|
||||||
|
{{ if .Values.apps.element.enabled }}'managed-by-attribute-Livecollaboration', 'managed-by-attribute-LivecollaborationAdmin',{{ end }}
|
||||||
|
{{ if .Values.apps.openproject.enabled }}'managed-by-attribute-Projectmanagement', 'managed-by-attribute-ProjectmanagementAdmin',{{ end }}
|
||||||
|
{{ if .Values.apps.jitsi.enabled }}'managed-by-attribute-Videoconference',{{ end }}
|
||||||
|
{{ if .Values.apps.oxAppSuite.enabled }}'managed-by-attribute-Groupware',{{ end }}
|
||||||
|
{{ if .Values.apps.notes.enabled }}'managed-by-attribute-Notes',{{ end }}
|
||||||
|
]
|
||||||
|
|
||||||
opendesk:
|
opendesk:
|
||||||
# We use client specific scopes as we bind them to Keycloak role membership which itself is linked
|
# We use client specific scopes as we bind them to Keycloak role membership which itself is linked
|
||||||
# to LDAP group membership to ensure a user cannot access an application without the required
|
# to LDAP group membership to ensure a user cannot access an application without the required
|
||||||
# group membership.
|
# group membership.
|
||||||
# ToDo: Ensure all applications verify the token's signature to ensure it is not tampered.
|
|
||||||
clientScopes:
|
clientScopes:
|
||||||
- name: "read_contacts"
|
- name: "read_contacts"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
- name: "write_contacts"
|
- name: "write_contacts"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
|
{{ if .Values.apps.openproject.enabled }}
|
||||||
- name: "opendesk-openproject-scope"
|
- name: "opendesk-openproject-scope"
|
||||||
description: "Scope for the claims required by openDesk's OpenProject instance."
|
description: "Scope for the claims required by openDesk's OpenProject instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -121,6 +190,8 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "family_name"
|
claim.name: "family_name"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.jitsi.enabled }}
|
||||||
- name: "opendesk-jitsi-scope"
|
- name: "opendesk-jitsi-scope"
|
||||||
description: "Scope for the claims required by openDesk's Jitsi instance."
|
description: "Scope for the claims required by openDesk's Jitsi instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -168,6 +239,8 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "email"
|
claim.name: "email"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.nextcloud.enabled }}
|
||||||
- name: "opendesk-nextcloud-scope"
|
- name: "opendesk-nextcloud-scope"
|
||||||
description: "Scope for the claims required by openDesk's Nextcloud instance."
|
description: "Scope for the claims required by openDesk's Nextcloud instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -217,6 +290,8 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "context"
|
claim.name: "context"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.element.enabled }}
|
||||||
- name: "opendesk-matrix-scope"
|
- name: "opendesk-matrix-scope"
|
||||||
description: "Scope for the claims required by openDesk's Matrix instance."
|
description: "Scope for the claims required by openDesk's Matrix instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -264,6 +339,8 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "email"
|
claim.name: "email"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.xwiki.enabled }}
|
||||||
- name: "opendesk-xwiki-scope"
|
- name: "opendesk-xwiki-scope"
|
||||||
description: "Scope for the claims required by openDesk's XWiki instance."
|
description: "Scope for the claims required by openDesk's XWiki instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -311,6 +388,8 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "email"
|
claim.name: "email"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.oxAppSuite.enabled }}
|
||||||
- name: "opendesk-dovecot-scope"
|
- name: "opendesk-dovecot-scope"
|
||||||
description: "Scope for the claims required by openDesk's Dovecot instance."
|
description: "Scope for the claims required by openDesk's Dovecot instance."
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -374,7 +453,138 @@ config:
|
|||||||
access.token.claim: true
|
access.token.claim: true
|
||||||
claim.name: "opendesk_username"
|
claim.name: "opendesk_username"
|
||||||
jsonType.label: "String"
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.notes.enabled }}
|
||||||
|
- name: "opendesk-notes-scope"
|
||||||
|
description: "Scope for the claims required by openDesk's Notes instance."
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "email"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "email"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "email"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "given name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "firstName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "given_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "family name"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
introspection.token.claim: true
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "lastName"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "family_name"
|
||||||
|
jsonType.label: "String"
|
||||||
|
{{ end }}
|
||||||
clients:
|
clients:
|
||||||
|
- name: "opendesk-intercom"
|
||||||
|
clientId: "opendesk-intercom"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/callback"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.revoke.offline.tokens: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/backchannel-logout"
|
||||||
|
protocolMappers:
|
||||||
|
- name: "intercom-audience"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-audience-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
included.client.audience: "opendesk-intercom"
|
||||||
|
id.token.claim: false
|
||||||
|
access.token.claim: true
|
||||||
|
- name: "opendesk_username"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "uid"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_username"
|
||||||
|
jsonType.label: "String"
|
||||||
|
- name: "opendesk_useruuid"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
protocolMapper: "oidc-usermodel-attribute-mapper"
|
||||||
|
consentRequired: false
|
||||||
|
config:
|
||||||
|
userinfo.token.claim: true
|
||||||
|
user.attribute: "entryUUID"
|
||||||
|
id.token.claim: true
|
||||||
|
access.token.claim: true
|
||||||
|
claim.name: "opendesk_useruuid"
|
||||||
|
jsonType.label: "String"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "offline_access"
|
||||||
|
{{ if .Values.apps.notes.enabled }}
|
||||||
|
- name: "opendesk-notes"
|
||||||
|
clientId: "opendesk-notes"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.notes | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/api/v1.0/callback/"
|
||||||
|
standardFlowEnabled: true
|
||||||
|
implicitFlowEnabled: false
|
||||||
|
alwaysDisplayInConsole: false
|
||||||
|
bearerOnly: false
|
||||||
|
directAccessGrantsEnabled: true
|
||||||
|
serviceAccountsEnabled: false
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
surrogateAuthRequired: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.revoke.offline.tokens: false
|
||||||
|
backchannel.logout.session.required: false
|
||||||
|
client.introspection.response.allow.jwt.claim.enabled: false
|
||||||
|
client.use.lightweight.access.token.enabled: false
|
||||||
|
client_credentials.use_refresh_token: false
|
||||||
|
display.on.consent.screen: false
|
||||||
|
oauth2.device.authorization.grant.enabled: false
|
||||||
|
oidc.ciba.grant.enabled: false
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.notes }}.{{ .Values.global.domain }}/*"
|
||||||
|
require.pushed.authorization.requests: false
|
||||||
|
tls.client.certificate.bound.access.tokens: false
|
||||||
|
token.response.type.bearer.lower-case: false
|
||||||
|
use.jwks.url: false
|
||||||
|
use.refresh.tokens: false
|
||||||
|
# it is probably not even required to set this value explicitly.
|
||||||
|
user.info.response.signature.alg: "RS256"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-notes-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.oxAppSuite.enabled }}
|
||||||
- name: "opendesk-dovecot"
|
- name: "opendesk-dovecot"
|
||||||
clientId: "opendesk-dovecot"
|
clientId: "opendesk-dovecot"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -388,6 +598,28 @@ config:
|
|||||||
backchannel.logout.session.required: false
|
backchannel.logout.session.required: false
|
||||||
defaultClientScopes:
|
defaultClientScopes:
|
||||||
- "opendesk-dovecot-scope"
|
- "opendesk-dovecot-scope"
|
||||||
|
- name: "opendesk-oxappsuite"
|
||||||
|
clientId: "opendesk-oxappsuite"
|
||||||
|
protocol: "openid-connect"
|
||||||
|
clientAuthenticatorType: "client-secret"
|
||||||
|
secret: {{ .Values.secrets.keycloak.clientSecret.as8oidc | quote }}
|
||||||
|
redirectUris:
|
||||||
|
- "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*"
|
||||||
|
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
consentRequired: false
|
||||||
|
frontchannelLogout: false
|
||||||
|
publicClient: false
|
||||||
|
authorizationServicesEnabled: false
|
||||||
|
attributes:
|
||||||
|
backchannel.logout.session.required: true
|
||||||
|
backchannel.logout.url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/ajax/oidc/backchannel_logout"
|
||||||
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
|
defaultClientScopes:
|
||||||
|
- "opendesk-oxappsuite-scope"
|
||||||
|
- "read_contacts"
|
||||||
|
- "write_contacts"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.jitsi.enabled }}
|
||||||
- name: "opendesk-jitsi"
|
- name: "opendesk-jitsi"
|
||||||
clientId: "opendesk-jitsi"
|
clientId: "opendesk-jitsi"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -401,6 +633,8 @@ config:
|
|||||||
authorizationServicesEnabled: false
|
authorizationServicesEnabled: false
|
||||||
defaultClientScopes:
|
defaultClientScopes:
|
||||||
- "opendesk-jitsi-scope"
|
- "opendesk-jitsi-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.element.enabled }}
|
||||||
- name: "opendesk-matrix"
|
- name: "opendesk-matrix"
|
||||||
clientId: "opendesk-matrix"
|
clientId: "opendesk-matrix"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -423,6 +657,8 @@ config:
|
|||||||
post.logout.redirect.uris: "https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
defaultClientScopes:
|
defaultClientScopes:
|
||||||
- "opendesk-matrix-scope"
|
- "opendesk-matrix-scope"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.nextcloud.enabled }}
|
||||||
- name: "opendesk-nextcloud"
|
- name: "opendesk-nextcloud"
|
||||||
clientId: "opendesk-nextcloud"
|
clientId: "opendesk-nextcloud"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -443,6 +679,8 @@ config:
|
|||||||
- "opendesk-nextcloud-scope"
|
- "opendesk-nextcloud-scope"
|
||||||
- "read_contacts"
|
- "read_contacts"
|
||||||
- "write_contacts"
|
- "write_contacts"
|
||||||
|
{{ end }}
|
||||||
|
{{ if .Values.apps.openproject.enabled }}
|
||||||
- name: "opendesk-openproject"
|
- name: "opendesk-openproject"
|
||||||
clientId: "opendesk-openproject"
|
clientId: "opendesk-openproject"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -462,26 +700,8 @@ config:
|
|||||||
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openproject }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openproject }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
defaultClientScopes:
|
defaultClientScopes:
|
||||||
- "opendesk-openproject-scope"
|
- "opendesk-openproject-scope"
|
||||||
- name: "opendesk-oxappsuite"
|
{{ end }}
|
||||||
clientId: "opendesk-oxappsuite"
|
{{ if .Values.apps.xwiki.enabled }}
|
||||||
protocol: "openid-connect"
|
|
||||||
clientAuthenticatorType: "client-secret"
|
|
||||||
secret: {{ .Values.secrets.keycloak.clientSecret.as8oidc | quote }}
|
|
||||||
redirectUris:
|
|
||||||
- "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*"
|
|
||||||
- "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
|
||||||
consentRequired: false
|
|
||||||
frontchannelLogout: false
|
|
||||||
publicClient: false
|
|
||||||
authorizationServicesEnabled: false
|
|
||||||
attributes:
|
|
||||||
backchannel.logout.session.required: true
|
|
||||||
backchannel.logout.url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/ajax/oidc/backchannel_logout"
|
|
||||||
post.logout.redirect.uris: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
|
||||||
defaultClientScopes:
|
|
||||||
- "opendesk-oxappsuite-scope"
|
|
||||||
- "read_contacts"
|
|
||||||
- "write_contacts"
|
|
||||||
- name: "opendesk-xwiki"
|
- name: "opendesk-xwiki"
|
||||||
clientId: "opendesk-xwiki"
|
clientId: "opendesk-xwiki"
|
||||||
protocol: "openid-connect"
|
protocol: "openid-connect"
|
||||||
@@ -500,6 +720,7 @@ config:
|
|||||||
post.logout.redirect.uris: "https://{{ .Values.global.hosts.xwiki }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
post.logout.redirect.uris: "https://{{ .Values.global.hosts.xwiki }}.{{ .Values.global.domain }}/*##https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/*"
|
||||||
defaultClientScopes:
|
defaultClientScopes:
|
||||||
- "opendesk-xwiki-scope"
|
- "opendesk-xwiki-scope"
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
containerSecurityContext:
|
containerSecurityContext:
|
||||||
allowPrivilegeEscalation: false
|
allowPrivilegeEscalation: false
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
# SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
repositories:
|
repositories:
|
||||||
@@ -7,37 +7,49 @@ repositories:
|
|||||||
- name: "dovecot-repo"
|
- name: "dovecot-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.dovecot.verify }}
|
verify: {{ .Values.charts.dovecot.verify }}
|
||||||
|
oci: true
|
||||||
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
|
password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .Values.global.helmRegistry | default .Values.charts.dovecot.registry }}/{{ .Values.charts.dovecot.repository }}"
|
||||||
|
{{- else }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.dovecot.registry }}/{{ .Values.charts.dovecot.repository }}"
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.dovecot.registry }}/{{ .Values.charts.dovecot.repository }}"
|
{{- end }}
|
||||||
|
|
||||||
# Open-Xchange
|
# Open-Xchange
|
||||||
- name: "open-xchange-repo"
|
- name: "open-xchange-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/open-xchange-com.gpg"
|
keyring: "../../files/gpg-pubkeys/open-xchange-com.gpg"
|
||||||
verify: {{ .Values.charts.openXchangeAppSuite.verify }}
|
verify: {{ .Values.charts.oxAppSuite.verify }}
|
||||||
|
oci: true
|
||||||
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
|
username: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
|
password: {{ env "OD_ENTERPRISE_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDeEnterprise .Values.global.helmRegistry | default .Values.charts.oxAppSuite.registry }}/{{ .Values.charts.oxAppSuite.repository }}"
|
||||||
|
{{- else }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.oxAppSuite.registry }}/{{ .Values.charts.oxAppSuite.repository }}"
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.openXchangeAppSuite.registry }}/{{ .Values.charts.openXchangeAppSuite.repository }}"
|
{{- end }}
|
||||||
|
|
||||||
# openDesk Open-Xchange Bootstrap
|
# openDesk Open-Xchange Bootstrap
|
||||||
# Source:
|
# Source:
|
||||||
# https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-open-xchange-bootstrap
|
# https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-open-xchange-bootstrap
|
||||||
- name: "open-xchange-bootstrap-repo"
|
- name: "open-xchange-bootstrap-repo"
|
||||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||||
verify: {{ .Values.charts.openXchangeAppSuiteBootstrap.verify }}
|
verify: {{ .Values.charts.oxAppSuiteBootstrap.verify }}
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.openXchangeAppSuiteBootstrap.registry }}/{{ .Values.charts.openXchangeAppSuiteBootstrap.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.oxAppSuiteBootstrap.registry }}/{{ .Values.charts.oxAppSuiteBootstrap.repository }}"
|
||||||
|
|
||||||
# OX Connector
|
# OX Connector
|
||||||
- name: "ox-connector-repo"
|
- name: "ox-connector-repo"
|
||||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||||
oci: true
|
oci: true
|
||||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.oxConnector.registry }}/{{ .Values.charts.oxConnector.repository }}"
|
url: "{{ coalesce .Values.repositories.helm.registryOpencodeDe .Values.global.helmRegistry | default .Values.charts.oxConnector.registry }}/{{ .Values.charts.oxConnector.repository }}"
|
||||||
|
|
||||||
releases:
|
releases:
|
||||||
- name: "dovecot"
|
- name: "dovecot"
|
||||||
@@ -45,27 +57,39 @@ releases:
|
|||||||
version: "{{ .Values.charts.dovecot.version }}"
|
version: "{{ .Values.charts.dovecot.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-dovecot.yaml.gotmpl"
|
- "values-dovecot.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.dovecot | default "additionalValues: false" }}
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
installed: {{ .Values.dovecot.enabled }}
|
- "values-dovecot-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.dovecot }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.dovecot.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "open-xchange"
|
- name: "open-xchange"
|
||||||
chart: "open-xchange-repo/{{ .Values.charts.openXchangeAppSuite.name }}"
|
chart: "open-xchange-repo/{{ .Values.charts.oxAppSuite.name }}"
|
||||||
version: "{{ .Values.charts.openXchangeAppSuite.version }}"
|
version: "{{ .Values.charts.oxAppSuite.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-openxchange.yaml.gotmpl"
|
- "values-openxchange.yaml.gotmpl"
|
||||||
- "values-openxchange-enterprise-contact-picker.yaml.gotmpl"
|
- "values-openxchange-contact-picker.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.openXchange | default "additionalValues: false" }}
|
{{- if eq (env "OPENDESK_ENTERPRISE") "true" }}
|
||||||
installed: {{ .Values.oxAppsuite.enabled }}
|
- "values-openxchange-enterprise.yaml.gotmpl"
|
||||||
|
{{- end }}
|
||||||
|
{{- range .Values.customization.release.openxchange }}
|
||||||
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.oxAppSuite.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "opendesk-open-xchange-bootstrap"
|
- name: "opendesk-open-xchange-bootstrap"
|
||||||
chart: "open-xchange-bootstrap-repo/{{ .Values.charts.openXchangeAppSuiteBootstrap.name }}"
|
chart: "open-xchange-bootstrap-repo/{{ .Values.charts.oxAppSuiteBootstrap.name }}"
|
||||||
version: "{{ .Values.charts.openXchangeAppSuiteBootstrap.version }}"
|
version: "{{ .Values.charts.oxAppSuiteBootstrap.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-openxchange-bootstrap.yaml.gotmpl"
|
- "values-openxchange-bootstrap.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.opendeskOpenXchangeBootstrap | default "additionalValues: false" }}
|
{{- range .Values.customization.release.opendeskOpenxchangeBootstrap }}
|
||||||
installed: {{ .Values.oxAppsuite.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.oxAppSuite.enabled }}
|
||||||
timeout: 900
|
timeout: 900
|
||||||
|
|
||||||
- name: "ox-connector"
|
- name: "ox-connector"
|
||||||
@@ -73,12 +97,14 @@ releases:
|
|||||||
version: "{{ .Values.charts.oxConnector.version }}"
|
version: "{{ .Values.charts.oxConnector.version }}"
|
||||||
values:
|
values:
|
||||||
- "values-oxconnector.yaml.gotmpl"
|
- "values-oxconnector.yaml.gotmpl"
|
||||||
- {{ .Values.customization.release.oxConnector | default "additionalValues: false" }}
|
{{- range .Values.customization.release.oxConnector }}
|
||||||
installed: {{ .Values.oxAppsuite.enabled }}
|
- {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
installed: {{ .Values.apps.oxAppSuite.enabled }}
|
||||||
needs:
|
needs:
|
||||||
- "open-xchange"
|
- "open-xchange"
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
deploy-stage: "component-1"
|
deployStage: "050-components"
|
||||||
component: "open-xchange"
|
component: "open-xchange"
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
---
|
---
|
||||||
bases:
|
bases:
|
||||||
- "../../bases/environments.yaml"
|
- "../../bases/environments.yaml.gotmpl"
|
||||||
---
|
---
|
||||||
helmfiles:
|
helmfiles:
|
||||||
- path: "./helmfile-child.yaml.gotmpl"
|
- path: "./helmfile-child.yaml.gotmpl"
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
{{/*
|
||||||
|
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/}}
|
||||||
|
---
|
||||||
|
image:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.registryOpencodeDeEnterprise .Values.global.imageRegistry .Values.images.dovecot.registry | quote }}
|
||||||
|
repository: {{ .Values.images.dovecot.repository | quote }}
|
||||||
|
tag: {{ .Values.images.dovecot.tag | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
|
||||||
|
imageInitCassandra:
|
||||||
|
registry: {{ coalesce .Values.repositories.image.dockerHub .Values.global.imageRegistry .Values.images.cassandra.registry | quote }}
|
||||||
|
repository: {{ .Values.images.cassandra.repository | quote }}
|
||||||
|
tag: {{ .Values.images.cassandra.tag | quote }}
|
||||||
|
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||||
|
|
||||||
|
imagePullSecrets:
|
||||||
|
{{ .Values.global.imagePullSecrets | toYaml | nindent 2 }}
|
||||||
|
|
||||||
|
dovecot:
|
||||||
|
dictmap:
|
||||||
|
enabled: true
|
||||||
|
host: {{ .Values.databases.dovecotDictmap.host | quote }}
|
||||||
|
port: {{ .Values.databases.dovecotDictmap.port }}
|
||||||
|
username: {{ .Values.databases.dovecotDictmap.username | quote }}
|
||||||
|
password: {{ .Values.secrets.cassandra.dovecotDictmapUser | quote }}
|
||||||
|
keyspace: {{ .Values.databases.dovecotDictmap.name | quote }}
|
||||||
|
sharedMailboxes:
|
||||||
|
enabled: false
|
||||||
|
host: {{ .Values.databases.dovecotACL.host | quote }}
|
||||||
|
port: {{ .Values.databases.dovecotACL.port }}
|
||||||
|
username: {{ .Values.databases.dovecotACL.username | quote }}
|
||||||
|
password: {{ .Values.secrets.cassandra.dovecotACLUser | quote }}
|
||||||
|
keyspace: {{ .Values.databases.dovecotACL.name | quote }}
|
||||||
|
objectStorage:
|
||||||
|
encryption:
|
||||||
|
privateKey:
|
||||||
|
value: {{ env "DOVECOT_CRYPT_PRIVATE_KEY" | quote }}
|
||||||
|
publicKey:
|
||||||
|
value: {{ env "DOVECOT_CRYPT_PUBLIC_KEY" | quote }}
|
||||||
|
fqdn: {{ .Values.objectstores.dovecot.endpoint | default (printf "%s.%s" .Values.global.hosts.minioApi .Values.global.domain) | quote }}
|
||||||
|
username: {{ .Values.objectstores.dovecot.username | quote }}
|
||||||
|
password: {{ .Values.secrets.minio.dovecotUser | quote }}
|
||||||
|
...
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
{{/*
|
{{/*
|
||||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
SPDX-FileCopyrightText: 2024-2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||||
SPDX-License-Identifier: Apache-2.0
|
SPDX-License-Identifier: Apache-2.0
|
||||||
*/}}
|
*/}}
|
||||||
@@ -17,14 +17,14 @@ dovecot:
|
|||||||
mailDomain: {{ .Values.global.mailDomain | default .Values.global.domain | quote }}
|
mailDomain: {{ .Values.global.mailDomain | default .Values.global.domain | quote }}
|
||||||
password: {{ .Values.secrets.dovecot.doveadm | quote }}
|
password: {{ .Values.secrets.dovecot.doveadm | quote }}
|
||||||
migration:
|
migration:
|
||||||
enabled: {{ .Values.functional.migration.oxAppsuite.enabled }}
|
enabled: {{ .Values.functional.migration.oxAppSuite.enabled }}
|
||||||
masterPassword: {{ .Values.secrets.oxAppsuite.migrationsMasterPassword | quote }}
|
masterPassword: {{ .Values.secrets.oxAppSuite.migrationsMasterPassword | quote }}
|
||||||
ldap:
|
ldap:
|
||||||
enabled: true
|
enabled: true
|
||||||
host: {{ .Values.ldap.host | quote }}
|
host: {{ .Values.ldap.host | quote }}
|
||||||
port: 389
|
port: 389
|
||||||
base: "dc=swp-ldap,dc=internal"
|
base: "{{ .Values.ldap.baseDn }}"
|
||||||
dn: "uid=ldapsearch_dovecot,cn=users,dc=swp-ldap,dc=internal"
|
dn: "uid=ldapsearch_dovecot,cn=users,{{ .Values.ldap.baseDn }}"
|
||||||
password: {{ .Values.secrets.nubus.ldapSearch.dovecot | quote }}
|
password: {{ .Values.secrets.nubus.ldapSearch.dovecot | quote }}
|
||||||
oidc:
|
oidc:
|
||||||
enabled: true
|
enabled: true
|
||||||
@@ -34,11 +34,10 @@ dovecot:
|
|||||||
introspectionPath: "/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token/introspect"
|
introspectionPath: "/realms/{{ .Values.platform.realm }}/protocol/openid-connect/token/introspect"
|
||||||
usernameAttribute: "opendesk_username"
|
usernameAttribute: "opendesk_username"
|
||||||
loginTrustedNetworks: {{ join " " .Values.cluster.networking.cidr | quote }}
|
loginTrustedNetworks: {{ join " " .Values.cluster.networking.cidr | quote }}
|
||||||
|
|
||||||
submission:
|
submission:
|
||||||
enabled: true
|
enabled: true
|
||||||
ssl: "no"
|
ssl: "no"
|
||||||
host: "{{ printf "%s.%s.svc.%s" "postfix" (.Values.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain }}:25"
|
host: "{{ printf "%s.%s.svc.%s" "postfix" (.Values.apps.postfix.namespace | default .Release.Namespace) .Values.cluster.networking.domain }}:25"
|
||||||
|
|
||||||
certificate:
|
certificate:
|
||||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||||
@@ -92,23 +91,23 @@ podSecurityContext:
|
|||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
{{- if .Values.cluster.persistence.readWriteMany.enabled }}
|
{{- if .Values.cluster.persistence.readWriteMany.enabled }}
|
||||||
storageClassName: {{ .Values.persistence.storageClassNames.RWX | quote }}
|
storageClassName: {{ coalesce .Values.persistence.storages.dovecot.storageClassName .Values.persistence.storageClassNames.RWX | quote }}
|
||||||
accessModes:
|
accessModes:
|
||||||
- "ReadWriteMany"
|
- "ReadWriteMany"
|
||||||
{{- else }}
|
{{- else }}
|
||||||
storageClassName: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
storageClassName: {{ coalesce .Values.persistence.storages.dovecot.storageClassName .Values.persistence.storageClassNames.RWO | quote }}
|
||||||
accessModes:
|
accessModes:
|
||||||
- "ReadWriteOnce"
|
- "ReadWriteOnce"
|
||||||
{{- end }}
|
{{- end }}
|
||||||
size: {{ .Values.persistence.size.dovecot | quote }}
|
size: {{ .Values.persistence.storages.dovecot.size | quote }}
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
{{ .Values.resources.dovecot | toYaml | nindent 2 }}
|
{{ .Values.resources.dovecot | toYaml | nindent 2 }}
|
||||||
|
|
||||||
{{- if or (eq .Values.cluster.service.type "NodePort") (eq .Values.cluster.service.type "LoadBalancer") }}
|
{{- if or (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "NodePort") (eq (coalesce .Values.service.type.dovecot .Values.cluster.service.type) "LoadBalancer") }}
|
||||||
service:
|
service:
|
||||||
external:
|
external:
|
||||||
enabled: true
|
enabled: true
|
||||||
type: {{ .Values.cluster.service.type | quote }}
|
type: {{ coalesce .Values.service.type.dovecot .Values.cluster.service.type | quote }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ appsuite:
|
|||||||
auth:
|
auth:
|
||||||
type: "adminDN"
|
type: "adminDN"
|
||||||
adminDN:
|
adminDN:
|
||||||
dn: "uid=ldapsearch_ox,cn=users,dc=swp-ldap,dc=internal"
|
dn: "uid=ldapsearch_ox,cn=users,{{ .Values.ldap.baseDn }}"
|
||||||
password: {{ .Values.secrets.nubus.ldapSearch.ox | quote }}
|
password: {{ .Values.secrets.nubus.ldapSearch.ox | quote }}
|
||||||
|
|
||||||
uiSettings:
|
uiSettings:
|
||||||