mirror of
https://github.com/helmfile/helmfile.git
synced 2026-09-30 07:08:38 +02:00
yxxhero
afdb2487a6
* feat: add `inherits:` for sub-helmfile config inheritance
Add an opt-in `inherits:` field to `helmfiles:` entries so a sub-helmfile
can inherit specific configuration categories from its parent:
helmfiles:
- path: myapp.yaml
inherits: [repositories, environments]
Allowed values: repositories, helmDefaults, commonLabels, apiVersions,
kubeVersion, templates, environments. Child values win; parent fills gaps
(consistent with `bases:`). This directly fixes #1495, where a repository
declared in the parent was unavailable to sub-helmfiles, producing a
confusing "repo not found" error.
Implementation notes:
- The 6 pure fields (repositories, helmDefaults, commonLabels, apiVersions,
kubeVersion, templates) are merged post-load via MergeInherited; verified
all are consumed post-load (ExecuteTemplates/converge), never at parse.
- environments is injected pre-load as ctxEnv, because RenderedValues is
baked at load time; the parent's resolved values become the base and the
child's own environments: block overrides per key.
- helmDefaults uses a *HelmSpec pointer (value type is non-comparable) with
a no-override mergo merge, so a child that omits helmDefaults inherits the
parent's fully.
- A footgun warning (WarnUninheritedRepos) suggests
`inherits: [repositories]` when a release references a repo the parent
declares but the child lacks.
- Unknown inherits keys are rejected at parse time with the allowed set.
Inheritance is opt-in and fully backward compatible: empty (the default)
preserves the historical independent-sub-helmfile behavior.
Fixes #1495
Signed-off-by: yxxhero <aiopsclub@163.com>
* fix: address review — deep-copy inherited config and fix bases: doc link
- BuildInheritedConfig now deep-copies the pure fields via a YAML round-trip
(Env via environment.DeepCopy) so the returned config never aliases the
parent state's slices/maps, matching its doc comment. Now returns an error
to surface round-trip failures; the call site in processNestedHelmfiles is
updated. Added TestBuildInheritedConfig_PureFieldsAreDeepCopied to lock
in the no-aliasing guarantee.
- Fix the broken `bases:` anchor (#) in shared-configuration-across-teams.md
to point to writing-helmfile.md#layering-state-files.
Signed-off-by: yxxhero <aiopsclub@163.com>
* fix: address review — reject inherits without path and document helmDefaults caveat
Signed-off-by: yxxhero <aiopsclub@163.com>
* fix: address review — make AllowedInherits immutable and clarify effective-repo wording
Signed-off-by: yxxhero <aiopsclub@163.com>
---------
Signed-off-by: yxxhero <aiopsclub@163.com>
67 lines
3.2 KiB
Bash
67 lines
3.2 KiB
Bash
inherits_input_dir="${cases_dir}/inherits-subhelmfile/input"
|
|
inherits_output_tmp=$(mktemp -d)
|
|
|
|
# Run `helmfile template` on an input file; assert it succeeds and that the
|
|
# rendered output contains the given pattern.
|
|
expect_template_ok() {
|
|
local desc="$1" file="$2" pattern="$3"
|
|
info "${desc}"
|
|
code=0
|
|
${helmfile} -f ${inherits_input_dir}/${file} template &> ${inherits_output_tmp}/out.log || code=$?
|
|
if [ ${code} -ne 0 ]; then
|
|
cat ${inherits_output_tmp}/out.log
|
|
fail "${desc}: template should have succeeded, exit=${code}"
|
|
fi
|
|
grep -q "${pattern}" ${inherits_output_tmp}/out.log || { cat ${inherits_output_tmp}/out.log; fail "${desc}: expected '${pattern}' in output"; }
|
|
info "${desc}: OK"
|
|
}
|
|
|
|
# --- Scenario 1: repositories (the issue #1495 regression) -------------------
|
|
# Uses the remote incubator/raw chart so that real repository registration is
|
|
# exercised — the one thing only an integration test can cover.
|
|
test_start "inherits: repositories (issue #1495)"
|
|
${helm} repo remove incubator 2>/dev/null || true
|
|
expect_template_ok \
|
|
"sub-helmfile resolves chart via repository inherited from parent" \
|
|
"helmfile-inherits.yaml" \
|
|
"kind: ConfigMap"
|
|
test_pass "inherits: repositories (issue #1495)"
|
|
|
|
# --- Scenario 2: environments (resolved values flow to the sub-helmfile) -----
|
|
# Uses the local raw chart (no repository needed) to isolate environments
|
|
# inheritance. The parent's resolved value must appear in the rendered output.
|
|
test_start "inherits: environments"
|
|
expect_template_ok \
|
|
"sub-helmfile renders the parent's resolved environment value" \
|
|
"helmfile-env.yaml" \
|
|
"from-parent-env"
|
|
test_pass "inherits: environments"
|
|
|
|
# --- Scenario 3: transitive inheritance (parent -> child -> grandchild) ------
|
|
# The env value is inherited across two hops and must reach the grandchild's
|
|
# rendered output. Also uses the local raw chart.
|
|
test_start "inherits: transitive (parent -> child -> grandchild)"
|
|
expect_template_ok \
|
|
"grandchild renders value transitively inherited across two levels" \
|
|
"helmfile-transitive.yaml" \
|
|
"from-parent-env"
|
|
test_pass "inherits: transitive (parent -> child -> grandchild)"
|
|
|
|
# --- Scenario 4: validation (unknown key rejected at parse time) -------------
|
|
test_start "inherits: rejects unknown key at parse time"
|
|
info "Expecting parse error for unknown inherits key"
|
|
code=0
|
|
${helmfile} -f ${inherits_input_dir}/helmfile-bad-key.yaml template &> ${inherits_output_tmp}/bad.log || code=$?
|
|
if [ ${code} -eq 0 ]; then
|
|
cat ${inherits_output_tmp}/bad.log
|
|
fail "template should have failed for an unknown inherits key, but exited 0"
|
|
fi
|
|
grep -q "invalid inherits entry" ${inherits_output_tmp}/bad.log || { cat ${inherits_output_tmp}/bad.log; fail "expected 'invalid inherits entry' in the error"; }
|
|
grep -q "bogusKey" ${inherits_output_tmp}/bad.log || { cat ${inherits_output_tmp}/bad.log; fail "expected the offending key 'bogusKey' in the error"; }
|
|
info "unknown key rejected as expected (exit=${code})"
|
|
test_pass "inherits: rejects unknown key at parse time"
|
|
|
|
# Cleanup so the registered repo does not leak into subsequent tests.
|
|
${helm} repo remove incubator 2>/dev/null || true
|
|
rm -rf ${inherits_output_tmp}
|