From d9a31da787a45be4499998f653e22ccd949411ef Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Tue, 30 Jun 2026 21:25:29 +0000 Subject: [PATCH] docs: correct chart name validation rules (DNS-1123 subdomain) helm lint now validates chart names via chartutil.ValidateMetadataName, which permits dots and allows up to 253 characters (DNS-1123 subdomain), not the DNS-1123 label rules (no dots, 63 chars) previously documented. Ref: helm/helm#32278 Signed-off-by: promptless[bot] --- docs/chart_best_practices/conventions.md | 15 ++++++++++----- .../version-3/chart_best_practices/conventions.md | 15 ++++++++++----- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/chart_best_practices/conventions.md b/docs/chart_best_practices/conventions.md index b8e7501e0..9da20b8e9 100644 --- a/docs/chart_best_practices/conventions.md +++ b/docs/chart_best_practices/conventions.md @@ -8,9 +8,12 @@ This part of the Best Practices Guide explains general conventions. ## Chart Names -Chart names must follow DNS-1123 label conventions: only lowercase letters, -numbers, and dashes are allowed, names must start and end with a lowercase -letter or number, and names cannot exceed 63 characters: +Chart names are used as a prefix for the resources a chart creates, so they must +be valid Kubernetes resource names. Names must follow DNS-1123 subdomain +conventions: only lowercase letters, numbers, dashes, and dots are allowed; +names must start and end with a lowercase letter or number; each dot-separated +segment must also start and end with a lowercase letter or number; and names +cannot exceed 253 characters: Examples: @@ -18,15 +21,17 @@ Examples: drupal nginx-lego aws-cluster-autoscaler +my.chart ``` Invalid chart names include: - Names with uppercase letters (e.g., `MyChart`) - Names with underscores (e.g., `my_chart`) -- Names with dots (e.g., `my.chart`) +- Names with spaces (e.g., `my chart`) - Names starting with a dash (e.g., `-mychart`) - Names ending with a dash (e.g., `mychart-`) -- Names longer than 63 characters +- Names containing path separators (e.g., `../mychart`) +- Names longer than 253 characters The `helm lint` command validates chart names against these rules. diff --git a/versioned_docs/version-3/chart_best_practices/conventions.md b/versioned_docs/version-3/chart_best_practices/conventions.md index b8e7501e0..9da20b8e9 100644 --- a/versioned_docs/version-3/chart_best_practices/conventions.md +++ b/versioned_docs/version-3/chart_best_practices/conventions.md @@ -8,9 +8,12 @@ This part of the Best Practices Guide explains general conventions. ## Chart Names -Chart names must follow DNS-1123 label conventions: only lowercase letters, -numbers, and dashes are allowed, names must start and end with a lowercase -letter or number, and names cannot exceed 63 characters: +Chart names are used as a prefix for the resources a chart creates, so they must +be valid Kubernetes resource names. Names must follow DNS-1123 subdomain +conventions: only lowercase letters, numbers, dashes, and dots are allowed; +names must start and end with a lowercase letter or number; each dot-separated +segment must also start and end with a lowercase letter or number; and names +cannot exceed 253 characters: Examples: @@ -18,15 +21,17 @@ Examples: drupal nginx-lego aws-cluster-autoscaler +my.chart ``` Invalid chart names include: - Names with uppercase letters (e.g., `MyChart`) - Names with underscores (e.g., `my_chart`) -- Names with dots (e.g., `my.chart`) +- Names with spaces (e.g., `my chart`) - Names starting with a dash (e.g., `-mychart`) - Names ending with a dash (e.g., `mychart-`) -- Names longer than 63 characters +- Names containing path separators (e.g., `../mychart`) +- Names longer than 253 characters The `helm lint` command validates chart names against these rules.