Traefik & Kubernetes with Gateway API

The Kubernetes Gateway API, The Experimental Way.

Gateway API is the evolution of Kubernetes APIs that relate to Services, such as Ingress. The Gateway API project is part of Kubernetes, working under SIG-NETWORK.

The Kubernetes Gateway provider is a Traefik implementation of the Gateway API specifications from the Kubernetes Special Interest Groups (SIGs).

This provider is proposed as an experimental feature and partially supports the Gateway API v0.4.0 specification.

Enabling The Experimental Kubernetes Gateway Provider

Since this provider is still experimental, it needs to be activated in the experimental section of the static configuration.

File (YAML)

  1. experimental:
  2.   kubernetesGateway: true
  4. providers:
  5.   kubernetesGateway: {}
  6.   #...

File (TOML)

  1. [experimental]
  2.   kubernetesGateway = true
  4. [providers.kubernetesGateway]
  5. #...

CLI

  1. --experimental.kubernetesgateway=true --providers.kubernetesgateway=true #...

Configuration Requirements

All Steps for a Successful Deployment

  • Add/update the Kubernetes Gateway API definitions.
  • Add/update the RBAC for the Traefik custom resources.
  • Add all needed Kubernetes Gateway API resources.

Examples

Kubernetes Gateway Provider Basic Example

Gateway API

  1. ---
  2. apiVersion: gateway.networking.k8s.io/v1alpha2
  3. kind: GatewayClass
  4. metadata:
  5.   name: my-gateway-class
  7. spec:
  8.   controllerName: traefik.io/gateway-controller
  10. ---
  11. apiVersion: gateway.networking.k8s.io/v1alpha2
  12. kind: Gateway
  13. metadata:
  14.   name: my-gateway
  16. spec:
  17.   gatewayClassName: my-gateway-class
  18.   listeners:
  19.     - name: https
  20.       protocol: HTTPS
  21.       port: 443
  22.       tls:
  23.         certificateRefs:
  24.           - kind: Secret
  25.             name: mysecret
  27. ---
  28. apiVersion: gateway.networking.k8s.io/v1alpha2
  29. kind: HTTPRoute
  30. metadata:
  31.   name: http-app
  32.   namespace: default
  34. spec:
  35.   parentRefs:
  36.     - name: my-gateway
  38.   hostnames:
  39.     - whoami
  41.   rules:
  42.     - matches:
  43.         - path:
  44.             type: Exact
  45.             value: /foo
  47.       backendRefs:
  48.         - name: whoami
  49.           port: 80
  50.           weight: 1

Whoami Service

  1. ---
  2. apiVersion: apps/v1
  3. kind: Deployment
  4. metadata:
  5.   name: whoami
  7. spec:
  8.   replicas: 2
  9.   selector:
  10.     matchLabels:
  11.       app: whoami
  13.   template:
  14.     metadata:
  15.       labels:
  16.         app: whoami
  18.     spec:
  19.       containers:
  20.         - name: whoami
  21.           image: traefik/whoami
  23. ---
  24. apiVersion: v1
  25. kind: Service
  26. metadata:
  27.   name: whoami
  29. spec:
  30.   selector:
  31.     app: whoami
  33.   ports:
  34.     - protocol: TCP
  35.       port: 80

Traefik Service

  1. ---
  2. apiVersion: v1
  3. kind: ServiceAccount
  4. metadata:
  5.   name: traefik-controller
  7. ---
  8. apiVersion: apps/v1
  9. kind: Deployment
  10. metadata:
  11.   name: traefik
  13. spec:
  14.   replicas: 1
  15.   selector:
  16.     matchLabels:
  17.       app: traefik-lb
  19.   template:
  20.     metadata:
  21.       labels:
  22.         app: traefik-lb
  24.     spec:
  25.       serviceAccountName: traefik-controller
  26.       containers:
  27.         - name: traefik
  28.           image: traefik:v2.8
  29.           args:
  30.             - --entrypoints.web.address=:80
  31.             - --entrypoints.websecure.address=:443
  32.             - --experimental.kubernetesgateway
  33.             - --providers.kubernetesgateway
  35.           ports:
  36.             - name: web
  37.               containerPort: 80
  39.             - name: websecure
  40.               containerPort: 443
  42. ---
  43. apiVersion: v1
  44. kind: Service
  45. metadata:
  46.   name: traefik
  48. spec:
  49.   type: LoadBalancer
  50.   selector:
  51.     app: traefik-lb
  53.   ports:
  54.     - protocol: TCP
  55.       port: 80
  56.       targetPort: web
  57.       name: web
  59.     - protocol: TCP
  60.       port: 443
  61.       targetPort: websecure
  62.       name: websecure

