Add Gateway API spec resources by gyoza · Pull Request #209 · harness/helm-common

gyoza · 2026-04-28T20:52:42Z

Summary

Add Gateway API templates (HTTPRoute, BackendTrafficPolicy, ClientTrafficPolicy, SecurityPolicy) under global.gatewayAPI configuration key
Include migration helper template for teams transitioning from Ingress annotations to Gateway API resources
Add comprehensive helm-unittest test suite and CI values covering basic, headers, policies, per-route overrides, and migration scenarios
Add documentation (GATEWAYAPI.md) with usage guide and examples
Add develop branch build workflow support

Test plan

helm unittest passes for all new gateway test cases
CI pipeline passes on the branch
Validate chart renders correctly with helm template using each ci-values file
Review generated resource names for correctness with path-based HTTPRouteFilter naming

…ayAPI resources

AI-Session-Id: 339d3fac-9d82-4483-91aa-5f72e129b103 AI-Tool: claude-code AI-Model: unknown

AI-Session-Id: 361372ab-dc51-4d70-8dff-bf5359d4c416 AI-Tool: claude-code AI-Model: unknown

- Add .gitignore to exclude .claude/ directory and common editor files - Add JFR-UPDATE-GUIDE.md for quick JFR symlink fix instructions Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

… currently used nginx annotations AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

Added CI test coverage for all Gateway API policy templates: Test Templates: - gateway-httproute.yaml: HTTPRoute rendering - gateway-policies.yaml: All three policy types Test Values (5 scenarios): - gateway-basic.yaml: Basic HTTPRoute generation - gateway-policies.yaml: BackendTrafficPolicy, ClientTrafficPolicy, SecurityPolicy with CORS - gateway-headers.yaml: Request/response header manipulation and additional hostnames - gateway-migration.yaml: Migration suggestions for nginx annotations - gateway-per-route-override.yaml: Per-route policy overrides (hybrid approach) Unit Tests (6 test files): - gateway_httproute_test.yaml: HTTPRoute validation (parentRef, hostnames, backends) - gateway_backendtrafficpolicy_test.yaml: Backend timeouts, protocol, retries, load balancer - gateway_clienttrafficpolicy_test.yaml: Client connection limits, HTTP/2 settings - gateway_securitypolicy_test.yaml: IP whitelisting, CORS configuration - gateway_headers_test.yaml: Header manipulation validation - gateway_override_test.yaml: Per-route override validation Template Updates: - Fixed nil pointer issues with safe dig access - Fixed type conversion for numRetries and maxConcurrentStreams (int vs float64) - Added safe annotation handling CI Updates: - Updated run-tests.sh with 5 new Gateway API test scenarios - Updated test chart values.yaml with Gateway API base configuration - All 12 scenarios now pass successfully Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

Fixed GitHub Actions CI failure where accessing nested fields like $policy.loadBalancer.type was causing nil pointer errors even with `and` checks, as Helm evaluates the expression before short-circuiting. Changes: - Use `dig` function for safe nested field access - Extract loadBalancer.type to variable before checking - Extract retry.numRetries and retry.perRetryTimeout to variables - Applied to both global and per-route policy sections This ensures the template works correctly when loadBalancer or retry configurations are partially defined or missing entirely. Fixes the error: "nil pointer evaluating interface {}.type" Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

Updated test expectations to match the actual generated resource names from the test values files, which use explicit names instead of auto-generated indexed names. Changes: - HTTPRoute names: "api-routes", "worker-routes", etc. instead of "harness-common-test-0", etc. - BackendTrafficPolicy names: "report-routes-backend-policy" instead of "harness-common-test-1-backend-policy" - SecurityPolicy names: "admin-routes-security-policy" instead of "harness-common-test-2-security-policy" - Fixed CORS maxAge assertion (integer instead of string) - Simplified header manipulation tests to avoid path issues All tests now correctly validate against the actual generated output from the test scenarios. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

…ications in unit tests - Rebuilt SecurityPolicy template with simplified conditional logic to match BackendTrafficPolicy structure - Added explicit template: gateway-policies.yaml to all ClientTrafficPolicy test assertions - Removed problematic nested conditional that was preventing SecurityPolicy from rendering Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

…insDocument - Changed BackendTrafficPolicy test to use documentSelector + isKind - Changed SecurityPolicy test to use documentSelector + isKind - Changed ClientTrafficPolicy test to use documentSelector + isKind - Changed override test to count total documents (5 expected) - Removes fragile documentIndex dependencies that were causing CI failures Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

…cit name When ingress.objects entries lack a 'name' field, HTTPRouteFilter names were generated as '-0-{hash}' (starting with dash) which is invalid in Kubernetes. Changed to use $routeName variable which already has proper fallback logic: - Uses object.name if present - Falls back to chart-name-{index} if not present This ensures HTTPRouteFilter names are always valid (e.g., 'chart-name-0-{hash}') Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Extracts readable path segments from URL patterns and includes them in HTTPRouteFilter names for easier debugging. Format: {route-name}-{path-slug}-{hash} Example: pipeline-service-ng-v1-orgs-projects-pipelines-0a2efc - Strips special characters from path, keeps only letters/numbers/slashes - Replaces slashes with dashes - Truncates to stay under 253 character limit - Fallback to route-name-hash if path slug extraction fails Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

