From eea23d781388c9e8793c082b140a243a4b5e2e7c Mon Sep 17 00:00:00 2001 From: Jennifer Travinski Date: Tue, 5 Oct 2021 18:25:38 -0400 Subject: [PATCH] Updating file naming note --- content/k3s/latest/en/helm/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/k3s/latest/en/helm/_index.md b/content/k3s/latest/en/helm/_index.md index ca301024927..18d074f6ad5 100644 --- a/content/k3s/latest/en/helm/_index.md +++ b/content/k3s/latest/en/helm/_index.md @@ -67,7 +67,7 @@ spec: Content placed in `/var/lib/rancher/k3s/server/static/` can be accessed anonymously via the Kubernetes APIServer from within the cluster. This URL can be templated using the special variable `%{KUBERNETES_API}%` in the `spec.chart` field. For example, the packaged Traefik component loads its chart from `https://%{KUBERNETES_API}%/static/charts/traefik-1.81.0.tgz`. ->**Notice on File Naming Requirements:** `HelmChart`, `HelmChartConfig` and manifest files require adherence to naming conventions to avoid confusion and errors in logs. For example, neither uppercase letters nor underscores should be used in chart names. A filename with underscores will produce errors like the following: +>**Notice on File Naming Requirements:** `HelmChart`, `HelmChartConfig` and manifest files require adherence to naming conventions to avoid confusion and errors in logs. The Helm chart controller uses the filename to create objects. Therefore, if a filename doesn’t align with the validation, that will cause an error installing the chart, even if the chart configuration is correct. For example, underscores, uppercase letters, and dots are not permitted in filenames. The example below is an error generated from using underscores: ``` level=error msg="Failed to process config: failed to process /var/lib/rancher/rke2/server/manifests/rke2_ingress_daemonset.yaml: @@ -78,7 +78,7 @@ start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9] ([-a-z0-9]*[a-z0-9])?)*')" ``` -To learn more about best practices on chart naming conventions, go [here](https://v2-14-0.helm.sh/docs/chart_best_practices/#chart-names). +>**Note:** Despite the error message stating dots can be used, they should not be. Refer [here](https://helm.sh/docs/chart_best_practices/conventions/#chart-names) to learn more about best practices on file naming conventions. ### Customizing Packaged Components with HelmChartConfig