Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants | AgentRules.org

Rules Stacks Clients Auditor Pruner Self-Heal RFCs Benchmark CLI CI/CD Authors Submit

This specification is maintained by the AgentRules Working Group. Have enhancements or want to claim maintainership?Submit Specification →

devopscritical PriorityID: k8s-gateway-api-v1-canary-standard

Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants

Enforces strict conformance to Kubernetes Gateway API v1 specifications during migration from legacy Ingress controllers. Mandates explicit ReferenceGrant resources for cross-namespace routing, strict relative integer weighting for HTTPRoute canary releases, and explicit backendRef port declarations.

Prohibited Anti-Pattern: Cross-Namespace Ingress without ReferenceGrants and Unvalidated Canary Backend Splits

Export Ready-to-Drop Configuration

Select format below to copy code or download file directly.

---
description: Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants - Enforces strict conformance to Kubernetes Gateway API v1 specifications during migration from legacy Ingress controllers. Mandates explicit ReferenceGrant resources for cross-namespace routing, strict relative integer weighting for HTTPRoute canary releases, and explicit backendRef port declarations.
globs: k8s/**/*.yaml, deploy/**/*.yaml, helm/**/*.yaml, manifests/**/*.yaml
alwaysApply: true
verified_by: "agentrules.org"
license: "CC-BY-4.0"
source: "https://agentrules.org/rules/k8s-gateway-api-v1-canary-standard"
---

# Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants

> **Severity**: CRITICAL | **Category**: devops
> **Anti-Pattern Warning**: Cross-Namespace Ingress without ReferenceGrants and Unvalidated Canary Backend Splits

## System Constraints
You are a Principal Infrastructure Architect enforcing Kubernetes Gateway API v1 invariants. You prohibit deprecated Ingress annotations (such as nginx.ingress.kubernetes.io/canary), incomplete HTTPRoute configurations, missing ReferenceGrant resources for cross-namespace bindings, and ambiguous canary traffic splits. Ensure all generated manifests adhere strictly to gateway.networking.k8s.io/v1.

## Strict Guidelines
- Engineers MUST ALWAYS declare 'gateway.networking.k8s.io/v1' as the apiVersion for Gateway and HTTPRoute resources.
- Engineers MUST create a 'ReferenceGrant' (gateway.networking.k8s.io/v1beta1) in the target namespace whenever an HTTPRoute references a Service across namespace boundaries.
- Engineers MUST declare an explicit 'port' in every backendRef pointing to a Kubernetes Service.
- Engineers MUST configure explicit integer weights on all canary 'backendRefs' that deterministically sum to 100 for percentage-based rollouts.
- Engineers MUST place deterministic header- or cookie-based HTTPRouteMatch rules prior to fallback weighted canary rules in the rules array.
- Engineers MUST NOT rely on proprietary ingress controller canary annotations (e.g., ingress-nginx, Traefik) when authoring Gateway API manifests.
- Services referenced by backendRefs MUST be validated against the Gateway's allowed listener namespaces.

## Bad vs Good Implementations
### Cross-Namespace HTTPRoute Canary with ReferenceGrant

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Referencing a Service in the 'order-workloads' namespace from an HTTPRoute in 'gateway-infra' without a ReferenceGrant causes route reconciliation failure (ResolvedRefs: False). Furthermore, backendRef requires an explicit port for Service targets, and asymmetric weights without a predictable base complicate canary verification.
```yaml
# Anti-pattern: Missing ReferenceGrant for cross-namespace service, missing backend port, and uncalibrated weights
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: order-service-route
  namespace: gateway-infra
spec:
  parentRefs:
    - name: shared-gateway
  rules:
    - matches:
        - path:
            type: PathPrefix
            value: /orders
      backendRefs:
        - name: order-svc-stable
          namespace: order-workloads # Cross-namespace reference without ReferenceGrant will be silently rejected
          weight: 90
        - name: order-svc-canary
          namespace: order-workloads
          # Missing explicit port declaration on backendRef
          weight: 5 # Weights do not total expected base
```

#### Production Standard (Correct)
> **Standard**: The ReferenceGrant deployed in 'order-workloads' explicitly permits cross-namespace resolution from HTTPRoutes in 'gateway-infra'. The HTTPRoute explicitly defines backend target ports and applies weights strictly summing to 100 for reliable canary routing.
```yaml
# Compliant: Explicit ReferenceGrant and deterministic 90/10 weighted canary with explicit ports
apiVersion: gateway.networking.k8s.io/v1alpha2
kind: ReferenceGrant
metadata:
  name: allow-gateway-to-orders
  namespace: order-workloads
spec:
  from:
    - group: gateway.networking.k8s.io
      kind: HTTPRoute
      namespace: gateway-infra
  to:
    - group: ""
      kind: Service
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: order-service-route
  namespace: gateway-infra
spec:
  parentRefs:
    - name: shared-gateway
      sectionName: https
  rules:
    - matches:
        - path:
            type: PathPrefix
            value: /orders
      backendRefs:
        - name: order-svc-stable
          namespace: order-workloads
          port: 8080
          weight: 90
        - name: order-svc-canary
          namespace: order-workloads
          port: 8080
          weight: 10
```

Recommended MCP Servers (mcp-serverlist.com)

Equip agent with system tools to verify code for this stack.

Kubernetes Cluster Inspector MCP

Inspects live cluster CRDs, validates Gateway API v1 schemas, and checks HTTPRoute ResolvedRefs status conditions.

Recommended Agent Skills (askills.dev)

Ready-to-use executable skill functions tailored to this stack.

