docs(misc): Streamline sentence heading

This commit is contained in:
Thorsten Roßner
2025-08-11 12:24:39 +02:00
parent bbbcd6807e
commit d249448794
5 changed files with 76 additions and 76 deletions

View File

@@ -15,27 +15,27 @@ SPDX-License-Identifier: Apache-2.0
* [Keycloak Extensions](#keycloak-extensions) * [Keycloak Extensions](#keycloak-extensions)
* [OpenLDAP](#openldap) * [OpenLDAP](#openldap)
* [Authorization](#authorization) * [Authorization](#authorization)
* [LDAP Group Synchronization](#ldap-group-synchronization) * [LDAP group synchronization](#ldap-group-synchronization)
* [Provisioning](#provisioning) * [Provisioning](#provisioning)
* [OX Connector](#ox-connector) * [OX Connector](#ox-connector)
* [SCIM](#scim) * [SCIM](#scim)
* [Component integration](#component-integration) * [Component integration](#component-integration)
* [Intercom Service / Silent Login](#intercom-service--silent-login) * [Intercom Service / Silent login](#intercom-service--silent-login)
* [Central Contacts](#central-contacts) * [Central contacts](#central-contacts)
* [Central Navigation](#central-navigation) * [Central navigation](#central-navigation)
* [Filepicker](#filepicker) * [Filepicker](#filepicker)
* [Newsfeed](#newsfeed) * [Newsfeed](#newsfeed)
* [(OpenProject) File Store](#openproject-file-store) * [(OpenProject) File store](#openproject-file-store)
* [Applications vs. Services](#applications-vs-services) * [Applications vs. services](#applications-vs-services)
* [Collabora (Office)](#collabora-office) * [Collabora (weboffice)](#collabora-weboffice)
* [CryptPad Online (Diagrams)](#cryptpad-online-diagrams) * [CryptPad Online (diagrams)](#cryptpad-online-diagrams)
* [Element/Synapse (Chat \& Call)](#elementsynapse-chat--call) * [Element/Synapse (chat \& call)](#elementsynapse-chat--call)
* [Jitsi (Video Conferencing)](#jitsi-video-conferencing) * [Jitsi (video conferencing)](#jitsi-video-conferencing)
* [Nextcloud (Files)](#nextcloud-files) * [Nextcloud (files)](#nextcloud-files)
* [Nubus (Identity and Access Management / Portal)](#nubus-identity-and-access-management--portal) * [Nubus (identity and access management / portal)](#nubus-identity-and-access-management--portal)
* [OpenProject (Project management)](#openproject-project-management) * [OpenProject (project management)](#openproject-project-management)
* [OX App Suite (Groupware) with OX Dovecot (Mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend) * [OX App Suite (groupware) with OX Dovecot (mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend)
* [XWiki (Knowledge management)](#xwiki-knowledge-management) * [XWiki (knowledge management)](#xwiki-knowledge-management)
* [Application specific user accounts](#application-specific-user-accounts) * [Application specific user accounts](#application-specific-user-accounts)
* [Footnotes](#footnotes) * [Footnotes](#footnotes)
<!-- TOC --> <!-- TOC -->
@@ -210,7 +210,7 @@ To address these use cases, the Keycloak Extensions act as a proxy to Keycloak.
# Authorization # Authorization
## LDAP Group Synchronization ## LDAP group synchronization
LDAP group synchronization ensures that user group memberships are consistent across the applications in openDesk that make use of the IAM group information. Nubus uses OpenLDAP to store and manage user groups, which are synchronized with integrated applications to enforce access control policies. LDAP group synchronization ensures that user group memberships are consistent across the applications in openDesk that make use of the IAM group information. Nubus uses OpenLDAP to store and manage user groups, which are synchronized with integrated applications to enforce access control policies.
@@ -273,7 +273,7 @@ flowchart TD
Details can be found in the upstream documentation that is linked in the respective sections. Details can be found in the upstream documentation that is linked in the respective sections.
## Intercom Service / Silent Login ## Intercom Service / Silent login
The Intercom Service is deployed in the context of Nubus. Its role is to enable cross-application integration The Intercom Service is deployed in the context of Nubus. Its role is to enable cross-application integration
based on the user's browser interaction, as handling authentication when the frontend of an application has to call based on the user's browser interaction, as handling authentication when the frontend of an application has to call
@@ -286,7 +286,7 @@ Currently, only OX AppSuite and Element are using the frontend-based integration
**Links:** **Links:**
- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html). - [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
## Central Contacts ## Central contacts
OX App Suite is responsible for managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to OX App Suite is responsible for managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to
- create a new contact in the user's contacts folder when a file is shared with an unknown email address. - create a new contact in the user's contacts folder when a file is shared with an unknown email address.
@@ -296,7 +296,7 @@ OX App Suite is responsible for managing contacts in openDesk. Therefore, Nextcl
- Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts). - Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts).
- New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to. - New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to.
## Central Navigation ## Central navigation
Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for
a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation. a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation.
@@ -338,7 +338,7 @@ service through the Intercom Service's `/wiki` endpoint, in combination with the
**Links:** **Links:**
- [XWiki Blog feature](https://extensions.xwiki.org/xwiki/bin/view/Extension/Blog%20Application) - [XWiki Blog feature](https://extensions.xwiki.org/xwiki/bin/view/Extension/Blog%20Application)
## (OpenProject) File Store ## (OpenProject) File store
While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are
stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package. stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package.
@@ -351,7 +351,7 @@ The file store must still be enabled per project in OpenProject's project admin
- [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/) - [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/)
- [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject) - [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject)
# Applications vs. Services # Applications vs. services
openDesk consists of a variety of open-source projects, please find an overview below: openDesk consists of a variety of open-source projects, please find an overview below:
@@ -366,16 +366,16 @@ openDesk consists of a variety of open-source projects, please find an overview
| Element | Secure communications platform | Application | | Element | Secure communications platform | Application |
| Jitsi | Videoconferencing | Application | | Jitsi | Videoconferencing | Application |
| MariaDB | Database | Service | | MariaDB | Database | Service |
| Memcached | Cache Database | Service | | Memcached | Cache database | Service |
| MinIO | Object Storage | Service | | MinIO | Object storage | Service |
| Nextcloud | File share | Application | | Nextcloud | File share | Application |
| Nubus (UMS) | Identity Management & Portal | Application | | Nubus (UMS) | Identity management & portal | Application |
| OpenProject | Project management | Application | | OpenProject | Project management | Application |
| OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application | | OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application |
| Postfix | MTA | Service | | Postfix | MTA | Service |
| PostgreSQL | Database | Service | | PostgreSQL | Database | Service |
| Redis | Cache Database | Service | | Redis | Cache database | Service |
| XWiki | Knowledge Management | Application | | XWiki | Knowledge management | Application |
The end user focussed components are called applications and provide the functional scope of openDesk, please find separate paragraphs on each of the applications below. The end user focussed components are called applications and provide the functional scope of openDesk, please find separate paragraphs on each of the applications below.
@@ -383,25 +383,25 @@ Other components are of type "Service", these are used for development and evalu
For the APIs / Protocols supported by the applications, please read the [apis.md](./docs/architecture/apis.md). For the APIs / Protocols supported by the applications, please read the [apis.md](./docs/architecture/apis.md).
## Collabora (Office) ## Collabora (weboffice)
[Collabora](https://www.collaboraonline.com) is a powerful online document editing suite. [Collabora](https://www.collaboraonline.com) is a powerful online document editing suite.
In openDesk, Collabora is used for editing Office documents such as rich texts, spreadsheets and presentations. In openDesk, Collabora is used for editing Office documents such as rich texts, spreadsheets and presentations.
## CryptPad Online (Diagrams) ## CryptPad Online (diagrams)
[CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption. [CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption.
In openDesk, CryptPad is for editing diagrams.net documents. In openDesk, CryptPad is for editing diagrams.net documents.
## Element/Synapse (Chat & Call) ## Element/Synapse (chat & call)
[Element Web](https://github.com/element-hq/element-web) is the web frontend for [Synapse](https://github.com/element-hq/synapse), the reference implementation of the sovereign and secure [Matrix protocol](https://matrix.org). [Element Web](https://github.com/element-hq/element-web) is the web frontend for [Synapse](https://github.com/element-hq/synapse), the reference implementation of the sovereign and secure [Matrix protocol](https://matrix.org).
In openDesk, Element is used for chat and direct audio & video calling. In openDesk, Element is used for chat and direct audio & video calling.
## Jitsi (Video Conferencing) ## Jitsi (video conferencing)
[Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings. [Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings.
@@ -409,27 +409,27 @@ In openDesk, Jitsi is used for video conferencing and online meetings. It integr
[Jigasi](https://github.com/jitsi/jigasi) (Jitsi's SIP component) also allows joining the meeting via phone call if an external SIP server and SIP trunk are provided. [Jigasi](https://github.com/jitsi/jigasi) (Jitsi's SIP component) also allows joining the meeting via phone call if an external SIP server and SIP trunk are provided.
## Nextcloud (Files) ## Nextcloud (files)
[Nextcloud](https://nextcloud.com) is a file storage and sync platform with powerful collaboration capabilities with desktop, mobile and web interfaces. [Nextcloud](https://nextcloud.com) is a file storage and sync platform with powerful collaboration capabilities with desktop, mobile and web interfaces.
## Nubus (Identity and Access Management / Portal) ## Nubus (identity and access management / portal)
[Nubus](https://www.univention.com/products/nubus/) is a unified Identity & Access Management, providing you with full control and digital sovereignty over your IAM processes and data. [Nubus](https://www.univention.com/products/nubus/) is a unified Identity & Access Management, providing you with full control and digital sovereignty over your IAM processes and data.
In openDesk, Nubus provides the management required for users, groups and other IAM objects, as well as the portal, the Identity provider for Single Sign-On and federation scenarios. In openDesk, Nubus provides the management required for users, groups and other IAM objects, as well as the portal, the Identity provider for Single Sign-On and federation scenarios.
## OpenProject (Project management) ## OpenProject (project management)
[OpenProject](https://www.openproject.org) is a project management tool that supports agile project management, team collaboration, issue tracking, and more. [OpenProject](https://www.openproject.org) is a project management tool that supports agile project management, team collaboration, issue tracking, and more.
## OX App Suite (Groupware) with OX Dovecot (Mail backend) ## OX App Suite (groupware) with OX Dovecot (mail backend)
[OX App Suite](https://www.open-xchange.com/products/ox-app-suite) is a groupware application using [OX Dovecot](https://www.dovecot.org/) as its backend mail store. [OX App Suite](https://www.open-xchange.com/products/ox-app-suite) is a groupware application using [OX Dovecot](https://www.dovecot.org/) as its backend mail store.
In openDesk, OX App Suite is used for email, calendar, address book and personal task management. In openDesk, OX App Suite is used for email, calendar, address book and personal task management.
## XWiki (Knowledge management) ## XWiki (knowledge management)
[XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration. [XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration.

View File

@@ -9,7 +9,7 @@ SPDX-License-Identifier: Apache-2.0
* [Software bill of materials (SBOMs)](#software-bill-of-materials-sboms) * [Software bill of materials (SBOMs)](#software-bill-of-materials-sboms)
* [Artifact SBOMs](#artifact-sboms) * [Artifact SBOMs](#artifact-sboms)
* [Source code SBOMs](#source-code-sboms) * [Source code SBOMs](#source-code-sboms)
* [License Compliance](#license-compliance) * [License compliance](#license-compliance)
* [Software supply chain security](#software-supply-chain-security) * [Software supply chain security](#software-supply-chain-security)
* [Container architectural basics](#container-architectural-basics) * [Container architectural basics](#container-architectural-basics)
* [Security](#security) * [Security](#security)
@@ -25,7 +25,7 @@ SPDX-License-Identifier: Apache-2.0
* [Top bar](#top-bar) * [Top bar](#top-bar)
* [Look and feel](#look-and-feel) * [Look and feel](#look-and-feel)
* [Central navigation](#central-navigation) * [Central navigation](#central-navigation)
* [Functional Administration](#functional-administration) * [Functional administration](#functional-administration)
* [Theming](#theming) * [Theming](#theming)
* [Central user profile](#central-user-profile) * [Central user profile](#central-user-profile)
* [Footnotes](#footnotes) * [Footnotes](#footnotes)
@@ -60,7 +60,7 @@ Today's software development platforms like GitLab or GitHub provide dependency
**Reference:** Currently we do not have source code SBOMs in place. **Reference:** Currently we do not have source code SBOMs in place.
# License Compliance # License compliance
All parts of openDesk Community Edition must be open source with source code (also) published or at least publishable on openCode. All parts of openDesk Community Edition must be open source with source code (also) published or at least publishable on openCode.
@@ -243,7 +243,7 @@ When implementing the central navigation into an application there are two optio
**Reference:** This is available in current deployments in all applications except for Jitsi, Collabora, and CryptPad. **Reference:** This is available in current deployments in all applications except for Jitsi, Collabora, and CryptPad.
## Functional Administration ## Functional administration
While applications usually support technical and functional administration the technical part should be in the responsibility of the operator and is usually done at (re)deployment time. Therefore the administrative tasks within an application should be limited to functional administration. While applications usually support technical and functional administration the technical part should be in the responsibility of the operator and is usually done at (re)deployment time. Therefore the administrative tasks within an application should be limited to functional administration.

View File

@@ -20,7 +20,7 @@ openDesk uses role-based access control (RBAC) to manage permissions. This syste
* [Administrative access to applications](#administrative-access-to-applications) * [Administrative access to applications](#administrative-access-to-applications)
* [Custom groups](#custom-groups) * [Custom groups](#custom-groups)
* [Assigning roles/groups and permissions](#assigning-rolesgroups-and-permissions) * [Assigning roles/groups and permissions](#assigning-rolesgroups-and-permissions)
* [Predefined roles / user templates](#predefined-roles--user-templates) * [Predefined roles/user templates](#predefined-rolesuser-templates)
* [*openDesk User*](#opendesk-user) * [*openDesk User*](#opendesk-user)
* [*openDesk Administrator*](#opendesk-administrator) * [*openDesk Administrator*](#opendesk-administrator)
* [Managing permissions](#managing-permissions) * [Managing permissions](#managing-permissions)
@@ -30,7 +30,7 @@ openDesk uses role-based access control (RBAC) to manage permissions. This syste
* [Delegation](#delegation) * [Delegation](#delegation)
* [Regular review](#regular-review) * [Regular review](#regular-review)
* [Applications](#applications) * [Applications](#applications)
* [Roles/groups](#rolesgroups) * [Roles/Groups](#rolesgroups)
<!-- TOC --> <!-- TOC -->
# Identity and Access Management (IAM) # Identity and Access Management (IAM)
@@ -126,7 +126,7 @@ While openDesk ships with predefined groups, additional groups can be [created](
Users get roles assigned based on their responsibilities and the tasks they need to perform. This assignment can be done by an admin through the [administration portal](https://docs.opendesk.eu/administration/). Users get roles assigned based on their responsibilities and the tasks they need to perform. This assignment can be done by an admin through the [administration portal](https://docs.opendesk.eu/administration/).
## Predefined roles / user templates ## Predefined roles/user templates
openDesk defines [templates](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/65-usertemplate.yaml) for the *User* and *Administrator* roles. The templates can be used by an *openDesk Administrator* to create users with these roles using the [administration portal](https://docs.opendesk.eu/administration/). openDesk defines [templates](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-nubus/-/blob/main/udm/udm-data-loader/65-usertemplate.yaml) for the *User* and *Administrator* roles. The templates can be used by an *openDesk Administrator* to create users with these roles using the [administration portal](https://docs.opendesk.eu/administration/).
@@ -191,7 +191,7 @@ While the overall role and permission setup must be checked by the customer, inc
Managing all application permissions within the IAM would require a superset of permissions to be available in the IAM. This would lead to a high level of administrative complexity. Instead, the application specific permissions are usually managed within an application itself and mapped to roles/groups that are managed in the IAM. Managing all application permissions within the IAM would require a superset of permissions to be available in the IAM. This would lead to a high level of administrative complexity. Instead, the application specific permissions are usually managed within an application itself and mapped to roles/groups that are managed in the IAM.
## Roles/groups ## Roles/Groups
Within IAM groups, the visibility of openDesk applications can be configured. Like with users, this is done in the "openDesk" tab of the [group administration](https://docs.opendesk.eu/administration/gruppen/). Within IAM groups, the visibility of openDesk applications can be configured. Like with users, this is done in the "openDesk" tab of the [group administration](https://docs.opendesk.eu/administration/gruppen/).

View File

@@ -3,30 +3,30 @@ SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlic
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
--> -->
<h1>Release Management</h1> <h1>Release management</h1>
This document outlines the release and patch management strategy for **openDesk**, ensuring that all updates, patches, and new releases are systematically **planned, tested, documented**, and **reliably deployed** into production. The process is designed to align with operational planning requirements and maintain system stability and security. This document outlines the release and patch management strategy for **openDesk**, ensuring that all updates, patches, and new releases are systematically **planned, tested, documented**, and **reliably deployed** into production. The process is designed to align with operational planning requirements and maintain system stability and security.
<!-- TOC --> <!-- TOC -->
* [Release Cycle](#release-cycle) * [Release cycle](#release-cycle)
* [Release Types](#release-types) * [Release types](#release-types)
* [Release Schedule](#release-schedule) * [Release schedule](#release-schedule)
* [Upgrades](#upgrades) * [Upgrades](#upgrades)
* [Patch Management Process](#application-administration) * [Patch management process](#patch-management-process)
* [Patch Identification & Prioritization](#patch-identification-prioritization) * [Patch identification \& prioritization](#patch-identification--prioritization)
* [Patch Workflow](#patch-workflow) * [Patch workflow](#patch-workflow)
* [Communication Plan](#communication-plan) * [Communication plan](#communication-plan)
* [Announcement Channels](#announcement-channels) * [Announcement channels](#announcement-channels)
* [Timing of Communications](#timing-of-communications) * [Timing of communications](#timing-of-communications)
* [Documentation Requirements](#documentation-requirements) * [Documentation requirements](#documentation-requirements)
* [Compliance & Review](#compliance-review) * [Compliance \& review](#compliance--review)
<!-- TOC --> <!-- TOC -->
# Release Cycle # Release cycle
openDesk follows a structured release cycle to ensure predictability and reliability: openDesk follows a structured release cycle to ensure predictability and reliability:
## Release Types ## Release types
| Type | Frequency | Content | | Type | Frequency | Content |
|----------------|---------------|---------------------------------------------------------------| |----------------|---------------|---------------------------------------------------------------|
@@ -36,7 +36,7 @@ openDesk follows a structured release cycle to ensure predictability and reliabi
> **Note:** openDesk does **not** guarantee that minor releases are 100% backwardcompatible. When a breaking change is unavoidable it is announced in the release notes under a dedicated header **“Breaking Changes”** and a migration guide is provided. > **Note:** openDesk does **not** guarantee that minor releases are 100% backwardcompatible. When a breaking change is unavoidable it is announced in the release notes under a dedicated header **“Breaking Changes”** and a migration guide is provided.
## Release Schedule ## Release schedule
- **Major releases** are scheduled for **Q3 each year**, with planning beginning in Q1. - **Major releases** are scheduled for **Q3 each year**, with planning beginning in Q1.
- **Minor releases** occur **monthly on Mondays**, typically **around 10:00 AM** local time. - **Minor releases** occur **monthly on Mondays**, typically **around 10:00 AM** local time.
@@ -54,11 +54,11 @@ openDesk follows a structured release cycle to ensure predictability and reliabi
- All breaking changes, including those in monthly minor releases, are highlighted in the release notes under Breaking Changes. - All breaking changes, including those in monthly minor releases, are highlighted in the release notes under Breaking Changes.
- Additional, nonbinding migration hints are collected in `migrations.md` - Additional, nonbinding migration hints are collected in `migrations.md`
# Patch Management Process # Patch management process
A standardized process ensures patches are developed, prioritized, and deployed efficiently. A standardized process ensures patches are developed, prioritized, and deployed efficiently.
## Patch Identification & Prioritization ## Patch identification & prioritization
Patches are categorized by severity and urgency: Patches are categorized by severity and urgency:
@@ -69,7 +69,7 @@ Patches are categorized by severity and urgency:
| **Medium** | Functional bugs with workarounds, minor usability issues | | **Medium** | Functional bugs with workarounds, minor usability issues |
| **Low** | Cosmetic issues, documentation updates | | **Low** | Cosmetic issues, documentation updates |
## Patch Workflow ## Patch workflow
The following steps define the patch workflow from issue identification to post-deployment review. This process ensures consistent quality and minimal disruption to users: The following steps define the patch workflow from issue identification to post-deployment review. This process ensures consistent quality and minimal disruption to users:
@@ -83,18 +83,18 @@ The following steps define the patch workflow from issue identification to post-
This workflow ensures that patches are handled with the same level of discipline as planned releases, supporting both reliability and agility. This workflow ensures that patches are handled with the same level of discipline as planned releases, supporting both reliability and agility.
# Communication Plan # Communication plan
A lightweight approach reduces manual effort while maintaining transparency. A lightweight approach reduces manual effort while maintaining transparency.
## Announcement Channels ## Announcement channels
| Channel | Audience | Purpose | Owner | | Channel | Audience | Purpose | Owner |
|---------|----------|---------|-------| |---------|----------|---------|-------|
| **openCode Changelog** | Community & EE | Primary source of truth for every release | DevOps | | **openCode Changelog** | Community & EE | Primary source of truth for every release | DevOps |
| **AccountManager Mail / Ticket** | Enterprise customers | Targeted information & upgrade advice | Customer Success | | **AccountManager Mail / Ticket** | Enterprise customers | Targeted information & upgrade advice | Customer Success |
## Timing of Communications ## Timing of communications
| Release Type | What | When | | Release Type | What | When |
|--------------|------|------| |--------------|------|------|
@@ -107,7 +107,7 @@ A lightweight approach reduces manual effort while maintaining transparency.
Community users consume information via openCode; Enterprise customers get an additional nudge via their account manager  **no mass mailings are sent manually**. Community users consume information via openCode; Enterprise customers get an additional nudge via their account manager  **no mass mailings are sent manually**.
# Documentation Requirements # Documentation requirements
Each release (major, minor, or patch) must include: Each release (major, minor, or patch) must include:
@@ -116,7 +116,7 @@ Each release (major, minor, or patch) must include:
- **Test reports** confirming QA coverage and results - **Test reports** confirming QA coverage and results
- **Deployment checklist** reviewed and approved by the product owner - **Deployment checklist** reviewed and approved by the product owner
# Compliance & Review # Compliance & review
- The release process is reviewed **bi-annually** to incorporate feedback and evolving requirements - The release process is reviewed **bi-annually** to incorporate feedback and evolving requirements
- Emergency patches (e.g., zero-day security issues) may bypass the standard schedule but must be documented post-deployment - Emergency patches (e.g., zero-day security issues) may bypass the standard schedule but must be documented post-deployment

View File

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