From ac560b471e5bc33c30a1a72c32feb2497460dc29 Mon Sep 17 00:00:00 2001 From: Bernd Schorgers Date: Tue, 20 May 2025 07:46:28 +0200 Subject: [PATCH] docs(app-template): Add some clarifcations --- docs/app-template/upgrade-instructions.md | 9 +++++++-- docs/common-library/resources/names.md | 4 ++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/app-template/upgrade-instructions.md b/docs/app-template/upgrade-instructions.md index 28a06ca7..7e226bb0 100644 --- a/docs/app-template/upgrade-instructions.md +++ b/docs/app-template/upgrade-instructions.md @@ -6,12 +6,14 @@ Migrating from v3.x to v4.x introduces a number of breaking changes. Additionall #### Resource names -The second breaking change is the new and consistent resource naming scheme. See [here](../common-library/resources/names.md) for more information on how the new naming scheme works. +A new and consistent resource naming scheme has been implemented throughout the chart. + +!!! info + See **[here](../common-library/resources/names.md)** for more information on how the new naming scheme works. This change may lead to generated resources getting new names, causing resources with the old naming scheme to be removed. !!! warning - **IMPORTANT** As with any major software version upgrade, please verify that you have a working backup of your data. #### serviceAccounts @@ -44,6 +46,9 @@ controllers: The hardcoded `app.kubernetes.io/component` label that is used to target specific controllers has been renamed to `app.kubernetes.io/controller`. +!!! info + Because controller labels are considered is an immutable field, this means existing Deployments / StatefulSets / etc will have to be recreated. + ## From 2.x.x to 3.0.x The main changes from v2.x to v3.x are the removal of the default `main` objects and the introduction of JSON schema validation. diff --git a/docs/common-library/resources/names.md b/docs/common-library/resources/names.md index 360c3e01..b8de38c2 100644 --- a/docs/common-library/resources/names.md +++ b/docs/common-library/resources/names.md @@ -23,6 +23,10 @@ Suffix to append to the resource name. Defaults to the resource identifier if th ### Behavior + +!!! info + All resource names are based on the `bjw-s.common.lib.chart.names.fullname` template. This defaults to the Helm Release name, but can be further controlled by the `global.nameOverride` and `global.fullnameOverride` values. The identifier only comes in to play when there are multiple resources of the same kind. + Assuming a Helm Release with the name `base_name`, the following table gives an overview of how the resource name is generated: | item key | enabled items | `prefix` | `suffix` | `forceRename` | Generated name |