Skip to content

fix: in helm chart fix indentation in nginx gateway config template handling - #18167

Merged
JStickler merged 3 commits into
grafana:mainfrom
Malted-AI:fix/helm-custom-nginx-config-render-error
Jul 8, 2025
Merged

fix: in helm chart fix indentation in nginx gateway config template handling#18167
JStickler merged 3 commits into
grafana:mainfrom
Malted-AI:fix/helm-custom-nginx-config-render-error

Conversation

@JimCroftMaltedAI

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

This PR fixes the indentation of the nginx config in configmap-gateway.yaml so that it works with both the default nginx gateway config (defined as loki.nginxFile in _helpers.tpl) and any user supplied configs supplied via the helm value gateway.nginxConfig.file.

The current code's handling of indentation means any user supplied gateway.nginxConfig.file is not indented correctly resulting in a helm error:

error converting YAML to JSON: yaml: line 13: did not find expected comment or line break

Which issue(s) this PR fixes:

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR
@JimCroftMaltedAI
JimCroftMaltedAI requested a review from a team as a code owner June 19, 2025 13:57
@CLAassistant

CLAassistant commented Jun 19, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@jkroepke

Copy link
Copy Markdown
Contributor

LGTM

@Jayclifford345 Jayclifford345 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Jayclifford345

Copy link
Copy Markdown
Contributor

Hey @JimCroftMaltedAI,
Looks like there might be a confict on the branch which I don't have permission to resolve for you. Would you mind taking a look and I can get this merged?

@JimCroftMaltedAI

Copy link
Copy Markdown
Contributor Author

Hi @Jayclifford345 , that's done.

@JStickler
JStickler merged commit 4fe20a7 into grafana:main Jul 8, 2025
74 checks passed
@JimCroftMaltedAI
JimCroftMaltedAI deleted the fix/helm-custom-nginx-config-render-error branch July 9, 2025 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment