Skip to content

Fix: escape {{}} in CRDs to prevent Helm templating errors #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ljluestc wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix: escape {{}} in CRDs to prevent Helm templating errors #185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 21 additions & 3 deletions pkg/processor/crd/crd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,21 @@ func (c crd) Process(appMeta helmify.AppMetadata, obj *unstructured.Unstructured
return true, nil, fmt.Errorf("%w: unable to cast to crd spec", err)
}

replacements := make(map[string]string)
if spec.Conversion != nil {
conv := spec.Conversion
if conv.Strategy == v1.WebhookConverter {
wh := conv.Webhook
if wh != nil && wh.ClientConfig != nil && wh.ClientConfig.Service != nil {
wh.ClientConfig.Service.Name = appMeta.TemplatedName(wh.ClientConfig.Service.Name)
wh.ClientConfig.Service.Namespace = strings.ReplaceAll(wh.ClientConfig.Service.Namespace, appMeta.Namespace(), `{{ .Release.Namespace }}`)
// Use placeholders starting with '*' to force quoting in YAML
namePlaceholder := "*__HELMIFY_NAME_PLACEHOLDER__"
nsPlaceholder := "*__HELMIFY_NS_PLACEHOLDER__"

replacements[namePlaceholder] = appMeta.TemplatedName(wh.ClientConfig.Service.Name)
wh.ClientConfig.Service.Name = namePlaceholder

replacements[nsPlaceholder] = strings.ReplaceAll(wh.ClientConfig.Service.Namespace, appMeta.Namespace(), `{{ .Release.Namespace }}`)
wh.ClientConfig.Service.Namespace = nsPlaceholder
}
}
}
Expand All @@ -126,7 +134,17 @@ func (c crd) Process(appMeta helmify.AppMetadata, obj *unstructured.Unstructured
specYaml = yamlformat.Indent(specYaml, 2)
specYaml = bytes.TrimRight(specYaml, "\n ")

res := fmt.Sprintf(crdTeml, obj.GetName(), appMeta.ChartName(), annotations, labels, string(specYaml))
specStr := string(specYaml)
// Escape {{ and }} to {{ "{{" }} and {{ "}}" }} to prevent Helm from interpreting them
replacer := strings.NewReplacer("{{", `{{ "{{" }}`, "}}", `{{ "}}" }}`)
specStr = replacer.Replace(specStr)

// Restore placeholders with actual Helm templates
for k, v := range replacements {
specStr = strings.ReplaceAll(specStr, k, v)
}

res := fmt.Sprintf(crdTeml, obj.GetName(), appMeta.ChartName(), annotations, labels, specStr)
res = strings.ReplaceAll(res, "\n\n", "\n")

return true, &result{
Expand Down