Skip to content
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.

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

[Feat]: Documenting values not explicitly present in values.yaml file #225

Open
Cavaler opened this issue Apr 23, 2024 · 0 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@Cavaler
Copy link

Cavaler commented Apr 23, 2024

I am looking for a way to document some Helm chart values which are not actually written down in the values.yaml.

Here is a piece of the current values.yaml:

# -- One and only one should be configured
input: 
  # -- TCP connection
  tcp: {}
  # -- UDP connection
  udp: {}
  # -- Serial connection
  serial: {}

If for example input.tcp is not empty, then it is used as an input - with expected fields like host and port inside.
But I cannot document those fields now, since I have to include them in the map.

I'd like to be able to write something like this:

# -- One and only one should be configured
input: 
  # input.tcp.host -- (string) TCP host
  # input.tcp.port -- (int) TCP port
  tcp: {}

But currently these comments are just ignored.

@Cavaler Cavaler added the enhancement New feature or request label Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants