Skip to content

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

Open
@Cavaler

Description

@Cavaler

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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions