Skip to content

Update example spec comment for GlobalConfiguration in helm values.yaml #4284

@shaun-nx

Description

@shaun-nx

Is your feature request related to a problem? Please describe.
This request updates the example listener block for GlobalConfiguration in the helm/values.yaml file to make it more clear on how to add listeners to the GlobalConfiguration resource. the controller.globalConfiguration.spec block requires the listeners to be added in JSON format. The current example comment does not make that as clear to the user.

Describe the solution you'd like
Snippet of current yaml with example listener block:

controller:
  globalConfiguration:
    ## Creates the GlobalConfiguration custom resource. Requires controller.enableCustomResources.
    create: false

    ## The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller.
    spec: {}
      # listeners:
      # - name: dns-udp
      #   port: 5353
      #   protocol: UDP
      # - name: dns-tcp
      #   port: 5353
      #   protocol: TCP

Snippet of suggested yaml with update listener block comment:

controller:
  globalConfiguration:
    ## Creates the GlobalConfiguration custom resource. Requires controller.enableCustomResources.
    create: false

    ## The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller.
    spec: {
    # "listeners": [
    #   {
    #     "name": "dns-udp",
    #     "port": 5353,
    #     "protocol": "UDP"
    #   },
    #   {
    #     "name": "dns-tcp",
    #     "port": 5353,
    #     "protocol": "TCP"
    #   }
    # ]
    }

UPDATE:
Given that the spec field for controller.globalConfiguration was appended with curly brackets {} I had assumed that this field only worked with JSON notation. However if the curly brackets {} are removed we can use YAML notation instead. The only catch is that the curly braces {} need to be there if the spec is being omitted.

controller:
  globalConfiguration:
    ## Creates the GlobalConfiguration custom resource. Requires controller.enableCustomResources.
    create: false

    ## The spec of the GlobalConfiguration for defining the global configuration parameters of the Ingress Controller.
    spec:
      listeners:
      - name: dns-udp
        port: 5353
        protocol: UDP
      - name: dns-tcp
        port: 5353
        protocol: TCP

Describe alternatives you've considered
N/A

Additional context
N/A

Metadata

Metadata

Assignees

Labels

proposalAn issue that proposes a feature request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions