diff --git a/README.md b/README.md index 2400c9ff..5f68004f 100644 --- a/README.md +++ b/README.md @@ -5,65 +5,59 @@ SPDX-License-Identifier: Apache-2.0

openDesk Deployment Automation

-openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the "Projektgruppe für -Aufbau ZenDiS" of Germany's Federal Ministry of the Interior. - -It features: -- Fully integrated Identity Management (Univention) -- File storage (Nextcloud) -- Weboffice (Collabora) -- Videoconference (Nordeck w/ Jitsi) -- Chat and Collaboration (Element w/ Nordeck) -- Groupware (OX Appsuite) -- Wiki (XWiki) -- Project Management (OpenProject) -- Notes and Diagrams (Cryptpad) - -openDesk integrates these components and is working towards a seamless user experience. - -While not all components are perfectly shaped for the execution inside containers, one of the project objectives is to -align the applications with the best practises regarding container design and operations. - -This documentation aims to give you all that is needed to set up your own instance of the openDesk. -Basic knowledge of Kubernetes and Devops is required though. - -* [Active development notice](#active-development-notice) -* [Feedback](#feedback) +* [Overview](#overview) +* [Disclaimer](#disclaimer) * [Requirements](#requirements) * [Getting started](#getting-started) * [Advanced customization](#advanced-customization) * [Releases](#releases) * [Components](#components) +* [Feedback](#feedback) * [License](#license) * [Copyright](#copyright) -# Active development notice +# Overview + +openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the "Projektgruppe für +Aufbau ZenDiS" of Germany's Federal Ministry of the Interior. + +openDesk currently features the following functional main components: + +| Function | Functional Component | Component
Version | Upstream Documentation | +| -------------------- | --------------------------- | --------------------- | ----------------- | +| Chat & collaboration | Element ft. Nordeck widgets | [1.11.52](https://github.com/element-hq/element-desktop/blob/develop/CHANGELOG.md#changes-in-11152-2023-12-19) | [For the most recent release](https://element.io/user-guide) | +| Diagram editor | Cryptpad ft. diagrams.net | [5.6.0](https://github.com/cryptpad/cryptpad/releases/tag/5.6.0) | [For the most recent release](https://docs.cryptpad.org/en/) | +| File management | Nextcloud | [28.0.2](https://nextcloud.com/de/changelog/#28-0-2) | [Nextcloud 28](https://docs.nextcloud.com/) | +| Groupware | OX Appsuite | [8.20](https://documentation.open-xchange.com/appsuite/releases/8.20/) | Online documentation available from within the installed application; [Additional resources](https://www.open-xchange.com/resources/oxpedia) | +| Knowledge management | XWiki | [15.10.4](https://www.xwiki.org/xwiki/bin/view/Blog/XWiki15104Released) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) | +| Portal & IAM | Nubus | Product Preview[^1] | [Univention's documentation website](https://docs.software-univention.de/n/en/index.html) | +| Project management | OpenProject | [13.2.1](https://www.openproject.org/docs/release-notes/13-2-1/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) | +| Videoconferencing | Jitsi | [2.0.8922](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_8922) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) | +| Weboffice | Collabora | [23.05.8.4.1](https://www.collaboraoffice.com/collabora-online-23-05-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) | + +While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to +align the applications with best practises regarding container design and operations. + +This documentation aims to give you all that is needed to set up your own instance of the openDesk. + +Basic knowledge of Kubernetes and DevOps processes is required though. + +# Disclaimer + openDesk will face breaking changes in the near future without upgrade paths before [technical release](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) v1.0.0 is reached. While most components support upgrades, major configuration or component changes may occur, therefore we recommend -at the moment always installing from scratch. +from scratch installations for now. -Components that are going to be replaced soon are: -- the Nextcloud community container is going to be replaced by an openDesk specific Nextcloud distroless container and -- Dovecot Community is going to be replaced by a Dovecot container tailored for the needs of the public sector. +In the next months, we not only expect to integrate upstream updates of the functional components to include their +most recent feature and security sets, but also to address operational topics like scalability for the openDesk +platform. -In the next months, we not only expect upstream updates of the functional components within their feature scope, but we -are also going to address operational issues like monitoring and network policies. - -Of course, further development also includes enhancing the documentation. - -# Feedback - -We love to get feedback from you! -Related to the deployment / contents of this repository, -please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues). - -If you want to address other topics, please check the section -["Rückmeldungen und Beteiligung" of the Infos' project OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung). +Of course, further development also includes enhancing the documentation itself. # Requirements @@ -93,16 +87,26 @@ The following release artefacts are provided beside the default source code asse - `chart-index.json`: An overview of all Helm charts used by the release. - `image-index.json`: An overview of all container images used by the release. -⟶ Visit out detailed [Workflow](./docs/workflow.md) docs. +⟶ Visit our detailed [Workflow](./docs/workflow.md) docs. # Components ⟶ Visit our detailed [Component](./docs/components.md) docs. +# Feedback + +We love to get feedback from you! + +Related to the deployment / contents of this repository, +please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues). + +If you want to address other topics, please check the section +["Rückmeldungen und Beteiligung" of the Infos' project OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung). # License This project uses the following license: Apache-2.0 # Copyright -Copyright (C) 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" + +Copyright (C) 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS" diff --git a/docs/getting-started.md b/docs/getting-started.md index 6bfc18e9..b4cb8e9b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -356,17 +356,12 @@ by your specified subdomain. # Replace with your namespace NAMESPACE=your-namespace -# Get credentials from ConfigMap -kubectl -n ${NAMESPACE} get cm ums-stack-data-swp-data -o jsonpath='{.data.dev-test-users\.yaml}' \ - | yq '.properties.username,.properties.password' -# default.user -# 40615..............................e9e2f -# --- -# default.admin -# bdbbb..............................04db6 +# Get ConfigMap with credentials +kubectl -n ${NAMESPACE} get cm ums-stack-data-swp-data -o jsonpath='{.data.dev-test-users\.yaml}'` ``` -Now you can log in with obtained credentials: +Renders you a two part ConfigMap where the `username` and `password` attributes in the `properties` +section provide you with the desired information to login with the two default user roles: | Username | Password | Description | |-----------------|--------------------------------------------|------------------|