mirror of
https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git
synced 2025-12-07 16:01:37 +01:00
feat(helm): Template support for XWiki external secrets
Signed-off-by: Axel Lender <lender@b1-systems.de>
This commit is contained in:
38
docs/external-secrets.md
Normal file
38
docs/external-secrets.md
Normal file
@@ -0,0 +1,38 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>External Secrets</h1>
|
||||
|
||||
This document covers how to utilise external secrets and special requirements.
|
||||
|
||||
<!-- TOC -->
|
||||
* [General](#general)
|
||||
* [Components](#components)
|
||||
* [XWiki](#xwiki)
|
||||
<!-- TOC -->
|
||||
|
||||
# General
|
||||
|
||||
For most components when set the external secret will supersede e.g. a password in a `values.yaml` file.
|
||||
|
||||
The file [`external_secrets.yaml`](/helmfile/environments/default/external_secrets.yaml.gotmpl) lists all possible references to external secrets that are currently implemented in openDesk.
|
||||
|
||||
# Components
|
||||
|
||||
This section covers information and special requirements to external secrets that some Helm Charts expect.
|
||||
|
||||
## XWiki
|
||||
|
||||
Properties listed in the file of the external secret will overwrite plain values.
|
||||
|
||||
Like described in the [upstream `values.yaml`](https://github.com/xwiki-contrib/xwiki-helm/blob/master/charts/xwiki/values.yaml#L435) credentials and information about a user in external secrets listed in `propertiesSecret` have to be formatted as follows:
|
||||
|
||||
```yaml
|
||||
stringData:
|
||||
propertiesFile: |
|
||||
propertie1=propertie1Value
|
||||
propertie2=propertie2Value
|
||||
propertie3=propertie3Value
|
||||
```
|
||||
Reference in New Issue
Block a user