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

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

Closed
shaun-nx opened this issue Aug 23, 2023 · 1 comment · Fixed by #4285
Closed

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

shaun-nx opened this issue Aug 23, 2023 · 1 comment · Fixed by #4285
Assignees
Labels
proposal An issue that proposes a feature request

Comments

@shaun-nx
Copy link
Contributor

shaun-nx commented Aug 23, 2023

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

@shaun-nx shaun-nx added the proposal An issue that proposes a feature request label Aug 23, 2023
@github-actions
Copy link

Hi @shaun-nx thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal An issue that proposes a feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant