feat(gateway-api): support full ParentRef fields in HTTPRoute

[jmoosdijk]

Updated by @tuunit:

I repurposed the PR to do the following: Refactored the templating so that the whole object .Values.gatewayApi.gatewayRef gets templated toYaml instead of needing to maintain every possible current field of the GatewayAPI specification or future once.

https://gateway-api.sigs.k8s.io/reference/spec/#parentreference

This way we future proof the helm chart and have less maintenance on our side

Original PRs content:

Added the ability to configure what gateway-api listener the HTTPRoute should be attach to.

Description

Introduced the ability to configure gateway-api sectionName in values.yaml, allowing you to bind the HTTPRoute to a specific gateway-api listener (i.e. only a specific https listener).

When not configuring sectionName, the HTTPRoute is attached to all listeners on the specified gateway-api.

Checklist:

• I have bumped the version in the Chart.yaml according to Semantic Versioning.
• I have updated the documentation/CHANGELOG at the bottom of the Chart.yaml
• I have signed off all my commits.
• (Optional) I have updated the Chart.lock for dependency updates
• (Optional) I have implemented helm tests for new feature flags

[pierluigilenoci]

Hey, nice and clean PR! Two minor observations:

1. Changelog link mismatch
In Chart.yaml, the changelog entry points to #391 but this PR is #394. Is that intentional (e.g. referencing an earlier attempt), or should it be updated to point to this PR?

2. Helm test coverage
Would you consider adding a small Helm template test to verify that sectionName is rendered in the HTTPRoute when set, and omitted when left empty? Something along the lines of:

# tests/httproute_test.yaml
- it: should include sectionName when set
  set:
    gatewayApi.enabled: true
    gatewayApi.gatewayRef.name: my-gw
    gatewayApi.gatewayRef.sectionName: https
  asserts:
    - contains:
        path: spec.parentRefs
        content:
          sectionName: https
      any: true

- it: should not include sectionName when empty
  set:
    gatewayApi.enabled: true
    gatewayApi.gatewayRef.name: my-gw
  asserts:
    - notContains:
        path: spec.parentRefs
        content:
          sectionName: ""
      any: true

This would help prevent regressions and is consistent with the testing patterns for similar optional fields. Not a blocker, but a nice-to-have!

[tuunit]

mhhh maybe we should take the opportunity and refactor to support any future option for the parent reference?

so instead of each parameter needing to be part of our chart we should do:

  parentRefs:
  - {{ toYaml .Values.gatewayApi.gatewayRef | nindent 4 | trim }}

https://gateway-api.sigs.k8s.io/reference/spec/#parentreference

[tuunit]

@pierluigilenoci what's your opinion on this? this would mean less maintenance effort on our end for the chart and we would automatically support all reference options

[pierluigilenoci]

Totally agree with you here. Passing the whole gatewayRef through with toYaml would reduce maintenance effort on our side and automatically support any future parentReference fields without needing chart changes every time the Gateway API spec evolves. Much cleaner approach.

[tuunit]

@jmoosdijk thank you for bringing this up but as suggested by me and Pier we decided to take the opportunity to future proof it and instead just template the whole gatewayRef block as one

[jmoosdijk]

@jmoosdijk thank you for bringing this up but as suggested by me and Pier we decided to take the opportunity to future proof it and instead just template the whole gatewayRef block as one

my pleasure, better to future-proof it indeed!