Output of helm version : version.BuildInfo{Version:"v3

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Helm sometimes renders unnecessary additional yaml document containing only a comment when templating about helm HOT 2 OPEN

wimnat commented on May 26, 2024

Helm sometimes renders unnecessary additional yaml document containing only a comment when templating

from helm.

Comments (2)

banjoh commented on May 26, 2024

@wimnat looking at https://github.com/envoyproxy/gateway/releases/download/v1.0.1/install.yaml, it seems to contain multiple documents inside one YAML file i.e parts split with ---\n. Some of the documents contain comments starting with # Source: ...

Here is an output after running helm template

#
# Gateway API Experimental channel install
#
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/crds/generated/gateway.envoyproxy.io_envoypatchpolicies.yaml
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
---
# Source: foo/templates/install.yaml
# Source: gateway-helm/templates/certgen-rbac.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: eg-gateway-helm-certgen
  namespace: 'envoy-gateway-system'
  labels:
    helm.sh/chart: gateway-helm-v0.0.0-latest

My suggestion is that helm template should check for the yaml start document line ---\n prior to the comment addition and remove it if it exists so that the comment will always appear in the same document as the manifest it is rendering.

I'm not sure I follow your suggestion here. Specifically, what do you mean by will always appear in the same document as the manifest? The YAML file in question contains multiple documents which helm renders as expected.

from helm.

Recommend Projects