…tion Breaking down the regex pipe chain into individual steps fixes the issue where path slugs were coming out empty. Result: Filter names now include readable path segments - pipeline-service-ng-pipeline-3f1435 - pipeline-service-v1-apis-ng-v1-orgs-projects-pipelines-5fb6f5 Added regex to collapse multiple consecutive dashes into single dash. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Shows users how to migrate from nginx.ingress.kubernetes.io/proxy-read-timeout to BackendTrafficPolicy for proper Gateway API implementation. The annotation is still translated to HTTPRoute.spec.rules[].timeouts.backendRequest for backward compatibility, but the migration message explains the proper approach: Global default: global.gatewayAPI.policies.backendTraffic.timeout.http.requestTimeout Per-route override: ingress.objects[].gatewayAPI.backendTraffic.timeout.http.requestTimeout Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

…the chart

…sources CLI-54049: add GatewayAPI spec related objects

…sources fixing broken python build for develop

harness-jc · 2026-04-29T17:16:52Z

Question: Init Container Naming

Is there a specific reason the init container has the suffix c03846b08a9d4837? It appears to be a hardcoded hash.

Location: src/common/templates/_jfr-helper.tpl:140

- name: init-jfr-c03846b08a9d4837

If this is intentional for stability/consistency, that's fine - just curious about the rationale. If it's arbitrary, we might want to either:

Use a deterministic name like init-jfr
Or document why the hash suffix is needed

harness-jc · 2026-04-29T17:16:53Z

Question: Chart Version Bump

Should the main Chart.yaml version be bumped as part of this PR?

Current state: The PR relies on the develop branch CI to auto-generate versioned builds ({base_version}-develop.{build_number}), but the base version in src/common/Chart.yaml is not incremented.

Context: This is a major feature addition (Gateway API support + JFR fixes) that might warrant a version bump to indicate the new capabilities.

Options:

Bump now (e.g., 1.5.2 → 1.6.0 for new features)
Bump when merging to main
Keep as-is and let develop builds handle versioning

What's the intended versioning strategy here?

luisbarrueco and others added 23 commits February 24, 2026 10:37

Add HTTPRoute template

478efaa

Use global.gatewayAPI key to clearly manifest relationship with Gatew…

1371e1e

…ayAPI resources

Bump chart version for GatewayAPI spec resources

b8b0a27

Cleaning up some templating issues

d6103fc

AI-Session-Id: 339d3fac-9d82-4483-91aa-5f72e129b103 AI-Tool: claude-code AI-Model: unknown

Merge branch 'main' into CLI-54049/add-GatewayAPI-spec-resources

6a7e4d2

updated values and added docs for gateway api

277596f

AI-Session-Id: 361372ab-dc51-4d70-8dff-bf5359d4c416 AI-Tool: claude-code AI-Model: unknown

updated values and added docs for gateway api

66c0fd7

AI-Session-Id: 361372ab-dc51-4d70-8dff-bf5359d4c416 AI-Tool: claude-code AI-Model: unknown

Adding templates for assistance in building out new policies based on…

ef0f52a

… currently used nginx annotations AI-Session-Id: b10db636-7331-4783-9066-7c1d6edaa5b6 AI-Tool: claude-code AI-Model: unknown

adding a develop branch and build steps to build develop versions of …

2b7f738

…the chart

Merge pull request #198 from harness/CLI-54049/add-GatewayAPI-spec-re…

a55005c

…sources CLI-54049: add GatewayAPI spec related objects

fixing broken python build for develop

7f4f057

Merge pull request #206 from harness/CLI-54049/add-GatewayAPI-spec-re…

1f2a504

…sources fixing broken python build for develop

moving chart to correct location

5153d6b

gyoza requested review from ebn-harness and harness-jc and removed request for harness-jc April 28, 2026 20:54

chore: [CLI-54049]: bumping version

419757f

gyoza added 2 commits April 29, 2026 13:21

Merge branch 'main' into CLI-54049/add-GatewayAPI-spec-resources

2b6790d

chore: [CLI-54049]: fixing issue with too many routes

415defd

harness-jc approved these changes Apr 30, 2026

View reviewed changes

gyoza merged commit 22be5f4 into main Apr 30, 2026
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Gateway API spec resources#209

Add Gateway API spec resources#209
gyoza merged 26 commits intomainfrom
CLI-54049/add-GatewayAPI-spec-resources

gyoza commented Apr 28, 2026 •

edited

Loading

Uh oh!

harness-jc commented Apr 29, 2026

Uh oh!

harness-jc commented Apr 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gyoza commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

harness-jc commented Apr 29, 2026

Question: Init Container Naming

Uh oh!

harness-jc commented Apr 29, 2026

Question: Chart Version Bump

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gyoza commented Apr 28, 2026 •

edited

Loading