Kubeconform Validation CLI

Validates Kubernetes manifests against official Gateway API JSON schemas before commit or deployment.

Architectural Specification & Invariant Rationale

Architectural Invariant Design: Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants

Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants defines an industrial-grade behavioral standard for devops engineering. Enforces strict conformance to Kubernetes Gateway API v1 specifications during migration from legacy Ingress controllers. Mandates explicit ReferenceGrant resources for cross-namespace routing, strict relative integer weighting for HTTPRoute canary releases, and explicit backendRef port declarations. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Cross-Namespace Ingress without ReferenceGrants and Unvalidated Canary Backend Splits Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Cross-Namespace Ingress without ReferenceGrants and Unvalidated Canary Backend Splits	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

1

Engineers MUST ALWAYS declare 'gateway.networking.k8s.io/v1' as the apiVersion for Gateway and HTTPRoute resources.

Engineers MUST ALWAYS declare 'gateway.networking.k8s.io/v1' as the apiVersion for Gateway and HTTPRoute resources.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

2

Engineers MUST create a 'ReferenceGrant' (gateway.networking.k8s.io/v1beta1) in the target namespace whenever an HTTPRoute references a Service across namespace boundaries.

Engineers MUST create a 'ReferenceGrant' (gateway.networking.k8s.io/v1beta1) in the target namespace whenever an HTTPRoute references a Service across namespace boundaries.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

3

Engineers MUST declare an explicit 'port' in every backendRef pointing to a Kubernetes Service.

Engineers MUST declare an explicit 'port' in every backendRef pointing to a Kubernetes Service.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

4

Engineers MUST configure explicit integer weights on all canary 'backendRefs' that deterministically sum to 100 for percentage-based rollouts.

Engineers MUST configure explicit integer weights on all canary 'backendRefs' that deterministically sum to 100 for percentage-based rollouts.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

5

Engineers MUST place deterministic header- or cookie-based HTTPRouteMatch rules prior to fallback weighted canary rules in the rules array.

Engineers MUST place deterministic header- or cookie-based HTTPRouteMatch rules prior to fallback weighted canary rules in the rules array.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

6

Engineers MUST NOT rely on proprietary ingress controller canary annotations (e.g., ingress-nginx, Traefik) when authoring Gateway API manifests.

Engineers MUST NOT rely on proprietary ingress controller canary annotations (e.g., ingress-nginx, Traefik) when authoring Gateway API manifests.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

7

Services referenced by backendRefs MUST be validated against the Gateway's allowed listener namespaces.

Services referenced by backendRefs MUST be validated against the Gateway's allowed listener namespaces.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.

Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.

Technical Questions & Answers

Frequently Asked Technical Questions

Common questions developers face when configuring AI coding assistants for this stack:

Q:Why is Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants critical for AI coding assistants?

Enforces strict conformance to Kubernetes Gateway API v1 specifications during migration from legacy Ingress controllers. Mandates explicit ReferenceGrant resources for cross-namespace routing, strict relative integer weighting for HTTPRoute canary releases, and explicit backendRef port declarations. Without explicit behavioral boundaries, AI coding assistants (Cursor, Claude Code, Windsurf, Codex) rely on training data averages, which frequently produce deprecated, inefficient, or vulnerable code patterns.

Q:How does adopting this rule prevent AI hallucinations?

This rule explicitly declares what the AI must avoid (Cross-Namespace Ingress without ReferenceGrants and Unvalidated Canary Backend Splits) and prescribes verified positive examples. Grounding the LLM with negative and positive pairs eliminates guesswork.

Q:Which AI coding environments are supported?

This specification is multi-platform compatible: Cursor (.cursor/rules/*.mdc & .cursorrules), Anthropic Claude Code (CLAUDE.md), Windsurf (.windsurfrules), Codex / Cline (AGENTS.md), and GitHub Copilot (.github/copilot-instructions.md).

Q:Can I combine this rule with other technology stacks?

Yes. Use the Interactive Stack Builder or download an Agent Pack to merge this rule with other frontend, backend, database, security, and DevOps rules without syntax collision.

Open Specification · CC BY 4.0·Free for Personal, Team & Commercial In-Repo Use

Citation & Open Source Attribution Guidelines

This specification is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You are completely free to adapt and share this rule in your workspace. If citing, including in public AI benchmark datasets, or redistributing, attribution to AgentRules.org is required.

Related DEVOPS Rules

View all rules →

ArgoCD ApplicationSet Matrix Generator Invariants & Cascade Deletion Guards

Enforces strict structural constraints on ArgoCD ApplicationSet Matrix generators combining cluster selectors and Git directories. Prevents catastrophic multi-cluster cascade pruning, accidental secret exposure through parameter interpolation, and runaway Application CR explosion via explicit sync policies, preservation finalizers, and parameter validation.

Karpenter Resilient Topology, Interruption Queue, and Consolidation Budget Standard

Enforces deterministic disruption budgets, multi-instance-type diversification, and event-driven SQS interruption queue handling across Karpenter NodePools and EC2NodeClasses. Eliminates cascading eviction loops, instance starvation, and availability downtime during AWS Spot rebalances and underutilized node consolidation.

OpenTelemetry Collector Processor Pipeline Order and Memory Guardrails

Mandates strict ordering and configuration of OpenTelemetry Collector processor pipelines. Enforces memory_limiter as the non-negotiable first processor to prevent process crashes, requires OTTL-driven PII redaction before persistence or sampling, and mandates dedicated pipeline tiers for tail-based sampling.

1 Rule in Stack

Kubernetes