Usage advice: quote app.ini section headers in values.yml if they contain a dot #516

Open
opened 2023-09-22 15:30:26 +00:00 by pat-s · 3 comments
pat-s commented 2023-09-22 15:30:26 +00:00 (Migrated from gitea.com)

See discussion at https://github.com/go-gitea/gitea/issues/26838.

All section headers in values.yml under gitea.config that contain a dot should be written as

"section.header":
  key1: value1

Without the quotes, helm will split the section name into two parts consistent of "section" and "header" whereas they should appear "as is" in app.ini, i.e. "section.header".

See discussion at https://github.com/go-gitea/gitea/issues/26838. All section headers in `values.yml` under `gitea.config` that contain a dot should be written as ```yml "section.header": key1: value1 ``` Without the quotes, helm will split the section name into two parts consistent of "section" and "header" whereas they should appear "as is" in `app.ini`, i.e. `"section.header"`.
justusbunsi commented 2023-09-22 15:46:24 +00:00 (Migrated from gitea.com)

🤔 It's documented how to pass settings containing a . in our Helm Chart (general information: https://gitea.com/gitea/helm-chart#configuration, cross references for ConfigMaps and Secrets: https://gitea.com/gitea/helm-chart#additional-_appini_-settings).

I understand the intention of the GitHub issue, like the idea and understand the limits. Should we extend our documentation by that quoting hint?

🤔 It's documented how to pass settings containing a `.` in our Helm Chart (general information: https://gitea.com/gitea/helm-chart#configuration, cross references for ConfigMaps and Secrets: https://gitea.com/gitea/helm-chart#additional-\_appini\_-settings). I understand the intention of the GitHub issue, like the idea and understand the limits. Should we extend our documentation by that quoting hint?
pat-s commented 2023-09-22 16:07:31 +00:00 (Migrated from gitea.com)

I understand the intention of the GitHub issue, like the idea and understand the limits. Should we extend our documentation by that quoting hint?

More is always better I'd say :) I just wanted to give it a bit more visibility with the issue and pin as many users will probably overlook it in our super long README :)

> I understand the intention of the GitHub issue, like the idea and understand the limits. Should we extend our documentation by that quoting hint? More is always better I'd say :) I just wanted to give it a bit more visibility with the issue and pin as many users will probably overlook it in our super long README :)
justusbunsi commented 2023-09-22 16:15:35 +00:00 (Migrated from gitea.com)

Without the quotes, helm will split the section name into two parts consistent of "section" and "header"

How did you get Helm to split the settings during processing? Did you pass the setting via --set CLI parameter? I never encountered that issue in the past.

> Without the quotes, helm will split the section name into two parts consistent of "section" and "header" How did you get Helm to split the settings during processing? Did you pass the setting via `--set` CLI parameter? I never encountered that issue in the past.
Sign in to join this conversation.
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lunny/helm-chart#516
No description provided.