Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/v3/README_de.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,13 @@ Die Dokumentation wird Entwickler:innen von einem minimalen lauffähigen Dogu zu

## Verfügbare Konzepte

- [Dogu-V3-Artefakte verstehen](concepts/artifacts_de.md)
- [Die Multinode-Laufzeitumgebung verstehen](concepts/multinode-environment_de.md)

## Verfügbare Referenz

- [Kompendium der Dogu-V3-Artefakte](reference/compendium_de.md)

## Inhaltliche Abgrenzung

- **Erste Schritte** enthalten ausführbare, durchgängige Anleitungen. Der Quickstart behandelt nur den kleinsten lauffähigen Happy Path.
Expand Down
20 changes: 20 additions & 0 deletions docs/v3/best-practices/helm-chart_de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Best Practices für Dogu-Helm-Charts

Dieses Dokument beschreibt die Best-Practices, die es bei der Erstellung von Dogu-Helm-Charts zu beachten gilt.

## Vorsicht beim Umbenennen von Kubernetes-Ressourcen

Eine Änderung von `metadata.name` erzeugt ein anderes Kubernetes-Objekt. Die Auswirkungen hängen von Ressourcenart und Controller ab: Referenzen können ungültig werden, ein Controller kann neue Credentials ausstellen und zustandsbehaftete Ressourcen können getrennt oder verwaist werden. Aus einer Umbenennung folgt nicht automatisch, dass Kubernetes die zugrunde liegenden Daten löscht. Tritt eine oder mehrere der oben genannte Punkte ein, kann dies zu einer erheblichen Betriebsstörung führen.

Prüfen Sie vor einer Namensänderung diese Beziehungen:

| Beziehung | Typisches Risiko |
| --- | --- |
| PVC- und Claim-Referenzen | Ein Workload startet nicht, wenn der referenzierte Claim fehlt. Ein neuer Claim kann an einen anderen Speicher gebunden werden; ob das bisherige Volume und der zugrunde liegende Speicher nach dem Löschen des alten Claims erhalten bleiben, hängt von der Reclaim Policy des PersistentVolume ab. |
| Service, Clients und Selektoren | Clients und `Exposition`-Ressourcen können weiterhin den alten Service referenzieren; geänderte Selektoren können außerdem dazu führen, dass ein Service keine Endpoints mehr besitzt. |
| Exposition-Ziel | Externer Zugriff kann auf einen nicht mehr vorhandenen Service oder Port zeigen. |
| ServiceAccountRequest und verwaltetes Secret | Ein neuer Request kann Credentials neu erzeugen, während die Anwendung noch das alte Secret erwartet. |
| Andere Integrationsressourcen | Authentifizierungs- oder Menüintegration kann dupliziert, ersetzt oder getrennt werden. |
| Backup und Aufbewahrung | Prüfen Sie Selektionslabels sowie Restore- und Aufbewahrungsverhalten der betroffenen Ressource. |

Behandeln Sie die Umbenennung zustandsbehafteter oder extern referenzierter Ressourcen als **Migration**: Aktualisieren Sie alle Referenzen, prüfen Sie Backup- und Aufbewahrungsverhalten und entfernen Sie das alte Objekt erst, nachdem der neue Pfad validiert wurde.
20 changes: 20 additions & 0 deletions docs/v3/best-practices/helm-chart_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Best Practices for Dogu-Helm-Charts

This document describes the best practices to follow when creating Dogu Helm charts.

## Take care when renaming Kubernetes resources

Changing `metadata.name` creates a different Kubernetes object. The impact depends on the resource and its controller: references can break, a controller can issue new credentials, and stateful resources can become disconnected or orphaned. A rename does not by itself mean that Kubernetes deletes the underlying data. If one or more of the above-mentioned issues occur, this can lead to a significant operational disruption.

Before changing a name, check these relationships:

| Relationship | Typical risk |
| --- | --- |
| PVC and claim references | A workload fails to start if the referenced claim does not exist. A new claim can bind different storage; whether the previous volume and its underlying storage remain after the old claim is deleted depends on the PersistentVolume reclaim policy. |
| Service, clients and selectors | Clients and `Exposition` resources can continue to reference the old Service; selector changes can also leave a Service without endpoints. |
| Exposition target | External access can point to a Service or port that no longer exists. |
| ServiceAccountRequest and managed Secret | A new request can regenerate credentials while the application still expects the old Secret. |
| Other integration resources | Authentication or menu integration can be duplicated, replaced or disconnected. |
| Backup and retention | Verify selection labels and restore or retention behavior for the affected resource. |

Treat renames of stateful or externally referenced resources as **migrations**: update every reference, verify backup and retention behavior, and retire the old object only after the new path has been validated.
Loading