Gateway API CRDs

  1. # All resources definition must be declared
  3. ---
  4. apiVersion: apiextensions.k8s.io/v1
  5. kind: CustomResourceDefinition
  6. metadata:
  7.   annotations:
  8.     api-approved.kubernetes.io: https://github.com/kubernetes-sigs/gateway-api/pull/891
  9.   creationTimestamp: null
  10.   name: gatewayclasses.gateway.networking.k8s.io
  11. spec:
  12.   group: gateway.networking.k8s.io
  13.   names:
  14.     categories:
  15.     - gateway-api
  16.     kind: GatewayClass
  17.     listKind: GatewayClassList
  18.     plural: gatewayclasses
  19.     shortNames:
  20.     - gc
  21.     singular: gatewayclass
  22.   scope: Cluster
  23.   versions:
  24.   - additionalPrinterColumns:
  25.     - jsonPath: .spec.controller
  26.       name: Controller
  27.       type: string
  28.     - jsonPath: .metadata.creationTimestamp
  29.       name: Age
  30.       type: date
  31.     - jsonPath: .spec.description
  32.       name: Description
  33.       priority: 1
  34.       type: string
  35.     name: v1alpha2
  36.     schema:
  37.       openAPIV3Schema:
  38.         description: "GatewayClass describes a class of Gateways available to the
  39.           user for creating Gateway resources. \n It is recommended that this resource
  40.           be used as a template for Gateways. This means that a Gateway is based on
  41.           the state of the GatewayClass at the time it was created and changes to
  42.           the GatewayClass or associated parameters are not propagated down to existing
  43.           Gateways. This recommendation is intended to limit the blast radius of changes
  44.           to GatewayClass or associated parameters. If implementations choose to propagate
  45.           GatewayClass changes to existing Gateways, that MUST be clearly documented
  46.           by the implementation. \n Whenever one or more Gateways are using a GatewayClass,
  47.           implementations MUST add the `gateway-exists-finalizer.gateway.networking.k8s.io`
  48.           finalizer on the associated GatewayClass. This ensures that a GatewayClass
  49.           associated with a Gateway is not deleted while in use. \n GatewayClass is
  50.           a Cluster level resource."
  51.         properties:
  52.           apiVersion:
  53.             description: 'APIVersion defines the versioned schema of this representation
  54.               of an object. Servers should convert recognized schemas to the latest
  55.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  56.             type: string
  57.           kind:
  58.             description: 'Kind is a string value representing the REST resource this
  59.               object represents. Servers may infer this from the endpoint the client
  60.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  61.             type: string
  62.           metadata:
  63.             type: object
  64.           spec:
  65.             description: Spec defines the desired state of GatewayClass.
  66.             properties:
  67.               controllerName:
  68.                 description: "ControllerName is the name of the controller that is
  69.                   managing Gateways of this class. The value of this field MUST be
  70.                   a domain prefixed path. \n Example: \"example.net/gateway-controller\".
  71.                   \n This field is not mutable and cannot be empty. \n Support: Core"
  72.                 maxLength: 253
  73.                 minLength: 1
  74.                 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
  75.                 type: string
  76.               description:
  77.                 description: Description helps describe a GatewayClass with more details.
  78.                 maxLength: 64
  79.                 type: string
  80.               parametersRef:
  81.                 description: "ParametersRef is a reference to a resource that contains
  82.                   the configuration parameters corresponding to the GatewayClass.
  83.                   This is optional if the controller does not require any additional
  84.                   configuration. \n ParametersRef can reference a standard Kubernetes
  85.                   resource, i.e. ConfigMap, or an implementation-specific custom resource.
  86.                   The resource can be cluster-scoped or namespace-scoped. \n If the
  87.                   referent cannot be found, the GatewayClass's \"InvalidParameters\"
  88.                   status condition will be true. \n Support: Custom"
  89.                 properties:
  90.                   group:
  91.                     description: Group is the group of the referent.
  92.                     maxLength: 253
  93.                     pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  94.                     type: string
  95.                   kind:
  96.                     description: Kind is kind of the referent.
  97.                     maxLength: 63
  98.                     minLength: 1
  99.                     pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  100.                     type: string
  101.                   name:
  102.                     description: Name is the name of the referent.
  103.                     maxLength: 253
  104.                     minLength: 1
  105.                     type: string
  106.                   namespace:
  107.                     description: Namespace is the namespace of the referent. This
  108.                       field is required when referring to a Namespace-scoped resource
  109.                       and MUST be unset when referring to a Cluster-scoped resource.
  110.                     maxLength: 63
  111.                     minLength: 1
  112.                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  113.                     type: string
  114.                 required:
  115.                 - group
  116.                 - kind
  117.                 - name
  118.                 type: object
  119.             required:
  120.             - controllerName
  121.             type: object
  122.           status:
  123.             default:
  124.               conditions:
  125.               - lastTransitionTime: "1970-01-01T00:00:00Z"
  126.                 message: Waiting for controller
  127.                 reason: Waiting
  128.                 status: Unknown
  129.                 type: Accepted
  130.             description: Status defines the current state of GatewayClass.
  131.             properties:
  132.               conditions:
  133.                 default:
  134.                 - lastTransitionTime: "1970-01-01T00:00:00Z"
  135.                   message: Waiting for controller
  136.                   reason: Waiting
  137.                   status: Unknown
  138.                   type: Accepted
  139.                 description: "Conditions is the current status from the controller
  140.                   for this GatewayClass. \n Controllers should prefer to publish conditions
  141.                   using values of GatewayClassConditionType for the type of each Condition."
  142.                 items:
  143.                   description: "Condition contains details for one aspect of the current
  144.                     state of this API Resource. --- This struct is intended for direct
  145.                     use as an array at the field path .status.conditions.  For example,
  146.                     type FooStatus struct{     // Represents the observations of a
  147.                     foo's current state.     // Known .status.conditions.type are:
  148.                     \"Available\", \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  149.                     \    // +patchStrategy=merge     // +listType=map     // +listMapKey=type
  150.                     \    Conditions []metav1.Condition `json:\"conditions,omitempty\"
  151.                     patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  152.                     \n     // other fields }"
  153.                   properties:
  154.                     lastTransitionTime:
  155.                       description: lastTransitionTime is the last time the condition
  156.                         transitioned from one status to another. This should be when
  157.                         the underlying condition changed.  If that is not known, then
  158.                         using the time when the API field changed is acceptable.
  159.                       format: date-time
  160.                       type: string
  161.                     message:
  162.                       description: message is a human readable message indicating
  163.                         details about the transition. This may be an empty string.
  164.                       maxLength: 32768
  165.                       type: string
  166.                     observedGeneration:
  167.                       description: observedGeneration represents the .metadata.generation
  168.                         that the condition was set based upon. For instance, if .metadata.generation
  169.                         is currently 12, but the .status.conditions[x].observedGeneration
  170.                         is 9, the condition is out of date with respect to the current
  171.                         state of the instance.
  172.                       format: int64
  173.                       minimum: 0
  174.                       type: integer
  175.                     reason:
  176.                       description: reason contains a programmatic identifier indicating
  177.                         the reason for the condition's last transition. Producers
  178.                         of specific condition types may define expected values and
  179.                         meanings for this field, and whether the values are considered
  180.                         a guaranteed API. The value should be a CamelCase string.
  181.                         This field may not be empty.
  182.                       maxLength: 1024
  183.                       minLength: 1
  184.                       pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  185.                       type: string
  186.                     status:
  187.                       description: status of the condition, one of True, False, Unknown.
  188.                       enum:
  189.                       - "True"
  190.                       - "False"
  191.                       - Unknown
  192.                       type: string
  193.                     type:
  194.                       description: type of condition in CamelCase or in foo.example.com/CamelCase.
  195.                         --- Many .condition.type values are consistent across resources
  196.                         like Available, but because arbitrary conditions can be useful
  197.                         (see .node.status.conditions), the ability to deconflict is
  198.                         important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  199.                       maxLength: 316
  200.                       pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
  201.                       type: string
  202.                   required:
  203.                   - lastTransitionTime
  204.                   - message
  205.                   - reason
  206.                   - status
  207.                   - type
  208.                   type: object
  209.                 maxItems: 8
  210.                 type: array
  211.                 x-kubernetes-list-map-keys:
  212.                 - type
  213.                 x-kubernetes-list-type: map
  214.             type: object
  215.         required:
  216.         - spec
  217.         type: object
  218.     served: true
  219.     storage: true
  220.     subresources:
  221.       status: {}
  222. status:
  223.   acceptedNames:
  224.     kind: ""
  225.     plural: ""
  226.   conditions: []
  227.   storedVersions: []
  229. ---
  230. apiVersion: apiextensions.k8s.io/v1
  231. kind: CustomResourceDefinition
  232. metadata:
  233.   annotations:
  234.     api-approved.kubernetes.io: https://github.com/kubernetes-sigs/gateway-api/pull/891
  235.   creationTimestamp: null
  236.   name: gateways.gateway.networking.k8s.io
  237. spec:
  238.   group: gateway.networking.k8s.io
  239.   names:
  240.     categories:
  241.     - gateway-api
  242.     kind: Gateway
  243.     listKind: GatewayList
  244.     plural: gateways
  245.     shortNames:
  246.     - gtw
  247.     singular: gateway
  248.   scope: Namespaced
  249.   versions:
  250.   - additionalPrinterColumns:
  251.     - jsonPath: .spec.gatewayClassName
  252.       name: Class
  253.       type: string
  254.     - jsonPath: .status.addresses[*].value
  255.       name: Address
  256.       type: string
  257.     - jsonPath: .status.conditions[?(@.type=="Ready")].status
  258.       name: Ready
  259.       type: string
  260.     - jsonPath: .metadata.creationTimestamp
  261.       name: Age
  262.       type: date
  263.     name: v1alpha2
  264.     schema:
  265.       openAPIV3Schema:
  266.         description: Gateway represents an instance of a service-traffic handling
  267.           infrastructure by binding Listeners to a set of IP addresses.
  268.         properties:
  269.           apiVersion:
  270.             description: 'APIVersion defines the versioned schema of this representation
  271.               of an object. Servers should convert recognized schemas to the latest
  272.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  273.             type: string
  274.           kind:
  275.             description: 'Kind is a string value representing the REST resource this
  276.               object represents. Servers may infer this from the endpoint the client
  277.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  278.             type: string
  279.           metadata:
  280.             type: object
  281.           spec:
  282.             description: Spec defines the desired state of Gateway.
  283.             properties:
  284.               addresses:
  285.                 description: "Addresses requested for this Gateway. This is optional
  286.                   and behavior can depend on the implementation. If a value is set
  287.                   in the spec and the requested address is invalid or unavailable,
  288.                   the implementation MUST indicate this in the associated entry in
  289.                   GatewayStatus.Addresses. \n The Addresses field represents a request
  290.                   for the address(es) on the \"outside of the Gateway\", that traffic
  291.                   bound for this Gateway will use. This could be the IP address or
  292.                   hostname of an external load balancer or other networking infrastructure,
  293.                   or some other address that traffic will be sent to. \n The .listener.hostname
  294.                   field is used to route traffic that has already arrived at the Gateway
  295.                   to the correct in-cluster destination. \n If no Addresses are specified,
  296.                   the implementation MAY schedule the Gateway in an implementation-specific
  297.                   manner, assigning an appropriate set of Addresses. \n The implementation
  298.                   MUST bind all Listeners to every GatewayAddress that it assigns
  299.                   to the Gateway and add a corresponding entry in GatewayStatus.Addresses.
  300.                   \n Support: Core"
  301.                 items:
  302.                   description: GatewayAddress describes an address that can be bound
  303.                     to a Gateway.
  304.                   properties:
  305.                     type:
  306.                       default: IPAddress
  307.                       description: Type of the address.
  308.                       enum:
  309.                       - IPAddress
  310.                       - Hostname
  311.                       - NamedAddress
  312.                       type: string
  313.                     value:
  314.                       description: "Value of the address. The validity of the values
  315.                         will depend on the type and support by the controller. \n
  316.                         Examples: `1.2.3.4`, `128::1`, `my-ip-address`."
  317.                       maxLength: 253
  318.                       minLength: 1
  319.                       type: string
  320.                   required:
  321.                   - value
  322.                   type: object
  323.                 maxItems: 16
  324.                 type: array
  325.               gatewayClassName:
  326.                 description: GatewayClassName used for this Gateway. This is the name
  327.                   of a GatewayClass resource.
  328.                 maxLength: 253
  329.                 minLength: 1
  330.                 type: string
  331.               listeners:
  332.                 description: "Listeners associated with this Gateway. Listeners define
  333.                   logical endpoints that are bound on this Gateway's addresses. At
  334.                   least one Listener MUST be specified. \n Each listener in a Gateway
  335.                   must have a unique combination of Hostname, Port, and Protocol.
  336.                   \n An implementation MAY group Listeners by Port and then collapse
  337.                   each group of Listeners into a single Listener if the implementation
  338.                   determines that the Listeners in the group are \"compatible\". An
  339.                   implementation MAY also group together and collapse compatible Listeners
  340.                   belonging to different Gateways. \n For example, an implementation
  341.                   might consider Listeners to be compatible with each other if all
  342.                   of the following conditions are met: \n 1. Either each Listener
  343.                   within the group specifies the \"HTTP\"    Protocol or each Listener
  344.                   within the group specifies either    the \"HTTPS\" or \"TLS\" Protocol.
  345.                   \n 2. Each Listener within the group specifies a Hostname that is
  346.                   unique    within the group. \n 3. As a special case, one Listener
  347.                   within a group may omit Hostname,    in which case this Listener
  348.                   matches when no other Listener    matches. \n If the implementation
  349.                   does collapse compatible Listeners, the hostname provided in the
  350.                   incoming client request MUST be matched to a Listener to find the
  351.                   correct set of Routes. The incoming hostname MUST be matched using
  352.                   the Hostname field for each Listener in order of most to least specific.
  353.                   That is, exact matches must be processed before wildcard matches.
  354.                   \n If this field specifies multiple Listeners that have the same
  355.                   Port value but are not compatible, the implementation must raise
  356.                   a \"Conflicted\" condition in the Listener status. \n Support: Core"
  357.                 items:
  358.                   description: Listener embodies the concept of a logical endpoint
  359.                     where a Gateway accepts network connections.
  360.                   properties:
  361.                     allowedRoutes:
  362.                       default:
  363.                         namespaces:
  364.                           from: Same
  365.                       description: "AllowedRoutes defines the types of routes that
  366.                         MAY be attached to a Listener and the trusted namespaces where
  367.                         those Route resources MAY be present. \n Although a client
  368.                         request may match multiple route rules, only one rule may
  369.                         ultimately receive the request. Matching precedence MUST be
  370.                         determined in order of the following criteria: \n * The most
  371.                         specific match as defined by the Route type. * The oldest
  372.                         Route based on creation timestamp. For example, a Route with
  373.                         \  a creation timestamp of \"2020-09-08 01:02:03\" is given
  374.                         precedence over   a Route with a creation timestamp of \"2020-09-08
  375.                         01:02:04\". * If everything else is equivalent, the Route
  376.                         appearing first in   alphabetical order (namespace/name) should
  377.                         be given precedence. For   example, foo/bar is given precedence
  378.                         over foo/baz. \n All valid rules within a Route attached to
  379.                         this Listener should be implemented. Invalid Route rules can
  380.                         be ignored (sometimes that will mean the full Route). If a
  381.                         Route rule transitions from valid to invalid, support for
  382.                         that Route rule should be dropped to ensure consistency. For
  383.                         example, even if a filter specified by a Route rule is invalid,
  384.                         the rest of the rules within that Route should still be supported.
  385.                         \n Support: Core"
  386.                       properties:
  387.                         kinds:
  388.                           description: "Kinds specifies the groups and kinds of Routes
  389.                             that are allowed to bind to this Gateway Listener. When
  390.                             unspecified or empty, the kinds of Routes selected are
  391.                             determined using the Listener protocol. \n A RouteGroupKind
  392.                             MUST correspond to kinds of Routes that are compatible
  393.                             with the application protocol specified in the Listener's
  394.                             Protocol field. If an implementation does not support
  395.                             or recognize this resource type, it MUST set the \"ResolvedRefs\"
  396.                             condition to False for this Listener with the \"InvalidRoutesRef\"
  397.                             reason. \n Support: Core"
  398.                           items:
  399.                             description: RouteGroupKind indicates the group and kind
  400.                               of a Route resource.
  401.                             properties:
  402.                               group:
  403.                                 default: gateway.networking.k8s.io
  404.                                 description: Group is the group of the Route.
  405.                                 maxLength: 253
  406.                                 pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  407.                                 type: string
  408.                               kind:
  409.                                 description: Kind is the kind of the Route.
  410.                                 maxLength: 63
  411.                                 minLength: 1
  412.                                 pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  413.                                 type: string
  414.                             required:
  415.                             - kind
  416.                             type: object
  417.                           maxItems: 8
  418.                           type: array
  419.                         namespaces:
  420.                           default:
  421.                             from: Same
  422.                           description: "Namespaces indicates namespaces from which
  423.                             Routes may be attached to this Listener. This is restricted
  424.                             to the namespace of this Gateway by default. \n Support:
  425.                             Core"
  426.                           properties:
  427.                             from:
  428.                               default: Same
  429.                               description: "From indicates where Routes will be selected
  430.                                 for this Gateway. Possible values are: * All: Routes
  431.                                 in all namespaces may be used by this Gateway. * Selector:
  432.                                 Routes in namespaces selected by the selector may
  433.                                 be used by   this Gateway. * Same: Only Routes in
  434.                                 the same namespace may be used by this Gateway. \n
  435.                                 Support: Core"
  436.                               enum:
  437.                               - All
  438.                               - Selector
  439.                               - Same
  440.                               type: string
  441.                             selector:
  442.                               description: "Selector must be specified when From is
  443.                                 set to \"Selector\". In that case, only Routes in
  444.                                 Namespaces matching this Selector will be selected
  445.                                 by this Gateway. This field is ignored for other values
  446.                                 of \"From\". \n Support: Core"
  447.                               properties:
  448.                                 matchExpressions:
  449.                                   description: matchExpressions is a list of label
  450.                                     selector requirements. The requirements are ANDed.
  451.                                   items:
  452.                                     description: A label selector requirement is a
  453.                                       selector that contains values, a key, and an
  454.                                       operator that relates the key and values.
  455.                                     properties:
  456.                                       key:
  457.                                         description: key is the label key that the
  458.                                           selector applies to.
  459.                                         type: string
  460.                                       operator:
  461.                                         description: operator represents a key's relationship
  462.                                           to a set of values. Valid operators are
  463.                                           In, NotIn, Exists and DoesNotExist.
  464.                                         type: string
  465.                                       values:
  466.                                         description: values is an array of string
  467.                                           values. If the operator is In or NotIn,
  468.                                           the values array must be non-empty. If the
  469.                                           operator is Exists or DoesNotExist, the
  470.                                           values array must be empty. This array is
  471.                                           replaced during a strategic merge patch.
  472.                                         items:
  473.                                           type: string
  474.                                         type: array
  475.                                     required:
  476.                                     - key
  477.                                     - operator
  478.                                     type: object
  479.                                   type: array
  480.                                 matchLabels:
  481.                                   additionalProperties:
  482.                                     type: string
  483.                                   description: matchLabels is a map of {key,value}
  484.                                     pairs. A single {key,value} in the matchLabels
  485.                                     map is equivalent to an element of matchExpressions,
  486.                                     whose key field is "key", the operator is "In",
  487.                                     and the values array contains only "value". The
  488.                                     requirements are ANDed.
  489.                                   type: object
  490.                               type: object
  491.                           type: object
  492.                       type: object
  493.                     hostname:
  494.                       description: "Hostname specifies the virtual hostname to match
  495.                         for protocol types that define this concept. When unspecified,
  496.                         all hostnames are matched. This field is ignored for protocols
  497.                         that don't require hostname based matching. \n Implementations
  498.                         MUST apply Hostname matching appropriately for each of the
  499.                         following protocols: \n * TLS: The Listener Hostname MUST
  500.                         match the SNI. * HTTP: The Listener Hostname MUST match the
  501.                         Host header of the request. * HTTPS: The Listener Hostname
  502.                         SHOULD match at both the TLS and HTTP   protocol layers as
  503.                         described above. If an implementation does not   ensure that
  504.                         both the SNI and Host header match the Listener hostname,
  505.                         \  it MUST clearly document that. \n For HTTPRoute and TLSRoute
  506.                         resources, there is an interaction with the `spec.hostnames`
  507.                         array. When both listener and route specify hostnames, there
  508.                         MUST be an intersection between the values for a Route to
  509.                         be accepted. For more information, refer to the Route specific
  510.                         Hostnames documentation. \n Support: Core"
  511.                       maxLength: 253
  512.                       minLength: 1
  513.                       pattern: ^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  514.                       type: string
  515.                     name:
  516.                       description: "Name is the name of the Listener. \n Support:
  517.                         Core"
  518.                       maxLength: 253
  519.                       minLength: 1
  520.                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  521.                       type: string
  522.                     port:
  523.                       description: "Port is the network port. Multiple listeners may
  524.                         use the same port, subject to the Listener compatibility rules.
  525.                         \n Support: Core"
  526.                       format: int32
  527.                       maximum: 65535
  528.                       minimum: 1
  529.                       type: integer
  530.                     protocol:
  531.                       description: "Protocol specifies the network protocol this listener
  532.                         expects to receive. \n Support: Core"
  533.                       maxLength: 255
  534.                       minLength: 1
  535.                       pattern: ^[a-zA-Z0-9]([-a-zSA-Z0-9]*[a-zA-Z0-9])?$|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9]+$
  536.                       type: string
  537.                     tls:
  538.                       description: "TLS is the TLS configuration for the Listener.
  539.                         This field is required if the Protocol field is \"HTTPS\"
  540.                         or \"TLS\". It is invalid to set this field if the Protocol
  541.                         field is \"HTTP\", \"TCP\", or \"UDP\". \n The association
  542.                         of SNIs to Certificate defined in GatewayTLSConfig is defined
  543.                         based on the Hostname field for this listener. \n The GatewayClass
  544.                         MUST use the longest matching SNI out of all available certificates
  545.                         for any TLS handshake. \n Support: Core"
  546.                       properties:
  547.                         certificateRefs:
  548.                           description: "CertificateRefs contains a series of references
  549.                             to Kubernetes objects that contains TLS certificates and
  550.                             private keys. These certificates are used to establish
  551.                             a TLS handshake for requests that match the hostname of
  552.                             the associated listener. \n A single CertificateRef to
  553.                             a Kubernetes Secret has \"Core\" support. Implementations
  554.                             MAY choose to support attaching multiple certificates
  555.                             to a Listener, but this behavior is implementation-specific.
  556.                             \n References to a resource in different namespace are
  557.                             invalid UNLESS there is a ReferencePolicy in the target
  558.                             namespace that allows the certificate to be attached.
  559.                             If a ReferencePolicy does not allow this reference, the
  560.                             \"ResolvedRefs\" condition MUST be set to False for this
  561.                             listener with the \"InvalidCertificateRef\" reason. \n
  562.                             This field is required to have at least one element when
  563.                             the mode is set to \"Terminate\" (default) and is optional
  564.                             otherwise. \n CertificateRefs can reference to standard
  565.                             Kubernetes resources, i.e. Secret, or implementation-specific
  566.                             custom resources. \n Support: Core - A single reference
  567.                             to a Kubernetes Secret \n Support: Implementation-specific
  568.                             (More than one reference or other resource types)"
  569.                           items:
  570.                             description: "SecretObjectReference identifies an API
  571.                               object including its namespace, defaulting to Secret.
  572.                               \n The API object must be valid in the cluster; the
  573.                               Group and Kind must be registered in the cluster for
  574.                               this reference to be valid. \n References to objects
  575.                               with invalid Group and Kind are not valid, and must
  576.                               be rejected by the implementation, with appropriate
  577.                               Conditions set on the containing object."
  578.                             properties:
  579.                               group:
  580.                                 default: ""
  581.                                 description: Group is the group of the referent. For
  582.                                   example, "networking.k8s.io". When unspecified (empty
  583.                                   string), core API group is inferred.
  584.                                 maxLength: 253
  585.                                 pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  586.                                 type: string
  587.                               kind:
  588.                                 default: Secret
  589.                                 description: Kind is kind of the referent. For example
  590.                                   "HTTPRoute" or "Service".
  591.                                 maxLength: 63
  592.                                 minLength: 1
  593.                                 pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  594.                                 type: string
  595.                               name:
  596.                                 description: Name is the name of the referent.
  597.                                 maxLength: 253
  598.                                 minLength: 1
  599.                                 type: string
  600.                               namespace:
  601.                                 description: "Namespace is the namespace of the backend.
  602.                                   When unspecified, the local namespace is inferred.
  603.                                   \n Note that when a namespace is specified, a ReferencePolicy
  604.                                   object is required in the referent namespace to
  605.                                   allow that namespace's owner to accept the reference.
  606.                                   See the ReferencePolicy documentation for details.
  607.                                   \n Support: Core"
  608.                                 maxLength: 63
  609.                                 minLength: 1
  610.                                 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  611.                                 type: string
  612.                             required:
  613.                             - name
  614.                             type: object
  615.                           maxItems: 64
  616.                           type: array
  617.                         mode:
  618.                           default: Terminate
  619.                           description: "Mode defines the TLS behavior for the TLS
  620.                             session initiated by the client. There are two possible
  621.                             modes: \n - Terminate: The TLS session between the downstream
  622.                             client   and the Gateway is terminated at the Gateway.
  623.                             This mode requires   certificateRefs to be set and contain
  624.                             at least one element. - Passthrough: The TLS session is
  625.                             NOT terminated by the Gateway. This   implies that the
  626.                             Gateway can't decipher the TLS stream except for   the
  627.                             ClientHello message of the TLS protocol.   CertificateRefs
  628.                             field is ignored in this mode. \n Support: Core"
  629.                           enum:
  630.                           - Terminate
  631.                           - Passthrough
  632.                           type: string
  633.                         options:
  634.                           additionalProperties:
  635.                             description: AnnotationValue is the value of an annotation
  636.                               in Gateway API. This is used for validation of maps
  637.                               such as TLS options. This roughly matches Kubernetes
  638.                               annotation validation, although the length validation
  639.                               in that case is based on the entire size of the annotations
  640.                               struct.
  641.                             maxLength: 4096
  642.                             minLength: 0
  643.                             type: string
  644.                           description: "Options are a list of key/value pairs to enable
  645.                             extended TLS configuration for each implementation. For
  646.                             example, configuring the minimum TLS version or supported
  647.                             cipher suites. \n A set of common keys MAY be defined
  648.                             by the API in the future. To avoid any ambiguity, implementation-specific
  649.                             definitions MUST use domain-prefixed names, such as `example.com/my-custom-option`.
  650.                             Un-prefixed names are reserved for key names defined by
  651.                             Gateway API. \n Support: Implementation-specific"
  652.                           maxProperties: 16
  653.                           type: object
  654.                       type: object
  655.                   required:
  656.                   - name
  657.                   - port
  658.                   - protocol
  659.                   type: object
  660.                 maxItems: 64
  661.                 minItems: 1
  662.                 type: array
  663.                 x-kubernetes-list-map-keys:
  664.                 - name
  665.                 x-kubernetes-list-type: map
  666.             required:
  667.             - gatewayClassName
  668.             - listeners
  669.             type: object
  670.           status:
  671.             default:
  672.               conditions:
  673.               - lastTransitionTime: "1970-01-01T00:00:00Z"
  674.                 message: Waiting for controller
  675.                 reason: NotReconciled
  676.                 status: Unknown
  677.                 type: Scheduled
  678.             description: Status defines the current state of Gateway.
  679.             properties:
  680.               addresses:
  681.                 description: Addresses lists the IP addresses that have actually been
  682.                   bound to the Gateway. These addresses may differ from the addresses
  683.                   in the Spec, e.g. if the Gateway automatically assigns an address
  684.                   from a reserved pool.
  685.                 items:
  686.                   description: GatewayAddress describes an address that can be bound
  687.                     to a Gateway.
  688.                   properties:
  689.                     type:
  690.                       default: IPAddress
  691.                       description: Type of the address.
  692.                       enum:
  693.                       - IPAddress
  694.                       - Hostname
  695.                       - NamedAddress
  696.                       type: string
  697.                     value:
  698.                       description: "Value of the address. The validity of the values
  699.                         will depend on the type and support by the controller. \n
  700.                         Examples: `1.2.3.4`, `128::1`, `my-ip-address`."
  701.                       maxLength: 253
  702.                       minLength: 1
  703.                       type: string
  704.                   required:
  705.                   - value
  706.                   type: object
  707.                 maxItems: 16
  708.                 type: array
  709.               conditions:
  710.                 default:
  711.                 - lastTransitionTime: "1970-01-01T00:00:00Z"
  712.                   message: Waiting for controller
  713.                   reason: NotReconciled
  714.                   status: Unknown
  715.                   type: Scheduled
  716.                 description: "Conditions describe the current conditions of the Gateway.
  717.                   \n Implementations should prefer to express Gateway conditions using
  718.                   the `GatewayConditionType` and `GatewayConditionReason` constants
  719.                   so that operators and tools can converge on a common vocabulary
  720.                   to describe Gateway state. \n Known condition types are: \n * \"Scheduled\"
  721.                   * \"Ready\""
  722.                 items:
  723.                   description: "Condition contains details for one aspect of the current
  724.                     state of this API Resource. --- This struct is intended for direct
  725.                     use as an array at the field path .status.conditions.  For example,
  726.                     type FooStatus struct{     // Represents the observations of a
  727.                     foo's current state.     // Known .status.conditions.type are:
  728.                     \"Available\", \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  729.                     \    // +patchStrategy=merge     // +listType=map     // +listMapKey=type
  730.                     \    Conditions []metav1.Condition `json:\"conditions,omitempty\"
  731.                     patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  732.                     \n     // other fields }"
  733.                   properties:
  734.                     lastTransitionTime:
  735.                       description: lastTransitionTime is the last time the condition
  736.                         transitioned from one status to another. This should be when
  737.                         the underlying condition changed.  If that is not known, then
  738.                         using the time when the API field changed is acceptable.
  739.                       format: date-time
  740.                       type: string
  741.                     message:
  742.                       description: message is a human readable message indicating
  743.                         details about the transition. This may be an empty string.
  744.                       maxLength: 32768
  745.                       type: string
  746.                     observedGeneration:
  747.                       description: observedGeneration represents the .metadata.generation
  748.                         that the condition was set based upon. For instance, if .metadata.generation
  749.                         is currently 12, but the .status.conditions[x].observedGeneration
  750.                         is 9, the condition is out of date with respect to the current
  751.                         state of the instance.
  752.                       format: int64
  753.                       minimum: 0
  754.                       type: integer
  755.                     reason:
  756.                       description: reason contains a programmatic identifier indicating
  757.                         the reason for the condition's last transition. Producers
  758.                         of specific condition types may define expected values and
  759.                         meanings for this field, and whether the values are considered
  760.                         a guaranteed API. The value should be a CamelCase string.
  761.                         This field may not be empty.
  762.                       maxLength: 1024
  763.                       minLength: 1
  764.                       pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  765.                       type: string
  766.                     status:
  767.                       description: status of the condition, one of True, False, Unknown.
  768.                       enum:
  769.                       - "True"
  770.                       - "False"
  771.                       - Unknown
  772.                       type: string
  773.                     type:
  774.                       description: type of condition in CamelCase or in foo.example.com/CamelCase.
  775.                         --- Many .condition.type values are consistent across resources
  776.                         like Available, but because arbitrary conditions can be useful
  777.                         (see .node.status.conditions), the ability to deconflict is
  778.                         important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  779.                       maxLength: 316
  780.                       pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
  781.                       type: string
  782.                   required:
  783.                   - lastTransitionTime
  784.                   - message
  785.                   - reason
  786.                   - status
  787.                   - type
  788.                   type: object
  789.                 maxItems: 8
  790.                 type: array
  791.                 x-kubernetes-list-map-keys:
  792.                 - type
  793.                 x-kubernetes-list-type: map
  794.               listeners:
  795.                 description: Listeners provide status for each unique listener port
  796.                   defined in the Spec.
  797.                 items:
  798.                   description: ListenerStatus is the status associated with a Listener.
  799.                   properties:
  800.                     attachedRoutes:
  801.                       description: AttachedRoutes represents the total number of Routes
  802.                         that have been successfully attached to this Listener.
  803.                       format: int32
  804.                       type: integer
  805.                     conditions:
  806.                       description: Conditions describe the current condition of this
  807.                         listener.
  808.                       items:
  809.                         description: "Condition contains details for one aspect of
  810.                           the current state of this API Resource. --- This struct
  811.                           is intended for direct use as an array at the field path
  812.                           .status.conditions.  For example, type FooStatus struct{
  813.                           \    // Represents the observations of a foo's current state.
  814.                           \    // Known .status.conditions.type are: \"Available\",
  815.                           \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  816.                           \    // +patchStrategy=merge     // +listType=map     //
  817.                           +listMapKey=type     Conditions []metav1.Condition `json:\"conditions,omitempty\"
  818.                           patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  819.                           \n     // other fields }"
  820.                         properties:
  821.                           lastTransitionTime:
  822.                             description: lastTransitionTime is the last time the condition
  823.                               transitioned from one status to another. This should
  824.                               be when the underlying condition changed.  If that is
  825.                               not known, then using the time when the API field changed
  826.                               is acceptable.
  827.                             format: date-time
  828.                             type: string
  829.                           message:
  830.                             description: message is a human readable message indicating
  831.                               details about the transition. This may be an empty string.
  832.                             maxLength: 32768
  833.                             type: string
  834.                           observedGeneration:
  835.                             description: observedGeneration represents the .metadata.generation
  836.                               that the condition was set based upon. For instance,
  837.                               if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
  838.                               is 9, the condition is out of date with respect to the
  839.                               current state of the instance.
  840.                             format: int64
  841.                             minimum: 0
  842.                             type: integer
  843.                           reason:
  844.                             description: reason contains a programmatic identifier
  845.                               indicating the reason for the condition's last transition.
  846.                               Producers of specific condition types may define expected
  847.                               values and meanings for this field, and whether the
  848.                               values are considered a guaranteed API. The value should
  849.                               be a CamelCase string. This field may not be empty.
  850.                             maxLength: 1024
  851.                             minLength: 1
  852.                             pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  853.                             type: string
  854.                           status:
  855.                             description: status of the condition, one of True, False,
  856.                               Unknown.
  857.                             enum:
  858.                             - "True"
  859.                             - "False"
  860.                             - Unknown
  861.                             type: string
  862.                           type:
  863.                             description: type of condition in CamelCase or in foo.example.com/CamelCase.
  864.                               --- Many .condition.type values are consistent across
  865.                               resources like Available, but because arbitrary conditions
  866.                               can be useful (see .node.status.conditions), the ability
  867.                               to deconflict is important. The regex it matches is
  868.                               (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  869.                             maxLength: 316
  870.                             pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
  871.                             type: string
  872.                         required:
  873.                         - lastTransitionTime
  874.                         - message
  875.                         - reason
  876.                         - status
  877.                         - type
  878.                         type: object
  879.                       maxItems: 8
  880.                       type: array
  881.                       x-kubernetes-list-map-keys:
  882.                       - type
  883.                       x-kubernetes-list-type: map
  884.                     name:
  885.                       description: Name is the name of the Listener that this status
  886.                         corresponds to.
  887.                       maxLength: 253
  888.                       minLength: 1
  889.                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  890.                       type: string
  891.                     supportedKinds:
  892.                       description: "SupportedKinds is the list indicating the Kinds
  893.                         supported by this listener. This MUST represent the kinds
  894.                         an implementation supports for that Listener configuration.
  895.                         \n If kinds are specified in Spec that are not supported,
  896.                         they MUST NOT appear in this list and an implementation MUST
  897.                         set the \"ResolvedRefs\" condition to \"False\" with the \"InvalidRouteKinds\"
  898.                         reason. If both valid and invalid Route kinds are specified,
  899.                         the implementation MUST reference the valid Route kinds that
  900.                         have been specified."
  901.                       items:
  902.                         description: RouteGroupKind indicates the group and kind of
  903.                           a Route resource.
  904.                         properties:
  905.                           group:
  906.                             default: gateway.networking.k8s.io
  907.                             description: Group is the group of the Route.
  908.                             maxLength: 253
  909.                             pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  910.                             type: string
  911.                           kind:
  912.                             description: Kind is the kind of the Route.
  913.                             maxLength: 63
  914.                             minLength: 1
  915.                             pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  916.                             type: string
  917.                         required:
  918.                         - kind
  919.                         type: object
  920.                       maxItems: 8
  921.                       type: array
  922.                   required:
  923.                   - attachedRoutes
  924.                   - conditions
  925.                   - name
  926.                   - supportedKinds
  927.                   type: object
  928.                 maxItems: 64
  929.                 type: array
  930.                 x-kubernetes-list-map-keys:
  931.                 - name
  932.                 x-kubernetes-list-type: map
  933.             type: object
  934.         required:
  935.         - spec
  936.         type: object
  937.     served: true
  938.     storage: true
  939.     subresources:
  940.       status: {}
  941. status:
  942.   acceptedNames:
  943.     kind: ""
  944.     plural: ""
  945.   conditions: []
  946.   storedVersions: []
  948. ---
  949. apiVersion: apiextensions.k8s.io/v1
  950. kind: CustomResourceDefinition
  951. metadata:
  952.   annotations:
  953.     api-approved.kubernetes.io: https://github.com/kubernetes-sigs/gateway-api/pull/891
  954.   creationTimestamp: null
  955.   name: httproutes.gateway.networking.k8s.io
  956. spec:
  957.   group: gateway.networking.k8s.io
  958.   names:
  959.     categories:
  960.     - gateway-api
  961.     kind: HTTPRoute
  962.     listKind: HTTPRouteList
  963.     plural: httproutes
  964.     singular: httproute
  965.   scope: Namespaced
  966.   versions:
  967.   - additionalPrinterColumns:
  968.     - jsonPath: .spec.hostnames
  969.       name: Hostnames
  970.       type: string
  971.     - jsonPath: .metadata.creationTimestamp
  972.       name: Age
  973.       type: date
  974.     name: v1alpha2
  975.     schema:
  976.       openAPIV3Schema:
  977.         description: HTTPRoute provides a way to route HTTP requests. This includes
  978.           the capability to match requests by hostname, path, header, or query param.
  979.           Filters can be used to specify additional processing steps. Backends specify
  980.           where matching requests should be routed.
  981.         properties:
  982.           apiVersion:
  983.             description: 'APIVersion defines the versioned schema of this representation
  984.               of an object. Servers should convert recognized schemas to the latest
  985.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  986.             type: string
  987.           kind:
  988.             description: 'Kind is a string value representing the REST resource this
  989.               object represents. Servers may infer this from the endpoint the client
  990.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  991.             type: string
  992.           metadata:
  993.             type: object
  994.           spec:
  995.             description: Spec defines the desired state of HTTPRoute.
  996.             properties:
  997.               hostnames:
  998.                 description: "Hostnames defines a set of hostname that should match
  999.                   against the HTTP Host header to select a HTTPRoute to process the
  1000.                   request. This matches the RFC 1123 definition of a hostname with
  1001.                   2 notable exceptions: \n 1. IPs are not allowed. 2. A hostname may
  1002.                   be prefixed with a wildcard label (`*.`). The wildcard    label
  1003.                   must appear by itself as the first label. \n If a hostname is specified
  1004.                   by both the Listener and HTTPRoute, there must be at least one intersecting
  1005.                   hostname for the HTTPRoute to be attached to the Listener. For example:
  1006.                   \n * A Listener with `test.example.com` as the hostname matches
  1007.                   HTTPRoutes   that have either not specified any hostnames, or have
  1008.                   specified at   least one of `test.example.com` or `*.example.com`.
  1009.                   * A Listener with `*.example.com` as the hostname matches HTTPRoutes
  1010.                   \  that have either not specified any hostnames or have specified
  1011.                   at least   one hostname that matches the Listener hostname. For
  1012.                   example,   `test.example.com` and `*.example.com` would both match.
  1013.                   On the other   hand, `example.com` and `test.example.net` would
  1014.                   not match. \n If both the Listener and HTTPRoute have specified
  1015.                   hostnames, any HTTPRoute hostnames that do not match the Listener
  1016.                   hostname MUST be ignored. For example, if a Listener specified `*.example.com`,
  1017.                   and the HTTPRoute specified `test.example.com` and `test.example.net`,
  1018.                   `test.example.net` must not be considered for a match. \n If both
  1019.                   the Listener and HTTPRoute have specified hostnames, and none match
  1020.                   with the criteria above, then the HTTPRoute is not accepted. The
  1021.                   implementation must raise an 'Accepted' Condition with a status
  1022.                   of `False` in the corresponding RouteParentStatus. \n Support: Core"
  1023.                 items:
  1024.                   description: "Hostname is the fully qualified domain name of a network
  1025.                     host. This matches the RFC 1123 definition of a hostname with
  1026.                     2 notable exceptions: \n 1. IPs are not allowed. 2. A hostname
  1027.                     may be prefixed with a wildcard label (`*.`). The wildcard    label
  1028.                     must appear by itself as the first label. \n Hostname can be \"precise\"
  1029.                     which is a domain name without the terminating dot of a network
  1030.                     host (e.g. \"foo.example.com\") or \"wildcard\", which is a domain
  1031.                     name prefixed with a single wildcard label (e.g. `*.example.com`).
  1032.                     \n Note that as per RFC1035 and RFC1123, a *label* must consist
  1033.                     of lower case alphanumeric characters or '-', and must start and
  1034.                     end with an alphanumeric character. No other punctuation is allowed."
  1035.                   maxLength: 253
  1036.                   minLength: 1
  1037.                   pattern: ^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1038.                   type: string
  1039.                 maxItems: 16
  1040.                 type: array
  1041.               parentRefs:
  1042.                 description: "ParentRefs references the resources (usually Gateways)
  1043.                   that a Route wants to be attached to. Note that the referenced parent
  1044.                   resource needs to allow this for the attachment to be complete.
  1045.                   For Gateways, that means the Gateway needs to allow attachment from
  1046.                   Routes of this kind and namespace. \n The only kind of parent resource
  1047.                   with \"Core\" support is Gateway. This API may be extended in the
  1048.                   future to support additional kinds of parent resources such as one
  1049.                   of the route kinds. \n It is invalid to reference an identical parent
  1050.                   more than once. It is valid to reference multiple distinct sections
  1051.                   within the same parent resource, such as 2 Listeners within a Gateway.
  1052.                   \n It is possible to separately reference multiple distinct objects
  1053.                   that may be collapsed by an implementation. For example, some implementations
  1054.                   may choose to merge compatible Gateway Listeners together. If that
  1055.                   is the case, the list of routes attached to those resources should
  1056.                   also be merged."
  1057.                 items:
  1058.                   description: "ParentRef identifies an API object (usually a Gateway)
  1059.                     that can be considered a parent of this resource (usually a route).
  1060.                     The only kind of parent resource with \"Core\" support is Gateway.
  1061.                     This API may be extended in the future to support additional kinds
  1062.                     of parent resources, such as HTTPRoute. \n The API object must
  1063.                     be valid in the cluster; the Group and Kind must be registered
  1064.                     in the cluster for this reference to be valid. \n References to
  1065.                     objects with invalid Group and Kind are not valid, and must be
  1066.                     rejected by the implementation, with appropriate Conditions set
  1067.                     on the containing object."
  1068.                   properties:
  1069.                     group:
  1070.                       default: gateway.networking.k8s.io
  1071.                       description: "Group is the group of the referent. \n Support:
  1072.                         Core"
  1073.                       maxLength: 253
  1074.                       pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1075.                       type: string
  1076.                     kind:
  1077.                       default: Gateway
  1078.                       description: "Kind is kind of the referent. \n Support: Core
  1079.                         (Gateway) Support: Custom (Other Resources)"
  1080.                       maxLength: 63
  1081.                       minLength: 1
  1082.                       pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1083.                       type: string
  1084.                     name:
  1085.                       description: "Name is the name of the referent. \n Support:
  1086.                         Core"
  1087.                       maxLength: 253
  1088.                       minLength: 1
  1089.                       type: string
  1090.                     namespace:
  1091.                       description: "Namespace is the namespace of the referent. When
  1092.                         unspecified (or empty string), this refers to the local namespace
  1093.                         of the Route. \n Support: Core"
  1094.                       maxLength: 63
  1095.                       minLength: 1
  1096.                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1097.                       type: string
  1098.                     sectionName:
  1099.                       description: "SectionName is the name of a section within the
  1100.                         target resource. In the following resources, SectionName is
  1101.                         interpreted as the following: \n * Gateway: Listener Name
  1102.                         \n Implementations MAY choose to support attaching Routes
  1103.                         to other resources. If that is the case, they MUST clearly
  1104.                         document how SectionName is interpreted. \n When unspecified
  1105.                         (empty string), this will reference the entire resource. For
  1106.                         the purpose of status, an attachment is considered successful
  1107.                         if at least one section in the parent resource accepts it.
  1108.                         For example, Gateway listeners can restrict which Routes can
  1109.                         attach to them by Route kind, namespace, or hostname. If 1
  1110.                         of 2 Gateway listeners accept attachment from the referencing
  1111.                         Route, the Route MUST be considered successfully attached.
  1112.                         If no Gateway listeners accept attachment from this Route,
  1113.                         the Route MUST be considered detached from the Gateway. \n
  1114.                         Support: Core"
  1115.                       maxLength: 253
  1116.                       minLength: 1
  1117.                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1118.                       type: string
  1119.                   required:
  1120.                   - name
  1121.                   type: object
  1122.                 maxItems: 32
  1123.                 type: array
  1124.               rules:
  1125.                 default:
  1126.                 - matches:
  1127.                   - path:
  1128.                       type: PathPrefix
  1129.                       value: /
  1130.                 description: Rules are a list of HTTP matchers, filters and actions.
  1131.                 items:
  1132.                   description: HTTPRouteRule defines semantics for matching an HTTP
  1133.                     request based on conditions (matches), processing it (filters),
  1134.                     and forwarding the request to an API object (backendRefs).
  1135.                   properties:
  1136.                     backendRefs:
  1137.                       description: "If unspecified or invalid (refers to a non-existent
  1138.                         resource or a Service with no endpoints), the rule performs
  1139.                         no forwarding. If there are also no filters specified that
  1140.                         would result in a response being sent, a HTTP 503 status code
  1141.                         is returned. 503 responses must be sent so that the overall
  1142.                         weight is respected; if an invalid backend is requested to
  1143.                         have 80% of requests, then 80% of requests must get a 503
  1144.                         instead. \n Support: Core for Kubernetes Service Support:
  1145.                         Custom for any other resource \n Support for weight: Core"
  1146.                       items:
  1147.                         description: HTTPBackendRef defines how a HTTPRoute should
  1148.                           forward an HTTP request.
  1149.                         properties:
  1150.                           filters:
  1151.                             description: "Filters defined at this level should be
  1152.                               executed if and only if the request is being forwarded
  1153.                               to the backend defined here. \n Support: Custom (For
  1154.                               broader support of filters, use the Filters field in
  1155.                               HTTPRouteRule.)"
  1156.                             items:
  1157.                               description: HTTPRouteFilter defines processing steps
  1158.                                 that must be completed during the request or response
  1159.                                 lifecycle. HTTPRouteFilters are meant as an extension
  1160.                                 point to express processing that may be done in Gateway
  1161.                                 implementations. Some examples include request or
  1162.                                 response modification, implementing authentication
  1163.                                 strategies, rate-limiting, and traffic shaping. API
  1164.                                 guarantee/conformance is defined based on the type
  1165.                                 of the filter.
  1166.                               properties:
  1167.                                 extensionRef:
  1168.                                   description: "ExtensionRef is an optional, implementation-specific
  1169.                                     extension to the \"filter\" behavior.  For example,
  1170.                                     resource \"myroutefilter\" in group \"networking.example.net\").
  1171.                                     ExtensionRef MUST NOT be used for core and extended
  1172.                                     filters. \n Support: Implementation-specific"
  1173.                                   properties:
  1174.                                     group:
  1175.                                       description: Group is the group of the referent.
  1176.                                         For example, "networking.k8s.io". When unspecified
  1177.                                         (empty string), core API group is inferred.
  1178.                                       maxLength: 253
  1179.                                       pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1180.                                       type: string
  1181.                                     kind:
  1182.                                       description: Kind is kind of the referent. For
  1183.                                         example "HTTPRoute" or "Service".
  1184.                                       maxLength: 63
  1185.                                       minLength: 1
  1186.                                       pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1187.                                       type: string
  1188.                                     name:
  1189.                                       description: Name is the name of the referent.
  1190.                                       maxLength: 253
  1191.                                       minLength: 1
  1192.                                       type: string
  1193.                                   required:
  1194.                                   - group
  1195.                                   - kind
  1196.                                   - name
  1197.                                   type: object
  1198.                                 requestHeaderModifier:
  1199.                                   description: "RequestHeaderModifier defines a schema
  1200.                                     for a filter that modifies request headers. \n
  1201.                                     Support: Core"
  1202.                                   properties:
  1203.                                     add:
  1204.                                       description: "Add adds the given header(s) (name,
  1205.                                         value) to the request before the action. It
  1206.                                         appends to any existing values associated
  1207.                                         with the header name. \n Input:   GET /foo
  1208.                                         HTTP/1.1   my-header: foo \n Config:   add:
  1209.                                         \  - name: \"my-header\"     value: \"bar\"
  1210.                                         \n Output:   GET /foo HTTP/1.1   my-header:
  1211.                                         foo   my-header: bar"
  1212.                                       items:
  1213.                                         description: HTTPHeader represents an HTTP
  1214.                                           Header name and value as defined by RFC
  1215.                                           7230.
  1216.                                         properties:
  1217.                                           name:
  1218.                                             description: "Name is the name of the
  1219.                                               HTTP Header to be matched. Name matching
  1220.                                               MUST be case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
  1221.                                               \n If multiple entries specify equivalent
  1222.                                               header names, the first entry with an
  1223.                                               equivalent name MUST be considered for
  1224.                                               a match. Subsequent entries with an
  1225.                                               equivalent header name MUST be ignored.
  1226.                                               Due to the case-insensitivity of header
  1227.                                               names, \"foo\" and \"Foo\" are considered
  1228.                                               equivalent."
  1229.                                             maxLength: 256
  1230.                                             minLength: 1
  1231.                                             pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
  1232.                                             type: string
  1233.                                           value:
  1234.                                             description: Value is the value of HTTP
  1235.                                               Header to be matched.
  1236.                                             maxLength: 4096
  1237.                                             minLength: 1
  1238.                                             type: string
  1239.                                         required:
  1240.                                         - name
  1241.                                         - value
  1242.                                         type: object
  1243.                                       maxItems: 16
  1244.                                       type: array
  1245.                                       x-kubernetes-list-map-keys:
  1246.                                       - name
  1247.                                       x-kubernetes-list-type: map
  1248.                                     remove:
  1249.                                       description: "Remove the given header(s) from
  1250.                                         the HTTP request before the action. The value
  1251.                                         of Remove is a list of HTTP header names.
  1252.                                         Note that the header names are case-insensitive
  1253.                                         (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
  1254.                                         \n Input:   GET /foo HTTP/1.1   my-header1:
  1255.                                         foo   my-header2: bar   my-header3: baz \n
  1256.                                         Config:   remove: [\"my-header1\", \"my-header3\"]
  1257.                                         \n Output:   GET /foo HTTP/1.1   my-header2:
  1258.                                         bar"
  1259.                                       items:
  1260.                                         type: string
  1261.                                       maxItems: 16
  1262.                                       type: array
  1263.                                     set:
  1264.                                       description: "Set overwrites the request with
  1265.                                         the given header (name, value) before the
  1266.                                         action. \n Input:   GET /foo HTTP/1.1   my-header:
  1267.                                         foo \n Config:   set:   - name: \"my-header\"
  1268.                                         \    value: \"bar\" \n Output:   GET /foo
  1269.                                         HTTP/1.1   my-header: bar"
  1270.                                       items:
  1271.                                         description: HTTPHeader represents an HTTP
  1272.                                           Header name and value as defined by RFC
  1273.                                           7230.
  1274.                                         properties:
  1275.                                           name:
  1276.                                             description: "Name is the name of the
  1277.                                               HTTP Header to be matched. Name matching
  1278.                                               MUST be case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
  1279.                                               \n If multiple entries specify equivalent
  1280.                                               header names, the first entry with an
  1281.                                               equivalent name MUST be considered for
  1282.                                               a match. Subsequent entries with an
  1283.                                               equivalent header name MUST be ignored.
  1284.                                               Due to the case-insensitivity of header
  1285.                                               names, \"foo\" and \"Foo\" are considered
  1286.                                               equivalent."
  1287.                                             maxLength: 256
  1288.                                             minLength: 1
  1289.                                             pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
  1290.                                             type: string
  1291.                                           value:
  1292.                                             description: Value is the value of HTTP
  1293.                                               Header to be matched.
  1294.                                             maxLength: 4096
  1295.                                             minLength: 1
  1296.                                             type: string
  1297.                                         required:
  1298.                                         - name
  1299.                                         - value
  1300.                                         type: object
  1301.                                       maxItems: 16
  1302.                                       type: array
  1303.                                       x-kubernetes-list-map-keys:
  1304.                                       - name
  1305.                                       x-kubernetes-list-type: map
  1306.                                   type: object
  1307.                                 requestMirror:
  1308.                                   description: "RequestMirror defines a schema for
  1309.                                     a filter that mirrors requests. Requests are sent
  1310.                                     to the specified destination, but responses from
  1311.                                     that destination are ignored. \n Support: Extended"
  1312.                                   properties:
  1313.                                     backendRef:
  1314.                                       description: "BackendRef references a resource
  1315.                                         where mirrored requests are sent. \n If the
  1316.                                         referent cannot be found, this BackendRef
  1317.                                         is invalid and must be dropped from the Gateway.
  1318.                                         The controller must ensure the \"ResolvedRefs\"
  1319.                                         condition on the Route status is set to `status:
  1320.                                         False` and not configure this backend in the
  1321.                                         underlying implementation. \n If there is
  1322.                                         a cross-namespace reference to an *existing*
  1323.                                         object that is not allowed by a ReferencePolicy,
  1324.                                         the controller must ensure the \"ResolvedRefs\"
  1325.                                         \ condition on the Route is set to `status:
  1326.                                         False`, with the \"RefNotPermitted\" reason
  1327.                                         and not configure this backend in the underlying
  1328.                                         implementation. \n In either error case, the
  1329.                                         Message of the `ResolvedRefs` Condition should
  1330.                                         be used to provide more detail about the problem.
  1331.                                         \n Support: Extended for Kubernetes Service
  1332.                                         Support: Custom for any other resource"
  1333.                                       properties:
  1334.                                         group:
  1335.                                           default: ""
  1336.                                           description: Group is the group of the referent.
  1337.                                             For example, "networking.k8s.io". When
  1338.                                             unspecified (empty string), core API group
  1339.                                             is inferred.
  1340.                                           maxLength: 253
  1341.                                           pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1342.                                           type: string
  1343.                                         kind:
  1344.                                           default: Service
  1345.                                           description: Kind is kind of the referent.
  1346.                                             For example "HTTPRoute" or "Service".
  1347.                                           maxLength: 63
  1348.                                           minLength: 1
  1349.                                           pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1350.                                           type: string
  1351.                                         name:
  1352.                                           description: Name is the name of the referent.
  1353.                                           maxLength: 253
  1354.                                           minLength: 1
  1355.                                           type: string
  1356.                                         namespace:
  1357.                                           description: "Namespace is the namespace
  1358.                                             of the backend. When unspecified, the
  1359.                                             local namespace is inferred. \n Note that
  1360.                                             when a namespace is specified, a ReferencePolicy
  1361.                                             object is required in the referent namespace
  1362.                                             to allow that namespace's owner to accept
  1363.                                             the reference. See the ReferencePolicy
  1364.                                             documentation for details. \n Support:
  1365.                                             Core"
  1366.                                           maxLength: 63
  1367.                                           minLength: 1
  1368.                                           pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1369.                                           type: string
  1370.                                         port:
  1371.                                           description: Port specifies the destination
  1372.                                             port number to use for this resource.
  1373.                                             Port is required when the referent is
  1374.                                             a Kubernetes Service. For other resources,
  1375.                                             destination port might be derived from
  1376.                                             the referent resource or this field.
  1377.                                           format: int32
  1378.                                           maximum: 65535
  1379.                                           minimum: 1
  1380.                                           type: integer
  1381.                                       required:
  1382.                                       - name
  1383.                                       type: object
  1384.                                   required:
  1385.                                   - backendRef
  1386.                                   type: object
  1387.                                 requestRedirect:
  1388.                                   description: "RequestRedirect defines a schema for
  1389.                                     a filter that responds to the request with an
  1390.                                     HTTP redirection. \n Support: Core"
  1391.                                   properties:
  1392.                                     hostname:
  1393.                                       description: "Hostname is the hostname to be
  1394.                                         used in the value of the `Location` header
  1395.                                         in the response. When empty, the hostname
  1396.                                         of the request is used. \n Support: Core"
  1397.                                       maxLength: 253
  1398.                                       minLength: 1
  1399.                                       pattern: ^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1400.                                       type: string
  1401.                                     port:
  1402.                                       description: "Port is the port to be used in
  1403.                                         the value of the `Location` header in the
  1404.                                         response. When empty, port (if specified)
  1405.                                         of the request is used. \n Support: Extended"
  1406.                                       format: int32
  1407.                                       maximum: 65535
  1408.                                       minimum: 1
  1409.                                       type: integer
  1410.                                     scheme:
  1411.                                       description: "Scheme is the scheme to be used
  1412.                                         in the value of the `Location` header in the
  1413.                                         response. When empty, the scheme of the request
  1414.                                         is used. \n Support: Extended"
  1415.                                       enum:
  1416.                                       - http
  1417.                                       - https
  1418.                                       type: string
  1419.                                     statusCode:
  1420.                                       default: 302
  1421.                                       description: "StatusCode is the HTTP status
  1422.                                         code to be used in response. \n Support: Core"
  1423.                                       enum:
  1424.                                       - 301
  1425.                                       - 302
  1426.                                       type: integer
  1427.                                   type: object
  1428.                                 type:
  1429.                                   description: "Type identifies the type of filter
  1430.                                     to apply. As with other API fields, types are
  1431.                                     classified into three conformance levels: \n -
  1432.                                     Core: Filter types and their corresponding configuration
  1433.                                     defined by   \"Support: Core\" in this package,
  1434.                                     e.g. \"RequestHeaderModifier\". All   implementations
  1435.                                     must support core filters. \n - Extended: Filter
  1436.                                     types and their corresponding configuration defined
  1437.                                     by   \"Support: Extended\" in this package, e.g.
  1438.                                     \"RequestMirror\". Implementers   are encouraged
  1439.                                     to support extended filters. \n - Custom: Filters
  1440.                                     that are defined and supported by specific vendors.
  1441.                                     \  In the future, filters showing convergence
  1442.                                     in behavior across multiple   implementations
  1443.                                     will be considered for inclusion in extended or
  1444.                                     core   conformance levels. Filter-specific configuration
  1445.                                     for such filters   is specified using the ExtensionRef
  1446.                                     field. `Type` should be set to   \"ExtensionRef\"
  1447.                                     for custom filters. \n Implementers are encouraged
  1448.                                     to define custom implementation types to extend
  1449.                                     the core API with implementation-specific behavior.
  1450.                                     \n If a reference to a custom filter type cannot
  1451.                                     be resolved, the filter MUST NOT be skipped. Instead,
  1452.                                     requests that would have been processed by that
  1453.                                     filter MUST receive a HTTP error response."
  1454.                                   enum:
  1455.                                   - RequestHeaderModifier
  1456.                                   - RequestMirror
  1457.                                   - RequestRedirect
  1458.                                   - ExtensionRef
  1459.                                   type: string
  1460.                               required:
  1461.                               - type
  1462.                               type: object
  1463.                             maxItems: 16
  1464.                             type: array
  1465.                           group:
  1466.                             default: ""
  1467.                             description: Group is the group of the referent. For example,
  1468.                               "networking.k8s.io". When unspecified (empty string),
  1469.                               core API group is inferred.
  1470.                             maxLength: 253
  1471.                             pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1472.                             type: string
  1473.                           kind:
  1474.                             default: Service
  1475.                             description: Kind is kind of the referent. For example
  1476.                               "HTTPRoute" or "Service".
  1477.                             maxLength: 63
  1478.                             minLength: 1
  1479.                             pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1480.                             type: string
  1481.                           name:
  1482.                             description: Name is the name of the referent.
  1483.                             maxLength: 253
  1484.                             minLength: 1
  1485.                             type: string
  1486.                           namespace:
  1487.                             description: "Namespace is the namespace of the backend.
  1488.                               When unspecified, the local namespace is inferred. \n
  1489.                               Note that when a namespace is specified, a ReferencePolicy
  1490.                               object is required in the referent namespace to allow
  1491.                               that namespace's owner to accept the reference. See
  1492.                               the ReferencePolicy documentation for details. \n Support:
  1493.                               Core"
  1494.                             maxLength: 63
  1495.                             minLength: 1
  1496.                             pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1497.                             type: string
  1498.                           port:
  1499.                             description: Port specifies the destination port number
  1500.                               to use for this resource. Port is required when the
  1501.                               referent is a Kubernetes Service. For other resources,
  1502.                               destination port might be derived from the referent
  1503.                               resource or this field.
  1504.                             format: int32
  1505.                             maximum: 65535
  1506.                             minimum: 1
  1507.                             type: integer
  1508.                           weight:
  1509.                             default: 1
  1510.                             description: "Weight specifies the proportion of requests
  1511.                               forwarded to the referenced backend. This is computed
  1512.                               as weight/(sum of all weights in this BackendRefs list).
  1513.                               For non-zero values, there may be some epsilon from
  1514.                               the exact proportion defined here depending on the precision
  1515.                               an implementation supports. Weight is not a percentage
  1516.                               and the sum of weights does not need to equal 100. \n
  1517.                               If only one backend is specified and it has a weight
  1518.                               greater than 0, 100% of the traffic is forwarded to
  1519.                               that backend. If weight is set to 0, no traffic should
  1520.                               be forwarded for this entry. If unspecified, weight
  1521.                               defaults to 1. \n Support for this field varies based
  1522.                               on the context where used."
  1523.                             format: int32
  1524.                             maximum: 1000000
  1525.                             minimum: 0
  1526.                             type: integer
  1527.                         required:
  1528.                         - name
  1529.                         type: object
  1530.                       maxItems: 16
  1531.                       type: array
  1532.                     filters:
  1533.                       description: "Filters define the filters that are applied to
  1534.                         requests that match this rule. \n The effects of ordering
  1535.                         of multiple behaviors are currently unspecified. This can
  1536.                         change in the future based on feedback during the alpha stage.
  1537.                         \n Conformance-levels at this level are defined based on the
  1538.                         type of filter: \n - ALL core filters MUST be supported by
  1539.                         all implementations. - Implementers are encouraged to support
  1540.                         extended filters. - Implementation-specific custom filters
  1541.                         have no API guarantees across   implementations. \n Specifying
  1542.                         a core filter multiple times has unspecified or custom conformance.
  1543.                         \n Support: Core"
  1544.                       items:
  1545.                         description: HTTPRouteFilter defines processing steps that
  1546.                           must be completed during the request or response lifecycle.
  1547.                           HTTPRouteFilters are meant as an extension point to express
  1548.                           processing that may be done in Gateway implementations.
  1549.                           Some examples include request or response modification,
  1550.                           implementing authentication strategies, rate-limiting, and
  1551.                           traffic shaping. API guarantee/conformance is defined based
  1552.                           on the type of the filter.
  1553.                         properties:
  1554.                           extensionRef:
  1555.                             description: "ExtensionRef is an optional, implementation-specific
  1556.                               extension to the \"filter\" behavior.  For example,
  1557.                               resource \"myroutefilter\" in group \"networking.example.net\").
  1558.                               ExtensionRef MUST NOT be used for core and extended
  1559.                               filters. \n Support: Implementation-specific"
  1560.                             properties:
  1561.                               group:
  1562.                                 description: Group is the group of the referent. For
  1563.                                   example, "networking.k8s.io". When unspecified (empty
  1564.                                   string), core API group is inferred.
  1565.                                 maxLength: 253
  1566.                                 pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1567.                                 type: string
  1568.                               kind:
  1569.                                 description: Kind is kind of the referent. For example
  1570.                                   "HTTPRoute" or "Service".
  1571.                                 maxLength: 63
  1572.                                 minLength: 1
  1573.                                 pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1574.                                 type: string
  1575.                               name:
  1576.                                 description: Name is the name of the referent.
  1577.                                 maxLength: 253
  1578.                                 minLength: 1
  1579.                                 type: string
  1580.                             required:
  1581.                             - group
  1582.                             - kind
  1583.                             - name
  1584.                             type: object
  1585.                           requestHeaderModifier:
  1586.                             description: "RequestHeaderModifier defines a schema for
  1587.                               a filter that modifies request headers. \n Support:
  1588.                               Core"
  1589.                             properties:
  1590.                               add:
  1591.                                 description: "Add adds the given header(s) (name,
  1592.                                   value) to the request before the action. It appends
  1593.                                   to any existing values associated with the header
  1594.                                   name. \n Input:   GET /foo HTTP/1.1   my-header:
  1595.                                   foo \n Config:   add:   - name: \"my-header\"     value:
  1596.                                   \"bar\" \n Output:   GET /foo HTTP/1.1   my-header:
  1597.                                   foo   my-header: bar"
  1598.                                 items:
  1599.                                   description: HTTPHeader represents an HTTP Header
  1600.                                     name and value as defined by RFC 7230.
  1601.                                   properties:
  1602.                                     name:
  1603.                                       description: "Name is the name of the HTTP Header
  1604.                                         to be matched. Name matching MUST be case
  1605.                                         insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
  1606.                                         \n If multiple entries specify equivalent
  1607.                                         header names, the first entry with an equivalent
  1608.                                         name MUST be considered for a match. Subsequent
  1609.                                         entries with an equivalent header name MUST
  1610.                                         be ignored. Due to the case-insensitivity
  1611.                                         of header names, \"foo\" and \"Foo\" are considered
  1612.                                         equivalent."
  1613.                                       maxLength: 256
  1614.                                       minLength: 1
  1615.                                       pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
  1616.                                       type: string
  1617.                                     value:
  1618.                                       description: Value is the value of HTTP Header
  1619.                                         to be matched.
  1620.                                       maxLength: 4096
  1621.                                       minLength: 1
  1622.                                       type: string
  1623.                                   required:
  1624.                                   - name
  1625.                                   - value
  1626.                                   type: object
  1627.                                 maxItems: 16
  1628.                                 type: array
  1629.                                 x-kubernetes-list-map-keys:
  1630.                                 - name
  1631.                                 x-kubernetes-list-type: map
  1632.                               remove:
  1633.                                 description: "Remove the given header(s) from the
  1634.                                   HTTP request before the action. The value of Remove
  1635.                                   is a list of HTTP header names. Note that the header
  1636.                                   names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
  1637.                                   \n Input:   GET /foo HTTP/1.1   my-header1: foo
  1638.                                   \  my-header2: bar   my-header3: baz \n Config:
  1639.                                   \  remove: [\"my-header1\", \"my-header3\"] \n Output:
  1640.                                   \  GET /foo HTTP/1.1   my-header2: bar"
  1641.                                 items:
  1642.                                   type: string
  1643.                                 maxItems: 16
  1644.                                 type: array
  1645.                               set:
  1646.                                 description: "Set overwrites the request with the
  1647.                                   given header (name, value) before the action. \n
  1648.                                   Input:   GET /foo HTTP/1.1   my-header: foo \n Config:
  1649.                                   \  set:   - name: \"my-header\"     value: \"bar\"
  1650.                                   \n Output:   GET /foo HTTP/1.1   my-header: bar"
  1651.                                 items:
  1652.                                   description: HTTPHeader represents an HTTP Header
  1653.                                     name and value as defined by RFC 7230.
  1654.                                   properties:
  1655.                                     name:
  1656.                                       description: "Name is the name of the HTTP Header
  1657.                                         to be matched. Name matching MUST be case
  1658.                                         insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
  1659.                                         \n If multiple entries specify equivalent
  1660.                                         header names, the first entry with an equivalent
  1661.                                         name MUST be considered for a match. Subsequent
  1662.                                         entries with an equivalent header name MUST
  1663.                                         be ignored. Due to the case-insensitivity
  1664.                                         of header names, \"foo\" and \"Foo\" are considered
  1665.                                         equivalent."
  1666.                                       maxLength: 256
  1667.                                       minLength: 1
  1668.                                       pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
  1669.                                       type: string
  1670.                                     value:
  1671.                                       description: Value is the value of HTTP Header
  1672.                                         to be matched.
  1673.                                       maxLength: 4096
  1674.                                       minLength: 1
  1675.                                       type: string
  1676.                                   required:
  1677.                                   - name
  1678.                                   - value
  1679.                                   type: object
  1680.                                 maxItems: 16
  1681.                                 type: array
  1682.                                 x-kubernetes-list-map-keys:
  1683.                                 - name
  1684.                                 x-kubernetes-list-type: map
  1685.                             type: object
  1686.                           requestMirror:
  1687.                             description: "RequestMirror defines a schema for a filter
  1688.                               that mirrors requests. Requests are sent to the specified
  1689.                               destination, but responses from that destination are
  1690.                               ignored. \n Support: Extended"
  1691.                             properties:
  1692.                               backendRef:
  1693.                                 description: "BackendRef references a resource where
  1694.                                   mirrored requests are sent. \n If the referent cannot
  1695.                                   be found, this BackendRef is invalid and must be
  1696.                                   dropped from the Gateway. The controller must ensure
  1697.                                   the \"ResolvedRefs\" condition on the Route status
  1698.                                   is set to `status: False` and not configure this
  1699.                                   backend in the underlying implementation. \n If
  1700.                                   there is a cross-namespace reference to an *existing*
  1701.                                   object that is not allowed by a ReferencePolicy,
  1702.                                   the controller must ensure the \"ResolvedRefs\"
  1703.                                   \ condition on the Route is set to `status: False`,
  1704.                                   with the \"RefNotPermitted\" reason and not configure
  1705.                                   this backend in the underlying implementation. \n
  1706.                                   In either error case, the Message of the `ResolvedRefs`
  1707.                                   Condition should be used to provide more detail
  1708.                                   about the problem. \n Support: Extended for Kubernetes
  1709.                                   Service Support: Custom for any other resource"
  1710.                                 properties:
  1711.                                   group:
  1712.                                     default: ""
  1713.                                     description: Group is the group of the referent.
  1714.                                       For example, "networking.k8s.io". When unspecified
  1715.                                       (empty string), core API group is inferred.
  1716.                                     maxLength: 253
  1717.                                     pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1718.                                     type: string
  1719.                                   kind:
  1720.                                     default: Service
  1721.                                     description: Kind is kind of the referent. For
  1722.                                       example "HTTPRoute" or "Service".
  1723.                                     maxLength: 63
  1724.                                     minLength: 1
  1725.                                     pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  1726.                                     type: string
  1727.                                   name:
  1728.                                     description: Name is the name of the referent.
  1729.                                     maxLength: 253
  1730.                                     minLength: 1
  1731.                                     type: string
  1732.                                   namespace:
  1733.                                     description: "Namespace is the namespace of the
  1734.                                       backend. When unspecified, the local namespace
  1735.                                       is inferred. \n Note that when a namespace is
  1736.                                       specified, a ReferencePolicy object is required
  1737.                                       in the referent namespace to allow that namespace's
  1738.                                       owner to accept the reference. See the ReferencePolicy
  1739.                                       documentation for details. \n Support: Core"
  1740.                                     maxLength: 63
  1741.                                     minLength: 1
  1742.                                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1743.                                     type: string
  1744.                                   port:
  1745.                                     description: Port specifies the destination port
  1746.                                       number to use for this resource. Port is required
  1747.                                       when the referent is a Kubernetes Service. For
  1748.                                       other resources, destination port might be derived
  1749.                                       from the referent resource or this field.
  1750.                                     format: int32
  1751.                                     maximum: 65535
  1752.                                     minimum: 1
  1753.                                     type: integer
  1754.                                 required:
  1755.                                 - name
  1756.                                 type: object
  1757.                             required:
  1758.                             - backendRef
  1759.                             type: object
  1760.                           requestRedirect:
  1761.                             description: "RequestRedirect defines a schema for a filter
  1762.                               that responds to the request with an HTTP redirection.
  1763.                               \n Support: Core"
  1764.                             properties:
  1765.                               hostname:
  1766.                                 description: "Hostname is the hostname to be used
  1767.                                   in the value of the `Location` header in the response.
  1768.                                   When empty, the hostname of the request is used.
  1769.                                   \n Support: Core"
  1770.                                 maxLength: 253
  1771.                                 minLength: 1
  1772.                                 pattern: ^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1773.                                 type: string
  1774.                               port:
  1775.                                 description: "Port is the port to be used in the value
  1776.                                   of the `Location` header in the response. When empty,
  1777.                                   port (if specified) of the request is used. \n Support:
  1778.                                   Extended"
  1779.                                 format: int32
  1780.                                 maximum: 65535
  1781.                                 minimum: 1
  1782.                                 type: integer
  1783.                               scheme:
  1784.                                 description: "Scheme is the scheme to be used in the
  1785.                                   value of the `Location` header in the response.
  1786.                                   When empty, the scheme of the request is used. \n
  1787.                                   Support: Extended"
  1788.                                 enum:
  1789.                                 - http
  1790.                                 - https
  1791.                                 type: string
  1792.                               statusCode:
  1793.                                 default: 302
  1794.                                 description: "StatusCode is the HTTP status code to
  1795.                                   be used in response. \n Support: Core"
  1796.                                 enum:
  1797.                                 - 301
  1798.                                 - 302
  1799.                                 type: integer
  1800.                             type: object
  1801.                           type:
  1802.                             description: "Type identifies the type of filter to apply.
  1803.                               As with other API fields, types are classified into
  1804.                               three conformance levels: \n - Core: Filter types and
  1805.                               their corresponding configuration defined by   \"Support:
  1806.                               Core\" in this package, e.g. \"RequestHeaderModifier\".
  1807.                               All   implementations must support core filters. \n
  1808.                               - Extended: Filter types and their corresponding configuration
  1809.                               defined by   \"Support: Extended\" in this package,
  1810.                               e.g. \"RequestMirror\". Implementers   are encouraged
  1811.                               to support extended filters. \n - Custom: Filters that
  1812.                               are defined and supported by specific vendors.   In
  1813.                               the future, filters showing convergence in behavior
  1814.                               across multiple   implementations will be considered
  1815.                               for inclusion in extended or core   conformance levels.
  1816.                               Filter-specific configuration for such filters   is
  1817.                               specified using the ExtensionRef field. `Type` should
  1818.                               be set to   \"ExtensionRef\" for custom filters. \n
  1819.                               Implementers are encouraged to define custom implementation
  1820.                               types to extend the core API with implementation-specific
  1821.                               behavior. \n If a reference to a custom filter type
  1822.                               cannot be resolved, the filter MUST NOT be skipped.
  1823.                               Instead, requests that would have been processed by
  1824.                               that filter MUST receive a HTTP error response."
  1825.                             enum:
  1826.                             - RequestHeaderModifier
  1827.                             - RequestMirror
  1828.                             - RequestRedirect
  1829.                             - ExtensionRef
  1830.                             type: string
  1831.                         required:
  1832.                         - type
  1833.                         type: object
  1834.                       maxItems: 16
  1835.                       type: array
  1836.                     matches:
  1837.                       default:
  1838.                       - path:
  1839.                           type: PathPrefix
  1840.                           value: /
  1841.                       description: "Matches define conditions used for matching the
  1842.                         rule against incoming HTTP requests. Each match is independent,
  1843.                         i.e. this rule will be matched if **any** one of the matches
  1844.                         is satisfied. \n For example, take the following matches configuration:
  1845.                         \n ``` matches: - path:     value: \"/foo\"   headers:   -
  1846.                         name: \"version\"     value: \"v2\" - path:     value: \"/v2/foo\"
  1847.                         ``` \n For a request to match against this rule, a request
  1848.                         must satisfy EITHER of the two conditions: \n - path prefixed
  1849.                         with `/foo` AND contains the header `version: v2` - path prefix
  1850.                         of `/v2/foo` \n See the documentation for HTTPRouteMatch on
  1851.                         how to specify multiple match conditions that should be ANDed
  1852.                         together. \n If no matches are specified, the default is a
  1853.                         prefix path match on \"/\", which has the effect of matching
  1854.                         every HTTP request. \n Proxy or Load Balancer routing configuration
  1855.                         generated from HTTPRoutes MUST prioritize rules based on the
  1856.                         following criteria, continuing on ties. Precedence must be
  1857.                         given to the the Rule with the largest number of: \n * Characters
  1858.                         in a matching non-wildcard hostname. * Characters in a matching
  1859.                         hostname. * Characters in a matching path. * Header matches.
  1860.                         * Query param matches. \n If ties still exist across multiple
  1861.                         Routes, matching precedence MUST be determined in order of
  1862.                         the following criteria, continuing on ties: \n * The oldest
  1863.                         Route based on creation timestamp. * The Route appearing first
  1864.                         in alphabetical order by   \"<namespace>/<name>\". \n If ties
  1865.                         still exist within the Route that has been given precedence,
  1866.                         matching precedence MUST be granted to the first matching
  1867.                         rule meeting the above criteria."
  1868.                       items:
  1869.                         description: "HTTPRouteMatch defines the predicate used to
  1870.                           match requests to a given action. Multiple match types are
  1871.                           ANDed together, i.e. the match will evaluate to true only
  1872.                           if all conditions are satisfied. \n For example, the match
  1873.                           below will match a HTTP request only if its path starts
  1874.                           with `/foo` AND it contains the `version: v1` header: \n
  1875.                           ``` match:   path:     value: \"/foo\"   headers:   - name:
  1876.                           \"version\"     value \"v1\" ```"
  1877.                         properties:
  1878.                           headers:
  1879.                             description: Headers specifies HTTP request header matchers.
  1880.                               Multiple match values are ANDed together, meaning, a
  1881.                               request must match all the specified headers to select
  1882.                               the route.
  1883.                             items:
  1884.                               description: HTTPHeaderMatch describes how to select
  1885.                                 a HTTP route by matching HTTP request headers.
  1886.                               properties:
  1887.                                 name:
  1888.                                   description: "Name is the name of the HTTP Header
  1889.                                     to be matched. Name matching MUST be case insensitive.
  1890.                                     (See https://tools.ietf.org/html/rfc7230#section-3.2).
  1891.                                     \n If multiple entries specify equivalent header
  1892.                                     names, only the first entry with an equivalent
  1893.                                     name MUST be considered for a match. Subsequent
  1894.                                     entries with an equivalent header name MUST be
  1895.                                     ignored. Due to the case-insensitivity of header
  1896.                                     names, \"foo\" and \"Foo\" are considered equivalent.
  1897.                                     \n When a header is repeated in an HTTP request,
  1898.                                     it is implementation-specific behavior as to how
  1899.                                     this is represented. Generally, proxies should
  1900.                                     follow the guidance from the RFC: https://www.rfc-editor.org/rfc/rfc7230.html#section-3.2.2
  1901.                                     regarding processing a repeated header, with special
  1902.                                     handling for \"Set-Cookie\"."
  1903.                                   maxLength: 256
  1904.                                   minLength: 1
  1905.                                   pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
  1906.                                   type: string
  1907.                                 type:
  1908.                                   default: Exact
  1909.                                   description: "Type specifies how to match against
  1910.                                     the value of the header. \n Support: Core (Exact)
  1911.                                     \n Support: Custom (RegularExpression) \n Since
  1912.                                     RegularExpression HeaderMatchType has custom conformance,
  1913.                                     implementations can support POSIX, PCRE or any
  1914.                                     other dialects of regular expressions. Please
  1915.                                     read the implementation's documentation to determine
  1916.                                     the supported dialect."
  1917.                                   enum:
  1918.                                   - Exact
  1919.                                   - RegularExpression
  1920.                                   type: string
  1921.                                 value:
  1922.                                   description: Value is the value of HTTP Header to
  1923.                                     be matched.
  1924.                                   maxLength: 4096
  1925.                                   minLength: 1
  1926.                                   type: string
  1927.                               required:
  1928.                               - name
  1929.                               - value
  1930.                               type: object
  1931.                             maxItems: 16
  1932.                             type: array
  1933.                             x-kubernetes-list-map-keys:
  1934.                             - name
  1935.                             x-kubernetes-list-type: map
  1936.                           method:
  1937.                             description: "Method specifies HTTP method matcher. When
  1938.                               specified, this route will be matched only if the request
  1939.                               has the specified method. \n Support: Extended"
  1940.                             enum:
  1941.                             - GET
  1942.                             - HEAD
  1943.                             - POST
  1944.                             - PUT
  1945.                             - DELETE
  1946.                             - CONNECT
  1947.                             - OPTIONS
  1948.                             - TRACE
  1949.                             - PATCH
  1950.                             type: string
  1951.                           path:
  1952.                             default:
  1953.                               type: PathPrefix
  1954.                               value: /
  1955.                             description: Path specifies a HTTP request path matcher.
  1956.                               If this field is not specified, a default prefix match
  1957.                               on the "/" path is provided.
  1958.                             properties:
  1959.                               type:
  1960.                                 default: PathPrefix
  1961.                                 description: "Type specifies how to match against
  1962.                                   the path Value. \n Support: Core (Exact, PathPrefix)
  1963.                                   \n Support: Custom (RegularExpression)"
  1964.                                 enum:
  1965.                                 - Exact
  1966.                                 - PathPrefix
  1967.                                 - RegularExpression
  1968.                                 type: string
  1969.                               value:
  1970.                                 default: /
  1971.                                 description: Value of the HTTP path to match against.
  1972.                                 maxLength: 1024
  1973.                                 type: string
  1974.                             type: object
  1975.                           queryParams:
  1976.                             description: QueryParams specifies HTTP query parameter
  1977.                               matchers. Multiple match values are ANDed together,
  1978.                               meaning, a request must match all the specified query
  1979.                               parameters to select the route.
  1980.                             items:
  1981.                               description: HTTPQueryParamMatch describes how to select
  1982.                                 a HTTP route by matching HTTP query parameters.
  1983.                               properties:
  1984.                                 name:
  1985.                                   description: Name is the name of the HTTP query
  1986.                                     param to be matched. This must be an exact string
  1987.                                     match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).
  1988.                                   maxLength: 256
  1989.                                   minLength: 1
  1990.                                   type: string
  1991.                                 type:
  1992.                                   default: Exact
  1993.                                   description: "Type specifies how to match against
  1994.                                     the value of the query parameter. \n Support:
  1995.                                     Extended (Exact) \n Support: Custom (RegularExpression)
  1996.                                     \n Since RegularExpression QueryParamMatchType
  1997.                                     has custom conformance, implementations can support
  1998.                                     POSIX, PCRE or any other dialects of regular expressions.
  1999.                                     Please read the implementation's documentation
  2000.                                     to determine the supported dialect."
  2001.                                   enum:
  2002.                                   - Exact
  2003.                                   - RegularExpression
  2004.                                   type: string
  2005.                                 value:
  2006.                                   description: Value is the value of HTTP query param
  2007.                                     to be matched.
  2008.                                   maxLength: 1024
  2009.                                   minLength: 1
  2010.                                   type: string
  2011.                               required:
  2012.                               - name
  2013.                               - value
  2014.                               type: object
  2015.                             maxItems: 16
  2016.                             type: array
  2017.                             x-kubernetes-list-map-keys:
  2018.                             - name
  2019.                             x-kubernetes-list-type: map
  2020.                         type: object
  2021.                       maxItems: 8
  2022.                       type: array
  2023.                   type: object
  2024.                 maxItems: 16
  2025.                 type: array
  2026.             type: object
  2027.           status:
  2028.             description: Status defines the current state of HTTPRoute.
  2029.             properties:
  2030.               parents:
  2031.                 description: "Parents is a list of parent resources (usually Gateways)
  2032.                   that are associated with the route, and the status of the route
  2033.                   with respect to each parent. When this route attaches to a parent,
  2034.                   the controller that manages the parent must add an entry to this
  2035.                   list when the controller first sees the route and should update
  2036.                   the entry as appropriate when the route or gateway is modified.
  2037.                   \n Note that parent references that cannot be resolved by an implementation
  2038.                   of this API will not be added to this list. Implementations of this
  2039.                   API can only populate Route status for the Gateways/parent resources
  2040.                   they are responsible for. \n A maximum of 32 Gateways will be represented
  2041.                   in this list. An empty list means the route has not been attached
  2042.                   to any Gateway."
  2043.                 items:
  2044.                   description: RouteParentStatus describes the status of a route with
  2045.                     respect to an associated Parent.
  2046.                   properties:
  2047.                     conditions:
  2048.                       description: "Conditions describes the status of the route with
  2049.                         respect to the Gateway. Note that the route's availability
  2050.                         is also subject to the Gateway's own status conditions and
  2051.                         listener status. \n If the Route's ParentRef specifies an
  2052.                         existing Gateway that supports Routes of this kind AND that
  2053.                         Gateway's controller has sufficient access, then that Gateway's
  2054.                         controller MUST set the \"Accepted\" condition on the Route,
  2055.                         to indicate whether the route has been accepted or rejected
  2056.                         by the Gateway, and why. \n A Route MUST be considered \"Accepted\"
  2057.                         if at least one of the Route's rules is implemented by the
  2058.                         Gateway. \n There are a number of cases where the \"Accepted\"
  2059.                         condition may not be set due to lack of controller visibility,
  2060.                         that includes when: \n * The Route refers to a non-existent
  2061.                         parent. * The Route is of a type that the controller does
  2062.                         not support. * The Route is in a namespace the the controller
  2063.                         does not have access to."
  2064.                       items:
  2065.                         description: "Condition contains details for one aspect of
  2066.                           the current state of this API Resource. --- This struct
  2067.                           is intended for direct use as an array at the field path
  2068.                           .status.conditions.  For example, type FooStatus struct{
  2069.                           \    // Represents the observations of a foo's current state.
  2070.                           \    // Known .status.conditions.type are: \"Available\",
  2071.                           \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  2072.                           \    // +patchStrategy=merge     // +listType=map     //
  2073.                           +listMapKey=type     Conditions []metav1.Condition `json:\"conditions,omitempty\"
  2074.                           patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  2075.                           \n     // other fields }"
  2076.                         properties:
  2077.                           lastTransitionTime:
  2078.                             description: lastTransitionTime is the last time the condition
  2079.                               transitioned from one status to another. This should
  2080.                               be when the underlying condition changed.  If that is
  2081.                               not known, then using the time when the API field changed
  2082.                               is acceptable.
  2083.                             format: date-time
  2084.                             type: string
  2085.                           message:
  2086.                             description: message is a human readable message indicating
  2087.                               details about the transition. This may be an empty string.
  2088.                             maxLength: 32768
  2089.                             type: string
  2090.                           observedGeneration:
  2091.                             description: observedGeneration represents the .metadata.generation
  2092.                               that the condition was set based upon. For instance,
  2093.                               if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
  2094.                               is 9, the condition is out of date with respect to the
  2095.                               current state of the instance.
  2096.                             format: int64
  2097.                             minimum: 0
  2098.                             type: integer
  2099.                           reason:
  2100.                             description: reason contains a programmatic identifier
  2101.                               indicating the reason for the condition's last transition.
  2102.                               Producers of specific condition types may define expected
  2103.                               values and meanings for this field, and whether the
  2104.                               values are considered a guaranteed API. The value should
  2105.                               be a CamelCase string. This field may not be empty.
  2106.                             maxLength: 1024
  2107.                             minLength: 1
  2108.                             pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  2109.                             type: string
  2110.                           status:
  2111.                             description: status of the condition, one of True, False,
  2112.                               Unknown.
  2113.                             enum:
  2114.                             - "True"
  2115.                             - "False"
  2116.                             - Unknown
  2117.                             type: string
  2118.                           type:
  2119.                             description: type of condition in CamelCase or in foo.example.com/CamelCase.
  2120.                               --- Many .condition.type values are consistent across
  2121.                               resources like Available, but because arbitrary conditions
  2122.                               can be useful (see .node.status.conditions), the ability
  2123.                               to deconflict is important. The regex it matches is
  2124.                               (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  2125.                             maxLength: 316
  2126.                             pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
  2127.                             type: string
  2128.                         required:
  2129.                         - lastTransitionTime
  2130.                         - message
  2131.                         - reason
  2132.                         - status
  2133.                         - type
  2134.                         type: object
  2135.                       maxItems: 8
  2136.                       minItems: 1
  2137.                       type: array
  2138.                       x-kubernetes-list-map-keys:
  2139.                       - type
  2140.                       x-kubernetes-list-type: map
  2141.                     controllerName:
  2142.                       description: "ControllerName is a domain/path string that indicates
  2143.                         the name of the controller that wrote this status. This corresponds
  2144.                         with the controllerName field on GatewayClass. \n Example:
  2145.                         \"example.net/gateway-controller\". \n The format of this
  2146.                         field is DOMAIN \"/\" PATH, where DOMAIN and PATH are valid
  2147.                         Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)."
  2148.                       maxLength: 253
  2149.                       minLength: 1
  2150.                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
  2151.                       type: string
  2152.                     parentRef:
  2153.                       description: ParentRef corresponds with a ParentRef in the spec
  2154.                         that this RouteParentStatus struct describes the status of.
  2155.                       properties:
  2156.                         group:
  2157.                           default: gateway.networking.k8s.io
  2158.                           description: "Group is the group of the referent. \n Support:
  2159.                             Core"
  2160.                           maxLength: 253
  2161.                           pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2162.                           type: string
  2163.                         kind:
  2164.                           default: Gateway
  2165.                           description: "Kind is kind of the referent. \n Support:
  2166.                             Core (Gateway) Support: Custom (Other Resources)"
  2167.                           maxLength: 63
  2168.                           minLength: 1
  2169.                           pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
  2170.                           type: string
  2171.                         name:
  2172.                           description: "Name is the name of the referent. \n Support:
  2173.                             Core"
  2174.                           maxLength: 253
  2175.                           minLength: 1
  2176.                           type: string
  2177.                         namespace:
  2178.                           description: "Namespace is the namespace of the referent.
  2179.                             When unspecified (or empty string), this refers to the
  2180.                             local namespace of the Route. \n Support: Core"
  2181.                           maxLength: 63
  2182.                           minLength: 1
  2183.                           pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2184.                           type: string
  2185.                         sectionName:
  2186.                           description: "SectionName is the name of a section within
  2187.                             the target resource. In the following resources, SectionName
  2188.                             is interpreted as the following: \n * Gateway: Listener
  2189.                             Name \n Implementations MAY choose to support attaching
  2190.                             Routes to other resources. If that is the case, they MUST
  2191.                             clearly document how SectionName is interpreted. \n When
  2192.                             unspecified (empty string), this will reference the entire
  2193.                             resource. For the purpose of status, an attachment is
  2194.                             considered successful if at least one section in the parent
  2195.                             resource accepts it. For example, Gateway listeners can
  2196.                             restrict which Routes can attach to them by Route kind,
  2197.                             namespace, or hostname. If 1 of 2 Gateway listeners accept
  2198.                             attachment from the referencing Route, the Route MUST
  2199.                             be considered successfully attached. If no Gateway listeners
  2200.                             accept attachment from this Route, the Route MUST be considered
  2201.                             detached from the Gateway. \n Support: Core"
  2202.                           maxLength: 253
  2203.                           minLength: 1
  2204.                           pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2205.                           type: string
  2206.                       required:
  2207.                       - name
  2208.                       type: object
  2209.                   required:
  2210.                   - controllerName
  2211.                   - parentRef
  2212.                   type: object
  2213.                 maxItems: 32
  2214.                 type: array
  2215.             required:
  2216.             - parents
  2217.             type: object
  2218.         required:
  2219.         - spec
  2220.         type: object
  2221.     served: true
  2222.     storage: true
  2223.     subresources:
  2224.       status: {}
  2225. status:
  2226.   acceptedNames:
  2227.     kind: ""
  2228.     plural: ""
  2229.   conditions: []
  2230.   storedVersions: []

RBAC

---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: gateway-role
rules:
  - apiGroups:
      - ""
    resources:
      - namespaces
    verbs:
      - list
      - watch
  - apiGroups:
      - ""
    resources:
      - services
      - endpoints
      - secrets
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - gateway.networking.k8s.io
    resources:
      - gatewayclasses
      - gateways
      - httproutes
      - tcproutes
      - tlsroutes
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - gateway.networking.k8s.io
    resources:
      - gatewayclasses/status
      - gateways/status
      - httproutes/status
      - tcproutes/status
      - tlsroutes/status
    verbs:
      - update

---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: gateway-controller
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: gateway-role
subjects:
  - kind: ServiceAccount
    name: traefik-controller
    namespace: default

The Kubernetes Gateway API project provides several guides on how to use the APIs. These guides can help you to go further than the example above. The getting started guide details how to install the CRDs from their repository.

Keep in mind that the Traefik Gateway provider only supports the v0.4.0 (v1alpha2).

For now, the Traefik Gateway Provider can be used while following the below guides:

Resource Configuration

When using Kubernetes Gateway API as a provider, Traefik uses Kubernetes Custom Resource Definitions to retrieve its routing configuration.

All concepts can be found in the official API concepts documentation. Traefik implements the following resources:

  • GatewayClass defines a set of Gateways that share a common configuration and behaviour.
  • Gateway describes how traffic can be translated to Services within the cluster.
  • HTTPRoute defines HTTP rules for mapping requests from a Gateway to Kubernetes Services.
  • TCPRoute defines TCP rules for mapping requests from a Gateway to Kubernetes Services.
  • TLSRoute defines TLS rules for mapping requests from a Gateway to Kubernetes Services.

Provider Configuration

endpoint

Optional, Default=””

The Kubernetes server endpoint URL.

When deployed into Kubernetes, Traefik reads the environment variables KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT or KUBECONFIG to construct the endpoint.

The access token is looked up in /var/run/secrets/kubernetes.io/serviceaccount/token and the SSL CA certificate in /var/run/secrets/kubernetes.io/serviceaccount/ca.crt. Both are mounted automatically when deployed inside Kubernetes.

The endpoint may be specified to override the environment variable values inside a cluster.

When the environment variables are not found, Traefik tries to connect to the Kubernetes API server with an external-cluster client. In this case, the endpoint is required. Specifically, it may be set to the URL used by kubectl proxy to connect to a Kubernetes cluster using the granted authentication and authorization of the associated kubeconfig.

File (YAML)

providers:
  kubernetesGateway:
    endpoint: "http://localhost:8080"
    # ...

File (TOML)

[providers.kubernetesGateway]
  endpoint = "http://localhost:8080"
  # ...

CLI

--providers.kubernetesgateway.endpoint=http://localhost:8080

token

Optional, Default=””

Bearer token used for the Kubernetes client configuration.

File (YAML)

providers:
  kubernetesGateway:
    token: "mytoken"
    # ...

File (TOML)

[providers.kubernetesGateway]
  token = "mytoken"
  # ...

CLI

--providers.kubernetesgateway.token=mytoken

certAuthFilePath

Optional, Default=””

Path to the certificate authority file. Used for the Kubernetes client configuration.

File (YAML)

providers:
  kubernetesGateway:
    certAuthFilePath: "/my/ca.crt"
    # ...

File (TOML)

[providers.kubernetesGateway]
  certAuthFilePath = "/my/ca.crt"
  # ...

CLI

--providers.kubernetesgateway.certauthfilepath=/my/ca.crt

namespaces

Optional, Default: []

Array of namespaces to watch. If left empty, Traefik watches all namespaces.

File (YAML)

providers:
  kubernetesGateway:
    namespaces:
    - "default"
    - "production"
    # ...

File (TOML)

[providers.kubernetesGateway]
  namespaces = ["default", "production"]
  # ...

CLI

--providers.kubernetesgateway.namespaces=default,production

labelselector

Optional, Default: “”

A label selector can be defined to filter on specific GatewayClass objects only. If left empty, Traefik processes all GatewayClass objects in the configured namespaces.

See label-selectors for details.

File (YAML)

providers:
  kubernetesGateway:
    labelselector: "app=traefik"
    # ...

File (TOML)

[providers.kubernetesGateway]
  labelselector = "app=traefik"
  # ...

CLI

--providers.kubernetesgateway.labelselector="app=traefik"

throttleDuration

Optional, Default: 0

The throttleDuration option defines how often the provider is allowed to handle events from Kubernetes. This prevents a Kubernetes cluster that updates many times per second from continuously changing your Traefik configuration.

If left empty, the provider does not apply any throttling and does not drop any Kubernetes events.

The value of throttleDuration should be provided in seconds or as a valid duration format, see time.ParseDuration.

File (YAML)

providers:
  kubernetesGateway:
    throttleDuration: "10s"
    # ...

File (TOML)

[providers.kubernetesGateway]
  throttleDuration = "10s"
  # ...

CLI

--providers.kubernetesgateway.throttleDuration=10s