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.3.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. kind: GatewayClass
  3. apiVersion: networking.x-k8s.io/v1alpha1
  4. metadata:
  5.   name: my-gateway-class
  6. spec:
  7.   controller: traefik.io/gateway-controller
  9. ---
  10. kind: Gateway
  11. apiVersion: networking.x-k8s.io/v1alpha1
  12. metadata:
  13.   name: my-gateway
  14. spec:
  15.   gatewayClassName: my-gateway-class
  16.   listeners:
  17.     - protocol: HTTPS
  18.       port: 443
  19.       tls:
  20.         certificateRef:
  21.           group: "core"
  22.           kind: "Secret"
  23.           name: "mysecret"
  24.       routes:
  25.         kind: HTTPRoute
  26.         selector:
  27.           matchLabels:
  28.             app: foo
  29. ---
  30. kind: HTTPRoute
  31. apiVersion: networking.x-k8s.io/v1alpha1
  32. metadata:
  33.   name: http-app-1
  34.   namespace: default
  35.   labels:
  36.     app: foo
  37. spec:
  38.   hostnames:
  39.     - "whoami"
  40.   rules:
  41.     - matches:
  42.         - path:
  43.             type: Exact
  44.             value: /foo
  45.       forwardTo:
  46.         - serviceName: whoami
  47.           port: 80
  48.           weight: 1

Whoami Service

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

Traefik Service

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

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.     controller-gen.kubebuilder.io/version: v0.5.0
  9.   creationTimestamp: null
  10.   name: gatewayclasses.networking.x-k8s.io
  11. spec:
  12.   group: networking.x-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.     name: v1alpha1
  32.     schema:
  33.       openAPIV3Schema:
  34.         description: "GatewayClass describes a class of Gateways available to the
  35.           user for creating Gateway resources. \n GatewayClass is a Cluster level
  36.           resource."
  37.         properties:
  38.           apiVersion:
  39.             description: 'APIVersion defines the versioned schema of this representation
  40.               of an object. Servers should convert recognized schemas to the latest
  41.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  42.             type: string
  43.           kind:
  44.             description: 'Kind is a string value representing the REST resource this
  45.               object represents. Servers may infer this from the endpoint the client
  46.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  47.             type: string
  48.           metadata:
  49.             type: object
  50.           spec:
  51.             description: Spec defines the desired state of GatewayClass.
  52.             properties:
  53.               controller:
  54.                 description: "Controller is a domain/path string that indicates the
  55.                   controller that is managing Gateways of this class. \n Example:
  56.                   \"acme.io/gateway-controller\". \n This field is not mutable and
  57.                   cannot be empty. \n The format of this field is DOMAIN \"/\" PATH,
  58.                   where DOMAIN and PATH are valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
  59.                   \n Support: Core"
  60.                 maxLength: 253
  61.                 type: string
  62.               parametersRef:
  63.                 description: "ParametersRef is a reference to a resource that contains
  64.                   the configuration parameters corresponding to the GatewayClass.
  65.                   This is optional if the controller does not require any additional
  66.                   configuration. \n ParametersRef can reference a standard Kubernetes
  67.                   resource, i.e. ConfigMap, or an implementation-specific custom resource.
  68.                   The resource can be cluster-scoped or namespace-scoped. \n If the
  69.                   referent cannot be found, the GatewayClass's \"InvalidParameters\"
  70.                   status condition will be true. \n Support: Custom"
  71.                 properties:
  72.                   group:
  73.                     description: Group is the group of the referent.
  74.                     maxLength: 253
  75.                     minLength: 1
  76.                     type: string
  77.                   kind:
  78.                     description: Kind is kind of the referent.
  79.                     maxLength: 253
  80.                     minLength: 1
  81.                     type: string
  82.                   name:
  83.                     description: Name is the name of the referent.
  84.                     maxLength: 253
  85.                     minLength: 1
  86.                     type: string
  87.                   namespace:
  88.                     description: Namespace is the namespace of the referent. This
  89.                       field is required when scope is set to "Namespace" and ignored
  90.                       when scope is set to "Cluster".
  91.                     maxLength: 253
  92.                     minLength: 1
  93.                     type: string
  94.                   scope:
  95.                     default: Cluster
  96.                     description: Scope represents if the referent is a Cluster or
  97.                       Namespace scoped resource. This may be set to "Cluster" or "Namespace".
  98.                     enum:
  99.                     - Cluster
  100.                     - Namespace
  101.                     type: string
  102.                 required:
  103.                 - group
  104.                 - kind
  105.                 - name
  106.                 type: object
  107.             required:
  108.             - controller
  109.             type: object
  110.           status:
  111.             default:
  112.               conditions:
  113.               - lastTransitionTime: "1970-01-01T00:00:00Z"
  114.                 message: Waiting for controller
  115.                 reason: Waiting
  116.                 status: "False"
  117.                 type: Admitted
  118.             description: Status defines the current state of GatewayClass.
  119.             properties:
  120.               conditions:
  121.                 default:
  122.                 - lastTransitionTime: "1970-01-01T00:00:00Z"
  123.                   message: Waiting for controller
  124.                   reason: Waiting
  125.                   status: "False"
  126.                   type: Admitted
  127.                 description: "Conditions is the current status from the controller
  128.                   for this GatewayClass. \n Controllers should prefer to publish conditions
  129.                   using values of GatewayClassConditionType for the type of each Condition."
  130.                 items:
  131.                   description: "Condition contains details for one aspect of the current
  132.                     state of this API Resource. --- This struct is intended for direct
  133.                     use as an array at the field path .status.conditions.  For example,
  134.                     type FooStatus struct{     // Represents the observations of a
  135.                     foo's current state.     // Known .status.conditions.type are:
  136.                     \"Available\", \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  137.                     \    // +patchStrategy=merge     // +listType=map     // +listMapKey=type
  138.                     \    Conditions []metav1.Condition `json:\"conditions,omitempty\"
  139.                     patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  140.                     \n     // other fields }"
  141.                   properties:
  142.                     lastTransitionTime:
  143.                       description: lastTransitionTime is the last time the condition
  144.                         transitioned from one status to another. This should be when
  145.                         the underlying condition changed.  If that is not known, then
  146.                         using the time when the API field changed is acceptable.
  147.                       format: date-time
  148.                       type: string
  149.                     message:
  150.                       description: message is a human readable message indicating
  151.                         details about the transition. This may be an empty string.
  152.                       maxLength: 32768
  153.                       type: string
  154.                     observedGeneration:
  155.                       description: observedGeneration represents the .metadata.generation
  156.                         that the condition was set based upon. For instance, if .metadata.generation
  157.                         is currently 12, but the .status.conditions[x].observedGeneration
  158.                         is 9, the condition is out of date with respect to the current
  159.                         state of the instance.
  160.                       format: int64
  161.                       minimum: 0
  162.                       type: integer
  163.                     reason:
  164.                       description: reason contains a programmatic identifier indicating
  165.                         the reason for the condition's last transition. Producers
  166.                         of specific condition types may define expected values and
  167.                         meanings for this field, and whether the values are considered
  168.                         a guaranteed API. The value should be a CamelCase string.
  169.                         This field may not be empty.
  170.                       maxLength: 1024
  171.                       minLength: 1
  172.                       pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  173.                       type: string
  174.                     status:
  175.                       description: status of the condition, one of True, False, Unknown.
  176.                       enum:
  177.                       - "True"
  178.                       - "False"
  179.                       - Unknown
  180.                       type: string
  181.                     type:
  182.                       description: type of condition in CamelCase or in foo.example.com/CamelCase.
  183.                         --- Many .condition.type values are consistent across resources
  184.                         like Available, but because arbitrary conditions can be useful
  185.                         (see .node.status.conditions), the ability to deconflict is
  186.                         important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  187.                       maxLength: 316
  188.                       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])$
  189.                       type: string
  190.                   required:
  191.                   - lastTransitionTime
  192.                   - message
  193.                   - reason
  194.                   - status
  195.                   - type
  196.                   type: object
  197.                 maxItems: 8
  198.                 type: array
  199.                 x-kubernetes-list-map-keys:
  200.                 - type
  201.                 x-kubernetes-list-type: map
  202.             type: object
  203.         type: object
  204.     served: true
  205.     storage: true
  206.     subresources:
  207.       status: {}
  208. status:
  209.   acceptedNames:
  210.     kind: ""
  211.     plural: ""
  212.   conditions: []
  213.   storedVersions: []
  215. ---
  216. apiVersion: apiextensions.k8s.io/v1
  217. kind: CustomResourceDefinition
  218. metadata:
  219.   annotations:
  220.     controller-gen.kubebuilder.io/version: v0.5.0
  221.   creationTimestamp: null
  222.   name: gateways.networking.x-k8s.io
  223. spec:
  224.   group: networking.x-k8s.io
  225.   names:
  226.     categories:
  227.     - gateway-api
  228.     kind: Gateway
  229.     listKind: GatewayList
  230.     plural: gateways
  231.     shortNames:
  232.     - gtw
  233.     singular: gateway
  234.   scope: Namespaced
  235.   versions:
  236.   - additionalPrinterColumns:
  237.     - jsonPath: .spec.gatewayClassName
  238.       name: Class
  239.       type: string
  240.     - jsonPath: .metadata.creationTimestamp
  241.       name: Age
  242.       type: date
  243.     name: v1alpha1
  244.     schema:
  245.       openAPIV3Schema:
  246.         description: "Gateway represents an instantiation of a service-traffic handling
  247.           infrastructure by binding Listeners to a set of IP addresses. \n Implementations
  248.           should add the `gateway-exists-finalizer.networking.x-k8s.io` finalizer
  249.           on the associated GatewayClass whenever Gateway(s) is running. This ensures
  250.           that a GatewayClass associated with a Gateway(s) is not deleted while in
  251.           use."
  252.         properties:
  253.           apiVersion:
  254.             description: 'APIVersion defines the versioned schema of this representation
  255.               of an object. Servers should convert recognized schemas to the latest
  256.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  257.             type: string
  258.           kind:
  259.             description: 'Kind is a string value representing the REST resource this
  260.               object represents. Servers may infer this from the endpoint the client
  261.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  262.             type: string
  263.           metadata:
  264.             type: object
  265.           spec:
  266.             description: Spec defines the desired state of Gateway.
  267.             properties:
  268.               addresses:
  269.                 description: "Addresses requested for this gateway. This is optional
  270.                   and behavior can depend on the GatewayClass. If a value is set in
  271.                   the spec and the requested address is invalid, the GatewayClass
  272.                   MUST indicate this in the associated entry in GatewayStatus.Addresses.
  273.                   \n If no Addresses are specified, the GatewayClass may schedule
  274.                   the Gateway in an implementation-defined manner, assigning an appropriate
  275.                   set of Addresses. \n The GatewayClass MUST bind all Listeners to
  276.                   every GatewayAddress that it assigns to the Gateway. \n Support:
  277.                   Core"
  278.                 items:
  279.                   description: GatewayAddress describes an address that can be bound
  280.                     to a Gateway.
  281.                   properties:
  282.                     type:
  283.                       default: IPAddress
  284.                       description: "Type of the address. \n Support: Extended"
  285.                       enum:
  286.                       - IPAddress
  287.                       - NamedAddress
  288.                       type: string
  289.                     value:
  290.                       description: "Value of the address. The validity of the values
  291.                         will depend on the type and support by the controller. \n
  292.                         Examples: `1.2.3.4`, `128::1`, `my-ip-address`."
  293.                       maxLength: 253
  294.                       minLength: 1
  295.                       type: string
  296.                   required:
  297.                   - value
  298.                   type: object
  299.                 maxItems: 16
  300.                 type: array
  301.               gatewayClassName:
  302.                 description: GatewayClassName used for this Gateway. This is the name
  303.                   of a GatewayClass resource.
  304.                 maxLength: 253
  305.                 minLength: 1
  306.                 type: string
  307.               listeners:
  308.                 description: "Listeners associated with this Gateway. Listeners define
  309.                   logical endpoints that are bound on this Gateway's addresses. At
  310.                   least one Listener MUST be specified. \n An implementation MAY group
  311.                   Listeners by Port and then collapse each group of Listeners into
  312.                   a single Listener if the implementation determines that the Listeners
  313.                   in the group are \"compatible\". An implementation MAY also group
  314.                   together and collapse compatible Listeners belonging to different
  315.                   Gateways. \n For example, an implementation might consider Listeners
  316.                   to be compatible with each other if all of the following conditions
  317.                   are met: \n 1. Either each Listener within the group specifies the
  318.                   \"HTTP\"    Protocol or each Listener within the group specifies
  319.                   either    the \"HTTPS\" or \"TLS\" Protocol. \n 2. Each Listener
  320.                   within the group specifies a Hostname that is unique    within the
  321.                   group. \n 3. As a special case, one Listener within a group may
  322.                   omit Hostname,    in which case this Listener matches when no other
  323.                   Listener    matches. \n If the implementation does collapse compatible
  324.                   Listeners, the hostname provided in the incoming client request
  325.                   MUST be matched to a Listener to find the correct set of Routes.
  326.                   The incoming hostname MUST be matched using the Hostname field for
  327.                   each Listener in order of most to least specific. That is, exact
  328.                   matches must be processed before wildcard matches. \n If this field
  329.                   specifies multiple Listeners that have the same Port value but are
  330.                   not compatible, the implementation must raise a \"Conflicted\" condition
  331.                   in the Listener status. \n Support: Core"
  332.                 items:
  333.                   description: Listener embodies the concept of a logical endpoint
  334.                     where a Gateway can accept network connections. Each listener
  335.                     in a Gateway must have a unique combination of Hostname, Port,
  336.                     and Protocol. This will be enforced by a validating webhook.
  337.                   properties:
  338.                     hostname:
  339.                       description: "Hostname specifies the virtual hostname to match
  340.                         for protocol types that define this concept. When unspecified,
  341.                         \"\", or `*`, all hostnames are matched. This field can be
  342.                         omitted for protocols that don't require hostname based matching.
  343.                         \n Hostname is the fully qualified domain name of a network
  344.                         host, as defined by RFC 3986. Note the following deviations
  345.                         from the \"host\" part of the URI as defined in the RFC: \n
  346.                         1. IP literals are not allowed. 2. The `:` delimiter is not
  347.                         respected because ports are not allowed. \n Hostname can be
  348.                         \"precise\" which is a domain name without the terminating
  349.                         dot of a network host (e.g. \"foo.example.com\") or \"wildcard\",
  350.                         which is a domain name prefixed with a single wildcard label
  351.                         (e.g. `*.example.com`). The wildcard character `*` must appear
  352.                         by itself as the first DNS label and matches only a single
  353.                         label. \n Support: Core"
  354.                       maxLength: 253
  355.                       minLength: 1
  356.                       type: string
  357.                     port:
  358.                       description: "Port is the network port. Multiple listeners may
  359.                         use the same port, subject to the Listener compatibility rules.
  360.                         \n Support: Core"
  361.                       format: int32
  362.                       maximum: 65535
  363.                       minimum: 1
  364.                       type: integer
  365.                     protocol:
  366.                       description: "Protocol specifies the network protocol this listener
  367.                         expects to receive. The GatewayClass MUST apply the Hostname
  368.                         match appropriately for each protocol: \n * For the \"TLS\"
  369.                         protocol, the Hostname match MUST be   applied to the [SNI](https://tools.ietf.org/html/rfc6066#section-3)
  370.                         \  server name offered by the client. * For the \"HTTP\" protocol,
  371.                         the Hostname match MUST be   applied to the host portion of
  372.                         the   [effective request URI](https://tools.ietf.org/html/rfc7230#section-5.5)
  373.                         \  or the [:authority pseudo-header](https://tools.ietf.org/html/rfc7540#section-8.1.2.3)
  374.                         * For the \"HTTPS\" protocol, the Hostname match MUST be   applied
  375.                         at both the TLS and HTTP protocol layers. \n Support: Core"
  376.                       type: string
  377.                     routes:
  378.                       description: "Routes specifies a schema for associating routes
  379.                         with the Listener using selectors. A Route is a resource capable
  380.                         of servicing a request and allows a cluster operator to expose
  381.                         a cluster resource (i.e. Service) by externally-reachable
  382.                         URL, load-balance traffic and terminate SSL/TLS.  Typically,
  383.                         a route is a \"HTTPRoute\" or \"TCPRoute\" in group \"networking.x-k8s.io\",
  384.                         however, an implementation may support other types of resources.
  385.                         \n The Routes selector MUST select a set of objects that are
  386.                         compatible with the application protocol specified in the
  387.                         Protocol field. \n Although a client request may technically
  388.                         match multiple route rules, only one rule may ultimately receive
  389.                         the request. Matching precedence MUST be determined in order
  390.                         of the following criteria: \n * The most specific match. For
  391.                         example, the most specific HTTPRoute match   is determined
  392.                         by the longest matching combination of hostname and path.
  393.                         * The oldest Route based on creation timestamp. For example,
  394.                         a Route with   a creation timestamp of \"2020-09-08 01:02:03\"
  395.                         is given precedence over   a Route with a creation timestamp
  396.                         of \"2020-09-08 01:02:04\". * If everything else is equivalent,
  397.                         the Route appearing first in   alphabetical order (namespace/name)
  398.                         should be given precedence. For   example, foo/bar is given
  399.                         precedence over foo/baz. \n All valid portions of a Route
  400.                         selected by this field should be supported. Invalid portions
  401.                         of a Route can be ignored (sometimes that will mean the full
  402.                         Route). If a portion of a Route transitions from valid to
  403.                         invalid, support for that portion of the Route should be dropped
  404.                         to ensure consistency. For example, even if a filter specified
  405.                         by a Route is invalid, the rest of the Route should still
  406.                         be supported. \n Support: Core"
  407.                       properties:
  408.                         group:
  409.                           default: networking.x-k8s.io
  410.                           description: "Group is the group of the route resource to
  411.                             select. Omitting the value or specifying the empty string
  412.                             indicates the networking.x-k8s.io API group. For example,
  413.                             use the following to select an HTTPRoute: \n routes:   kind:
  414.                             HTTPRoute \n Otherwise, if an alternative API group is
  415.                             desired, specify the desired group: \n routes:   group:
  416.                             acme.io   kind: FooRoute \n Support: Core"
  417.                           maxLength: 253
  418.                           minLength: 1
  419.                           type: string
  420.                         kind:
  421.                           description: "Kind is the kind of the route resource to
  422.                             select. \n Kind MUST correspond to kinds of routes that
  423.                             are compatible with the application protocol specified
  424.                             in the Listener's Protocol field. \n If an implementation
  425.                             does not support or recognize this resource type, it SHOULD
  426.                             set the \"ResolvedRefs\" condition to false for this listener
  427.                             with the \"InvalidRoutesRef\" reason. \n Support: Core"
  428.                           type: string
  429.                         namespaces:
  430.                           default:
  431.                             from: Same
  432.                           description: "Namespaces indicates in which namespaces Routes
  433.                             should be selected for this Gateway. This is restricted
  434.                             to the namespace of this Gateway by default. \n Support:
  435.                             Core"
  436.                           properties:
  437.                             from:
  438.                               default: Same
  439.                               description: "From indicates where Routes will be selected
  440.                                 for this Gateway. Possible values are: * All: Routes
  441.                                 in all namespaces may be used by this Gateway. * Selector:
  442.                                 Routes in namespaces selected by the selector may
  443.                                 be used by   this Gateway. * Same: Only Routes in
  444.                                 the same namespace may be used by this Gateway. \n
  445.                                 Support: Core"
  446.                               enum:
  447.                               - All
  448.                               - Selector
  449.                               - Same
  450.                               type: string
  451.                             selector:
  452.                               description: "Selector must be specified when From is
  453.                                 set to \"Selector\". In that case, only Routes in
  454.                                 Namespaces matching this Selector will be selected
  455.                                 by this Gateway. This field is ignored for other values
  456.                                 of \"From\". \n Support: Core"
  457.                               properties:
  458.                                 matchExpressions:
  459.                                   description: matchExpressions is a list of label
  460.                                     selector requirements. The requirements are ANDed.
  461.                                   items:
  462.                                     description: A label selector requirement is a
  463.                                       selector that contains values, a key, and an
  464.                                       operator that relates the key and values.
  465.                                     properties:
  466.                                       key:
  467.                                         description: key is the label key that the
  468.                                           selector applies to.
  469.                                         type: string
  470.                                       operator:
  471.                                         description: operator represents a key's relationship
  472.                                           to a set of values. Valid operators are
  473.                                           In, NotIn, Exists and DoesNotExist.
  474.                                         type: string
  475.                                       values:
  476.                                         description: values is an array of string
  477.                                           values. If the operator is In or NotIn,
  478.                                           the values array must be non-empty. If the
  479.                                           operator is Exists or DoesNotExist, the
  480.                                           values array must be empty. This array is
  481.                                           replaced during a strategic merge patch.
  482.                                         items:
  483.                                           type: string
  484.                                         type: array
  485.                                     required:
  486.                                     - key
  487.                                     - operator
  488.                                     type: object
  489.                                   type: array
  490.                                 matchLabels:
  491.                                   additionalProperties:
  492.                                     type: string
  493.                                   description: matchLabels is a map of {key,value}
  494.                                     pairs. A single {key,value} in the matchLabels
  495.                                     map is equivalent to an element of matchExpressions,
  496.                                     whose key field is "key", the operator is "In",
  497.                                     and the values array contains only "value". The
  498.                                     requirements are ANDed.
  499.                                   type: object
  500.                               type: object
  501.                           type: object
  502.                         selector:
  503.                           description: "Selector specifies a set of route labels used
  504.                             for selecting routes to associate with the Gateway. If
  505.                             this Selector is defined, only routes matching the Selector
  506.                             are associated with the Gateway. An empty Selector matches
  507.                             all routes. \n Support: Core"
  508.                           properties:
  509.                             matchExpressions:
  510.                               description: matchExpressions is a list of label selector
  511.                                 requirements. The requirements are ANDed.
  512.                               items:
  513.                                 description: A label selector requirement is a selector
  514.                                   that contains values, a key, and an operator that
  515.                                   relates the key and values.
  516.                                 properties:
  517.                                   key:
  518.                                     description: key is the label key that the selector
  519.                                       applies to.
  520.                                     type: string
  521.                                   operator:
  522.                                     description: operator represents a key's relationship
  523.                                       to a set of values. Valid operators are In,
  524.                                       NotIn, Exists and DoesNotExist.
  525.                                     type: string
  526.                                   values:
  527.                                     description: values is an array of string values.
  528.                                       If the operator is In or NotIn, the values array
  529.                                       must be non-empty. If the operator is Exists
  530.                                       or DoesNotExist, the values array must be empty.
  531.                                       This array is replaced during a strategic merge
  532.                                       patch.
  533.                                     items:
  534.                                       type: string
  535.                                     type: array
  536.                                 required:
  537.                                 - key
  538.                                 - operator
  539.                                 type: object
  540.                               type: array
  541.                             matchLabels:
  542.                               additionalProperties:
  543.                                 type: string
  544.                               description: matchLabels is a map of {key,value} pairs.
  545.                                 A single {key,value} in the matchLabels map is equivalent
  546.                                 to an element of matchExpressions, whose key field
  547.                                 is "key", the operator is "In", and the values array
  548.                                 contains only "value". The requirements are ANDed.
  549.                               type: object
  550.                           type: object
  551.                       required:
  552.                       - kind
  553.                       type: object
  554.                     tls:
  555.                       description: "TLS is the TLS configuration for the Listener.
  556.                         This field is required if the Protocol field is \"HTTPS\"
  557.                         or \"TLS\" and ignored otherwise. \n The association of SNIs
  558.                         to Certificate defined in GatewayTLSConfig is defined based
  559.                         on the Hostname field for this listener. \n The GatewayClass
  560.                         MUST use the longest matching SNI out of all available certificates
  561.                         for any TLS handshake. \n Support: Core"
  562.                       properties:
  563.                         certificateRef:
  564.                           description: "CertificateRef is a reference to a Kubernetes
  565.                             object that contains a TLS certificate and private key.
  566.                             This certificate is used to establish a TLS handshake
  567.                             for requests that match the hostname of the associated
  568.                             listener. The referenced object MUST reside in the same
  569.                             namespace as Gateway. \n This field is required when mode
  570.                             is set to \"Terminate\" (default) and optional otherwise.
  571.                             \n CertificateRef can reference a standard Kubernetes
  572.                             resource, i.e. Secret, or an implementation-specific custom
  573.                             resource. \n Support: Core (Kubernetes Secrets) \n Support:
  574.                             Implementation-specific (Other resource types)"
  575.                           properties:
  576.                             group:
  577.                               description: Group is the group of the referent.
  578.                               maxLength: 253
  579.                               minLength: 1
  580.                               type: string
  581.                             kind:
  582.                               description: Kind is kind of the referent.
  583.                               maxLength: 253
  584.                               minLength: 1
  585.                               type: string
  586.                             name:
  587.                               description: Name is the name of the referent.
  588.                               maxLength: 253
  589.                               minLength: 1
  590.                               type: string
  591.                           required:
  592.                           - group
  593.                           - kind
  594.                           - name
  595.                           type: object
  596.                         mode:
  597.                           default: Terminate
  598.                           description: "Mode defines the TLS behavior for the TLS
  599.                             session initiated by the client. There are two possible
  600.                             modes: - Terminate: The TLS session between the downstream
  601.                             client   and the Gateway is terminated at the Gateway.
  602.                             This mode requires   certificateRef to be set. - Passthrough:
  603.                             The TLS session is NOT terminated by the Gateway. This
  604.                             \  implies that the Gateway can't decipher the TLS stream
  605.                             except for   the ClientHello message of the TLS protocol.
  606.                             \  CertificateRef field is ignored in this mode. \n Support:
  607.                             Core"
  608.                           enum:
  609.                           - Terminate
  610.                           - Passthrough
  611.                           type: string
  612.                         options:
  613.                           additionalProperties:
  614.                             type: string
  615.                           description: "Options are a list of key/value pairs to give
  616.                             extended options to the provider. \n There variation among
  617.                             providers as to how ciphersuites are expressed. If there
  618.                             is a common subset for expressing ciphers then it will
  619.                             make sense to loft that as a core API construct. \n Support:
  620.                             Implementation-specific"
  621.                           type: object
  622.                         routeOverride:
  623.                           default:
  624.                             certificate: Deny
  625.                           description: "RouteOverride dictates if TLS settings can
  626.                             be configured via Routes or not. \n CertificateRef must
  627.                             be defined even if `routeOverride.certificate` is set
  628.                             to 'Allow' as it will be used as the default certificate
  629.                             for the listener. \n Support: Core"
  630.                           properties:
  631.                             certificate:
  632.                               default: Deny
  633.                               description: "Certificate dictates if TLS certificates
  634.                                 can be configured via Routes. If set to 'Allow', a
  635.                                 TLS certificate for a hostname defined in a Route
  636.                                 takes precedence over the certificate defined in Gateway.
  637.                                 \n Support: Core"
  638.                               enum:
  639.                               - Allow
  640.                               - Deny
  641.                               type: string
  642.                           type: object
  643.                       type: object
  644.                   required:
  645.                   - port
  646.                   - protocol
  647.                   - routes
  648.                   type: object
  649.                 maxItems: 64
  650.                 minItems: 1
  651.                 type: array
  652.             required:
  653.             - gatewayClassName
  654.             - listeners
  655.             type: object
  656.           status:
  657.             default:
  658.               conditions:
  659.               - lastTransitionTime: "1970-01-01T00:00:00Z"
  660.                 message: Waiting for controller
  661.                 reason: NotReconciled
  662.                 status: "False"
  663.                 type: Scheduled
  664.             description: Status defines the current state of Gateway.
  665.             properties:
  666.               addresses:
  667.                 description: "Addresses lists the IP addresses that have actually
  668.                   been bound to the Gateway. These addresses may differ from the addresses
  669.                   in the Spec, e.g. if the Gateway automatically assigns an address
  670.                   from a reserved pool. \n These addresses should all be of type \"IPAddress\"."
  671.                 items:
  672.                   description: GatewayAddress describes an address that can be bound
  673.                     to a Gateway.
  674.                   properties:
  675.                     type:
  676.                       default: IPAddress
  677.                       description: "Type of the address. \n Support: Extended"
  678.                       enum:
  679.                       - IPAddress
  680.                       - NamedAddress
  681.                       type: string
  682.                     value:
  683.                       description: "Value of the address. The validity of the values
  684.                         will depend on the type and support by the controller. \n
  685.                         Examples: `1.2.3.4`, `128::1`, `my-ip-address`."
  686.                       maxLength: 253
  687.                       minLength: 1
  688.                       type: string
  689.                   required:
  690.                   - value
  691.                   type: object
  692.                 maxItems: 16
  693.                 type: array
  694.               conditions:
  695.                 default:
  696.                 - lastTransitionTime: "1970-01-01T00:00:00Z"
  697.                   message: Waiting for controller
  698.                   reason: NotReconciled
  699.                   status: "False"
  700.                   type: Scheduled
  701.                 description: "Conditions describe the current conditions of the Gateway.
  702.                   \n Implementations should prefer to express Gateway conditions using
  703.                   the `GatewayConditionType` and `GatewayConditionReason` constants
  704.                   so that operators and tools can converge on a common vocabulary
  705.                   to describe Gateway state. \n Known condition types are: \n * \"Scheduled\"
  706.                   * \"Ready\""
  707.                 items:
  708.                   description: "Condition contains details for one aspect of the current
  709.                     state of this API Resource. --- This struct is intended for direct
  710.                     use as an array at the field path .status.conditions.  For example,
  711.                     type FooStatus struct{     // Represents the observations of a
  712.                     foo's current state.     // Known .status.conditions.type are:
  713.                     \"Available\", \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  714.                     \    // +patchStrategy=merge     // +listType=map     // +listMapKey=type
  715.                     \    Conditions []metav1.Condition `json:\"conditions,omitempty\"
  716.                     patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  717.                     \n     // other fields }"
  718.                   properties:
  719.                     lastTransitionTime:
  720.                       description: lastTransitionTime is the last time the condition
  721.                         transitioned from one status to another. This should be when
  722.                         the underlying condition changed.  If that is not known, then
  723.                         using the time when the API field changed is acceptable.
  724.                       format: date-time
  725.                       type: string
  726.                     message:
  727.                       description: message is a human readable message indicating
  728.                         details about the transition. This may be an empty string.
  729.                       maxLength: 32768
  730.                       type: string
  731.                     observedGeneration:
  732.                       description: observedGeneration represents the .metadata.generation
  733.                         that the condition was set based upon. For instance, if .metadata.generation
  734.                         is currently 12, but the .status.conditions[x].observedGeneration
  735.                         is 9, the condition is out of date with respect to the current
  736.                         state of the instance.
  737.                       format: int64
  738.                       minimum: 0
  739.                       type: integer
  740.                     reason:
  741.                       description: reason contains a programmatic identifier indicating
  742.                         the reason for the condition's last transition. Producers
  743.                         of specific condition types may define expected values and
  744.                         meanings for this field, and whether the values are considered
  745.                         a guaranteed API. The value should be a CamelCase string.
  746.                         This field may not be empty.
  747.                       maxLength: 1024
  748.                       minLength: 1
  749.                       pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  750.                       type: string
  751.                     status:
  752.                       description: status of the condition, one of True, False, Unknown.
  753.                       enum:
  754.                       - "True"
  755.                       - "False"
  756.                       - Unknown
  757.                       type: string
  758.                     type:
  759.                       description: type of condition in CamelCase or in foo.example.com/CamelCase.
  760.                         --- Many .condition.type values are consistent across resources
  761.                         like Available, but because arbitrary conditions can be useful
  762.                         (see .node.status.conditions), the ability to deconflict is
  763.                         important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  764.                       maxLength: 316
  765.                       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])$
  766.                       type: string
  767.                   required:
  768.                   - lastTransitionTime
  769.                   - message
  770.                   - reason
  771.                   - status
  772.                   - type
  773.                   type: object
  774.                 maxItems: 8
  775.                 type: array
  776.                 x-kubernetes-list-map-keys:
  777.                 - type
  778.                 x-kubernetes-list-type: map
  779.               listeners:
  780.                 description: Listeners provide status for each unique listener port
  781.                   defined in the Spec.
  782.                 items:
  783.                   description: ListenerStatus is the status associated with a Listener.
  784.                   properties:
  785.                     conditions:
  786.                       description: Conditions describe the current condition of this
  787.                         listener.
  788.                       items:
  789.                         description: "Condition contains details for one aspect of
  790.                           the current state of this API Resource. --- This struct
  791.                           is intended for direct use as an array at the field path
  792.                           .status.conditions.  For example, type FooStatus struct{
  793.                           \    // Represents the observations of a foo's current state.
  794.                           \    // Known .status.conditions.type are: \"Available\",
  795.                           \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  796.                           \    // +patchStrategy=merge     // +listType=map     //
  797.                           +listMapKey=type     Conditions []metav1.Condition `json:\"conditions,omitempty\"
  798.                           patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  799.                           \n     // other fields }"
  800.                         properties:
  801.                           lastTransitionTime:
  802.                             description: lastTransitionTime is the last time the condition
  803.                               transitioned from one status to another. This should
  804.                               be when the underlying condition changed.  If that is
  805.                               not known, then using the time when the API field changed
  806.                               is acceptable.
  807.                             format: date-time
  808.                             type: string
  809.                           message:
  810.                             description: message is a human readable message indicating
  811.                               details about the transition. This may be an empty string.
  812.                             maxLength: 32768
  813.                             type: string
  814.                           observedGeneration:
  815.                             description: observedGeneration represents the .metadata.generation
  816.                               that the condition was set based upon. For instance,
  817.                               if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
  818.                               is 9, the condition is out of date with respect to the
  819.                               current state of the instance.
  820.                             format: int64
  821.                             minimum: 0
  822.                             type: integer
  823.                           reason:
  824.                             description: reason contains a programmatic identifier
  825.                               indicating the reason for the condition's last transition.
  826.                               Producers of specific condition types may define expected
  827.                               values and meanings for this field, and whether the
  828.                               values are considered a guaranteed API. The value should
  829.                               be a CamelCase string. This field may not be empty.
  830.                             maxLength: 1024
  831.                             minLength: 1
  832.                             pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  833.                             type: string
  834.                           status:
  835.                             description: status of the condition, one of True, False,
  836.                               Unknown.
  837.                             enum:
  838.                             - "True"
  839.                             - "False"
  840.                             - Unknown
  841.                             type: string
  842.                           type:
  843.                             description: type of condition in CamelCase or in foo.example.com/CamelCase.
  844.                               --- Many .condition.type values are consistent across
  845.                               resources like Available, but because arbitrary conditions
  846.                               can be useful (see .node.status.conditions), the ability
  847.                               to deconflict is important. The regex it matches is
  848.                               (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  849.                             maxLength: 316
  850.                             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])$
  851.                             type: string
  852.                         required:
  853.                         - lastTransitionTime
  854.                         - message
  855.                         - reason
  856.                         - status
  857.                         - type
  858.                         type: object
  859.                       maxItems: 8
  860.                       type: array
  861.                       x-kubernetes-list-map-keys:
  862.                       - type
  863.                       x-kubernetes-list-type: map
  864.                     hostname:
  865.                       description: Hostname is the Listener hostname value for which
  866.                         this message is reporting the status.
  867.                       maxLength: 253
  868.                       minLength: 1
  869.                       type: string
  870.                     port:
  871.                       description: Port is the unique Listener port value for which
  872.                         this message is reporting the status.
  873.                       format: int32
  874.                       maximum: 65535
  875.                       minimum: 1
  876.                       type: integer
  877.                     protocol:
  878.                       description: Protocol is the Listener protocol value for which
  879.                         this message is reporting the status.
  880.                       type: string
  881.                   required:
  882.                   - conditions
  883.                   - port
  884.                   - protocol
  885.                   type: object
  886.                 maxItems: 64
  887.                 type: array
  888.                 x-kubernetes-list-map-keys:
  889.                 - port
  890.                 x-kubernetes-list-type: map
  891.             type: object
  892.         type: object
  893.     served: true
  894.     storage: true
  895.     subresources:
  896.       status: {}
  897. status:
  898.   acceptedNames:
  899.     kind: ""
  900.     plural: ""
  901.   conditions: []
  902.   storedVersions: []
  904. ---
  905. apiVersion: apiextensions.k8s.io/v1
  906. kind: CustomResourceDefinition
  907. metadata:
  908.   annotations:
  909.     controller-gen.kubebuilder.io/version: v0.5.0
  910.   creationTimestamp: null
  911.   name: httproutes.networking.x-k8s.io
  912. spec:
  913.   group: networking.x-k8s.io
  914.   names:
  915.     categories:
  916.     - gateway-api
  917.     kind: HTTPRoute
  918.     listKind: HTTPRouteList
  919.     plural: httproutes
  920.     singular: httproute
  921.   scope: Namespaced
  922.   versions:
  923.   - additionalPrinterColumns:
  924.     - jsonPath: .spec.hostnames
  925.       name: Hostnames
  926.       type: string
  927.     - jsonPath: .metadata.creationTimestamp
  928.       name: Age
  929.       type: date
  930.     name: v1alpha1
  931.     schema:
  932.       openAPIV3Schema:
  933.         description: HTTPRoute is the Schema for the HTTPRoute resource.
  934.         properties:
  935.           apiVersion:
  936.             description: 'APIVersion defines the versioned schema of this representation
  937.               of an object. Servers should convert recognized schemas to the latest
  938.               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  939.             type: string
  940.           kind:
  941.             description: 'Kind is a string value representing the REST resource this
  942.               object represents. Servers may infer this from the endpoint the client
  943.               submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  944.             type: string
  945.           metadata:
  946.             type: object
  947.           spec:
  948.             description: Spec defines the desired state of HTTPRoute.
  949.             properties:
  950.               gateways:
  951.                 default:
  952.                   allow: SameNamespace
  953.                 description: Gateways defines which Gateways can use this Route.
  954.                 properties:
  955.                   allow:
  956.                     default: SameNamespace
  957.                     description: 'Allow indicates which Gateways will be allowed to
  958.                       use this route. Possible values are: * All: Gateways in any
  959.                       namespace can use this route. * FromList: Only Gateways specified
  960.                       in GatewayRefs may use this route. * SameNamespace: Only Gateways
  961.                       in the same namespace may use this route.'
  962.                     enum:
  963.                     - All
  964.                     - FromList
  965.                     - SameNamespace
  966.                     type: string
  967.                   gatewayRefs:
  968.                     description: GatewayRefs must be specified when Allow is set to
  969.                       "FromList". In that case, only Gateways referenced in this list
  970.                       will be allowed to use this route. This field is ignored for
  971.                       other values of "Allow".
  972.                     items:
  973.                       description: GatewayReference identifies a Gateway in a specified
  974.                         namespace.
  975.                       properties:
  976.                         name:
  977.                           description: Name is the name of the referent.
  978.                           maxLength: 253
  979.                           minLength: 1
  980.                           type: string
  981.                         namespace:
  982.                           description: Namespace is the namespace of the referent.
  983.                           maxLength: 253
  984.                           minLength: 1
  985.                           type: string
  986.                       required:
  987.                       - name
  988.                       - namespace
  989.                       type: object
  990.                     type: array
  991.                 type: object
  992.               hostnames:
  993.                 description: "Hostnames defines a set of hostname that should match
  994.                   against the HTTP Host header to select a HTTPRoute to process the
  995.                   request. Hostname is the fully qualified domain name of a network
  996.                   host, as defined by RFC 3986. Note the following deviations from
  997.                   the \"host\" part of the URI as defined in the RFC: \n 1. IPs are
  998.                   not allowed. 2. The `:` delimiter is not respected because ports
  999.                   are not allowed. \n Incoming requests are matched against the hostnames
  1000.                   before the HTTPRoute rules. If no hostname is specified, traffic
  1001.                   is routed based on the HTTPRouteRules. \n Hostname can be \"precise\"
  1002.                   which is a domain name without the terminating dot of a network
  1003.                   host (e.g. \"foo.example.com\") or \"wildcard\", which is a domain
  1004.                   name prefixed with a single wildcard label (e.g. `*.example.com`).
  1005.                   The wildcard character `*` must appear by itself as the first DNS
  1006.                   label and matches only a single label. You cannot have a wildcard
  1007.                   label by itself (e.g. Host == `*`). Requests will be matched against
  1008.                   the Host field in the following order: \n 1. If Host is precise,
  1009.                   the request matches this rule if    the HTTP Host header is equal
  1010.                   to Host. 2. If Host is a wildcard, then the request matches this
  1011.                   rule if    the HTTP Host header is to equal to the suffix    (removing
  1012.                   the first label) of the wildcard rule. \n Support: Core"
  1013.                 items:
  1014.                   description: Hostname is used to specify a hostname that should
  1015.                     be matched.
  1016.                   maxLength: 253
  1017.                   minLength: 1
  1018.                   type: string
  1019.                 maxItems: 16
  1020.                 type: array
  1021.               rules:
  1022.                 default:
  1023.                 - matches:
  1024.                   - path:
  1025.                       type: Prefix
  1026.                       value: /
  1027.                 description: Rules are a list of HTTP matchers, filters and actions.
  1028.                 items:
  1029.                   description: HTTPRouteRule defines semantics for matching an HTTP
  1030.                     request based on conditions, optionally executing additional processing
  1031.                     steps, and forwarding the request to an API object.
  1032.                   properties:
  1033.                     filters:
  1034.                       description: "Filters define the filters that are applied to
  1035.                         requests that match this rule. \n The effects of ordering
  1036.                         of multiple behaviors are currently unspecified. This can
  1037.                         change in the future based on feedback during the alpha stage.
  1038.                         \n Conformance-levels at this level are defined based on the
  1039.                         type of filter: \n - ALL core filters MUST be supported by
  1040.                         all implementations. - Implementers are encouraged to support
  1041.                         extended filters. - Implementation-specific custom filters
  1042.                         have no API guarantees across   implementations. \n Specifying
  1043.                         a core filter multiple times has unspecified or custom conformance.
  1044.                         \n Support: Core"
  1045.                       items:
  1046.                         description: 'HTTPRouteFilter defines additional processing
  1047.                           steps that must be completed during the request or response
  1048.                           lifecycle. HTTPRouteFilters are meant as an extension point
  1049.                           to express additional processing that may be done in Gateway
  1050.                           implementations. Some examples include request or response
  1051.                           modification, implementing authentication strategies, rate-limiting,
  1052.                           and traffic shaping. API guarantee/conformance is defined
  1053.                           based on the type of the filter. TODO(hbagdi): re-render
  1054.                           CRDs once controller-tools supports union tags: - https://github.com/kubernetes-sigs/controller-tools/pull/298
  1055.                           - https://github.com/kubernetes-sigs/controller-tools/issues/461'
  1056.                         properties:
  1057.                           extensionRef:
  1058.                             description: "ExtensionRef is an optional, implementation-specific
  1059.                               extension to the \"filter\" behavior.  For example,
  1060.                               resource \"myroutefilter\" in group \"networking.acme.io\").
  1061.                               ExtensionRef MUST NOT be used for core and extended
  1062.                               filters. \n Support: Implementation-specific"
  1063.                             properties:
  1064.                               group:
  1065.                                 description: Group is the group of the referent.
  1066.                                 maxLength: 253
  1067.                                 minLength: 1
  1068.                                 type: string
  1069.                               kind:
  1070.                                 description: Kind is kind of the referent.
  1071.                                 maxLength: 253
  1072.                                 minLength: 1
  1073.                                 type: string
  1074.                               name:
  1075.                                 description: Name is the name of the referent.
  1076.                                 maxLength: 253
  1077.                                 minLength: 1
  1078.                                 type: string
  1079.                             required:
  1080.                             - group
  1081.                             - kind
  1082.                             - name
  1083.                             type: object
  1084.                           requestHeaderModifier:
  1085.                             description: "RequestHeaderModifier defines a schema for
  1086.                               a filter that modifies request headers. \n Support:
  1087.                               Core"
  1088.                             properties:
  1089.                               add:
  1090.                                 additionalProperties:
  1091.                                   type: string
  1092.                                 description: "Add adds the given header (name, value)
  1093.                                   to the request before the action. It appends to
  1094.                                   any existing values associated with the header name.
  1095.                                   \n Input:   GET /foo HTTP/1.1   my-header: foo \n
  1096.                                   Config:   add: {\"my-header\": \"bar\"} \n Output:
  1097.                                   \  GET /foo HTTP/1.1   my-header: foo   my-header:
  1098.                                   bar \n Support: Extended"
  1099.                                 type: object
  1100.                               remove:
  1101.                                 description: "Remove the given header(s) from the
  1102.                                   HTTP request before the action. The value of RemoveHeader
  1103.                                   is a list of HTTP header names. Note that the header
  1104.                                   names are case-insensitive [RFC-2616 4.2]. \n Input:
  1105.                                   \  GET /foo HTTP/1.1   my-header1: foo   my-header2:
  1106.                                   bar   my-header3: baz \n Config:   remove: [\"my-header1\",
  1107.                                   \"my-header3\"] \n Output:   GET /foo HTTP/1.1   my-header2:
  1108.                                   bar \n Support: Extended"
  1109.                                 items:
  1110.                                   type: string
  1111.                                 maxItems: 16
  1112.                                 type: array
  1113.                               set:
  1114.                                 additionalProperties:
  1115.                                   type: string
  1116.                                 description: "Set overwrites the request with the
  1117.                                   given header (name, value) before the action. \n
  1118.                                   Input:   GET /foo HTTP/1.1   my-header: foo \n Config:
  1119.                                   \  set: {\"my-header\": \"bar\"} \n Output:   GET
  1120.                                   /foo HTTP/1.1   my-header: bar \n Support: Extended"
  1121.                                 type: object
  1122.                             type: object
  1123.                           requestMirror:
  1124.                             description: "RequestMirror defines a schema for a filter
  1125.                               that mirrors requests. \n Support: Extended"
  1126.                             properties:
  1127.                               backendRef:
  1128.                                 description: "BackendRef is a local object reference
  1129.                                   to mirror matched requests to. If both BackendRef
  1130.                                   and ServiceName are specified, ServiceName will
  1131.                                   be given precedence. \n If the referent cannot be
  1132.                                   found, the rule is not included in the route. The
  1133.                                   controller should raise the \"ResolvedRefs\" condition
  1134.                                   on the Gateway with the \"DegradedRoutes\" reason.
  1135.                                   The gateway status for this route should be updated
  1136.                                   with a condition that describes the error more specifically.
  1137.                                   \n Support: Custom"
  1138.                                 properties:
  1139.                                   group:
  1140.                                     description: Group is the group of the referent.
  1141.                                     maxLength: 253
  1142.                                     minLength: 1
  1143.                                     type: string
  1144.                                   kind:
  1145.                                     description: Kind is kind of the referent.
  1146.                                     maxLength: 253
  1147.                                     minLength: 1
  1148.                                     type: string
  1149.                                   name:
  1150.                                     description: Name is the name of the referent.
  1151.                                     maxLength: 253
  1152.                                     minLength: 1
  1153.                                     type: string
  1154.                                 required:
  1155.                                 - group
  1156.                                 - kind
  1157.                                 - name
  1158.                                 type: object
  1159.                               port:
  1160.                                 description: "Port specifies the destination port
  1161.                                   number to use for the backend referenced by the
  1162.                                   ServiceName or BackendRef field. \n If unspecified,
  1163.                                   the destination port in the request is used when
  1164.                                   forwarding to a backendRef or serviceName."
  1165.                                 format: int32
  1166.                                 maximum: 65535
  1167.                                 minimum: 1
  1168.                                 type: integer
  1169.                               serviceName:
  1170.                                 description: "ServiceName refers to the name of the
  1171.                                   Service to mirror matched requests to. When specified,
  1172.                                   this takes the place of BackendRef. If both BackendRef
  1173.                                   and ServiceName are specified, ServiceName will
  1174.                                   be given precedence. \n If the referent cannot be
  1175.                                   found, the rule is not included in the route. The
  1176.                                   controller should raise the \"ResolvedRefs\" condition
  1177.                                   on the Gateway with the \"DegradedRoutes\" reason.
  1178.                                   The gateway status for this route should be updated
  1179.                                   with a condition that describes the error more specifically.
  1180.                                   \n Support: Core"
  1181.                                 maxLength: 253
  1182.                                 type: string
  1183.                             type: object
  1184.                           type:
  1185.                             description: "Type identifies the type of filter to apply.
  1186.                               As with other API fields, types are classified into
  1187.                               three conformance levels: \n - Core: Filter types and
  1188.                               their corresponding configuration defined by   \"Support:
  1189.                               Core\" in this package, e.g. \"RequestHeaderModifier\".
  1190.                               All   implementations must support core filters. \n
  1191.                               - Extended: Filter types and their corresponding configuration
  1192.                               defined by   \"Support: Extended\" in this package,
  1193.                               e.g. \"RequestMirror\". Implementers   are encouraged
  1194.                               to support extended filters. \n - Custom: Filters that
  1195.                               are defined and supported by specific vendors.   In
  1196.                               the future, filters showing convergence in behavior
  1197.                               across multiple   implementations will be considered
  1198.                               for inclusion in extended or core   conformance levels.
  1199.                               Filter-specific configuration for such filters   is
  1200.                               specified using the ExtensionRef field. `Type` should
  1201.                               be set to   \"ExtensionRef\" for custom filters. \n
  1202.                               Implementers are encouraged to define custom implementation
  1203.                               types to extend the core API with implementation-specific
  1204.                               behavior."
  1205.                             enum:
  1206.                             - RequestHeaderModifier
  1207.                             - RequestMirror
  1208.                             - ExtensionRef
  1209.                             type: string
  1210.                         required:
  1211.                         - type
  1212.                         type: object
  1213.                       maxItems: 16
  1214.                       type: array
  1215.                     forwardTo:
  1216.                       description: ForwardTo defines the backend(s) where matching
  1217.                         requests should be sent. If unspecified, the rule performs
  1218.                         no forwarding. If unspecified and no filters are specified
  1219.                         that would result in a response being sent, a 503 error code
  1220.                         is returned.
  1221.                       items:
  1222.                         description: HTTPRouteForwardTo defines how a HTTPRoute should
  1223.                           forward a request.
  1224.                         properties:
  1225.                           backendRef:
  1226.                             description: "BackendRef is a reference to a backend to
  1227.                               forward matched requests to. If both BackendRef and
  1228.                               ServiceName are specified, ServiceName will be given
  1229.                               precedence. \n If the referent cannot be found, the
  1230.                               route must be dropped from the Gateway. The controller
  1231.                               should raise the \"ResolvedRefs\" condition on the Gateway
  1232.                               with the \"DegradedRoutes\" reason. The gateway status
  1233.                               for this route should be updated with a condition that
  1234.                               describes the error more specifically. \n Support: Custom"
  1235.                             properties:
  1236.                               group:
  1237.                                 description: Group is the group of the referent.
  1238.                                 maxLength: 253
  1239.                                 minLength: 1
  1240.                                 type: string
  1241.                               kind:
  1242.                                 description: Kind is kind of the referent.
  1243.                                 maxLength: 253
  1244.                                 minLength: 1
  1245.                                 type: string
  1246.                               name:
  1247.                                 description: Name is the name of the referent.
  1248.                                 maxLength: 253
  1249.                                 minLength: 1
  1250.                                 type: string
  1251.                             required:
  1252.                             - group
  1253.                             - kind
  1254.                             - name
  1255.                             type: object
  1256.                           filters:
  1257.                             description: "Filters defined at this-level should be
  1258.                               executed if and only if the request is being forwarded
  1259.                               to the backend defined here. \n Support: Custom (For
  1260.                               broader support of filters, use the Filters field in
  1261.                               HTTPRouteRule.)"
  1262.                             items:
  1263.                               description: 'HTTPRouteFilter defines additional processing
  1264.                                 steps that must be completed during the request or
  1265.                                 response lifecycle. HTTPRouteFilters are meant as
  1266.                                 an extension point to express additional processing
  1267.                                 that may be done in Gateway implementations. Some
  1268.                                 examples include request or response modification,
  1269.                                 implementing authentication strategies, rate-limiting,
  1270.                                 and traffic shaping. API guarantee/conformance is
  1271.                                 defined based on the type of the filter. TODO(hbagdi):
  1272.                                 re-render CRDs once controller-tools supports union
  1273.                                 tags: - https://github.com/kubernetes-sigs/controller-tools/pull/298
  1274.                                 - https://github.com/kubernetes-sigs/controller-tools/issues/461'
  1275.                               properties:
  1276.                                 extensionRef:
  1277.                                   description: "ExtensionRef is an optional, implementation-specific
  1278.                                     extension to the \"filter\" behavior.  For example,
  1279.                                     resource \"myroutefilter\" in group \"networking.acme.io\").
  1280.                                     ExtensionRef MUST NOT be used for core and extended
  1281.                                     filters. \n Support: Implementation-specific"
  1282.                                   properties:
  1283.                                     group:
  1284.                                       description: Group is the group of the referent.
  1285.                                       maxLength: 253
  1286.                                       minLength: 1
  1287.                                       type: string
  1288.                                     kind:
  1289.                                       description: Kind is kind of the referent.
  1290.                                       maxLength: 253
  1291.                                       minLength: 1
  1292.                                       type: string
  1293.                                     name:
  1294.                                       description: Name is the name of the referent.
  1295.                                       maxLength: 253
  1296.                                       minLength: 1
  1297.                                       type: string
  1298.                                   required:
  1299.                                   - group
  1300.                                   - kind
  1301.                                   - name
  1302.                                   type: object
  1303.                                 requestHeaderModifier:
  1304.                                   description: "RequestHeaderModifier defines a schema
  1305.                                     for a filter that modifies request headers. \n
  1306.                                     Support: Core"
  1307.                                   properties:
  1308.                                     add:
  1309.                                       additionalProperties:
  1310.                                         type: string
  1311.                                       description: "Add adds the given header (name,
  1312.                                         value) to the request before the action. It
  1313.                                         appends to any existing values associated
  1314.                                         with the header name. \n Input:   GET /foo
  1315.                                         HTTP/1.1   my-header: foo \n Config:   add:
  1316.                                         {\"my-header\": \"bar\"} \n Output:   GET
  1317.                                         /foo HTTP/1.1   my-header: foo   my-header:
  1318.                                         bar \n Support: Extended"
  1319.                                       type: object
  1320.                                     remove:
  1321.                                       description: "Remove the given header(s) from
  1322.                                         the HTTP request before the action. The value
  1323.                                         of RemoveHeader is a list of HTTP header names.
  1324.                                         Note that the header names are case-insensitive
  1325.                                         [RFC-2616 4.2]. \n Input:   GET /foo HTTP/1.1
  1326.                                         \  my-header1: foo   my-header2: bar   my-header3:
  1327.                                         baz \n Config:   remove: [\"my-header1\",
  1328.                                         \"my-header3\"] \n Output:   GET /foo HTTP/1.1
  1329.                                         \  my-header2: bar \n Support: Extended"
  1330.                                       items:
  1331.                                         type: string
  1332.                                       maxItems: 16
  1333.                                       type: array
  1334.                                     set:
  1335.                                       additionalProperties:
  1336.                                         type: string
  1337.                                       description: "Set overwrites the request with
  1338.                                         the given header (name, value) before the
  1339.                                         action. \n Input:   GET /foo HTTP/1.1   my-header:
  1340.                                         foo \n Config:   set: {\"my-header\": \"bar\"}
  1341.                                         \n Output:   GET /foo HTTP/1.1   my-header:
  1342.                                         bar \n Support: Extended"
  1343.                                       type: object
  1344.                                   type: object
  1345.                                 requestMirror:
  1346.                                   description: "RequestMirror defines a schema for
  1347.                                     a filter that mirrors requests. \n Support: Extended"
  1348.                                   properties:
  1349.                                     backendRef:
  1350.                                       description: "BackendRef is a local object reference
  1351.                                         to mirror matched requests to. If both BackendRef
  1352.                                         and ServiceName are specified, ServiceName
  1353.                                         will be given precedence. \n If the referent
  1354.                                         cannot be found, the rule is not included
  1355.                                         in the route. The controller should raise
  1356.                                         the \"ResolvedRefs\" condition on the Gateway
  1357.                                         with the \"DegradedRoutes\" reason. The gateway
  1358.                                         status for this route should be updated with
  1359.                                         a condition that describes the error more
  1360.                                         specifically. \n Support: Custom"
  1361.                                       properties:
  1362.                                         group:
  1363.                                           description: Group is the group of the referent.
  1364.                                           maxLength: 253
  1365.                                           minLength: 1
  1366.                                           type: string
  1367.                                         kind:
  1368.                                           description: Kind is kind of the referent.
  1369.                                           maxLength: 253
  1370.                                           minLength: 1
  1371.                                           type: string
  1372.                                         name:
  1373.                                           description: Name is the name of the referent.
  1374.                                           maxLength: 253
  1375.                                           minLength: 1
  1376.                                           type: string
  1377.                                       required:
  1378.                                       - group
  1379.                                       - kind
  1380.                                       - name
  1381.                                       type: object
  1382.                                     port:
  1383.                                       description: "Port specifies the destination
  1384.                                         port number to use for the backend referenced
  1385.                                         by the ServiceName or BackendRef field. \n
  1386.                                         If unspecified, the destination port in the
  1387.                                         request is used when forwarding to a backendRef
  1388.                                         or serviceName."
  1389.                                       format: int32
  1390.                                       maximum: 65535
  1391.                                       minimum: 1
  1392.                                       type: integer
  1393.                                     serviceName:
  1394.                                       description: "ServiceName refers to the name
  1395.                                         of the Service to mirror matched requests
  1396.                                         to. When specified, this takes the place of
  1397.                                         BackendRef. If both BackendRef and ServiceName
  1398.                                         are specified, ServiceName will be given precedence.
  1399.                                         \n If the referent cannot be found, the rule
  1400.                                         is not included in the route. The controller
  1401.                                         should raise the \"ResolvedRefs\" condition
  1402.                                         on the Gateway with the \"DegradedRoutes\"
  1403.                                         reason. The gateway status for this route
  1404.                                         should be updated with a condition that describes
  1405.                                         the error more specifically. \n Support: Core"
  1406.                                       maxLength: 253
  1407.                                       type: string
  1408.                                   type: object
  1409.                                 type:
  1410.                                   description: "Type identifies the type of filter
  1411.                                     to apply. As with other API fields, types are
  1412.                                     classified into three conformance levels: \n -
  1413.                                     Core: Filter types and their corresponding configuration
  1414.                                     defined by   \"Support: Core\" in this package,
  1415.                                     e.g. \"RequestHeaderModifier\". All   implementations
  1416.                                     must support core filters. \n - Extended: Filter
  1417.                                     types and their corresponding configuration defined
  1418.                                     by   \"Support: Extended\" in this package, e.g.
  1419.                                     \"RequestMirror\". Implementers   are encouraged
  1420.                                     to support extended filters. \n - Custom: Filters
  1421.                                     that are defined and supported by specific vendors.
  1422.                                     \  In the future, filters showing convergence
  1423.                                     in behavior across multiple   implementations
  1424.                                     will be considered for inclusion in extended or
  1425.                                     core   conformance levels. Filter-specific configuration
  1426.                                     for such filters   is specified using the ExtensionRef
  1427.                                     field. `Type` should be set to   \"ExtensionRef\"
  1428.                                     for custom filters. \n Implementers are encouraged
  1429.                                     to define custom implementation types to extend
  1430.                                     the core API with implementation-specific behavior."
  1431.                                   enum:
  1432.                                   - RequestHeaderModifier
  1433.                                   - RequestMirror
  1434.                                   - ExtensionRef
  1435.                                   type: string
  1436.                               required:
  1437.                               - type
  1438.                               type: object
  1439.                             maxItems: 16
  1440.                             type: array
  1441.                           port:
  1442.                             description: "Port specifies the destination port number
  1443.                               to use for the backend referenced by the ServiceName
  1444.                               or BackendRef field. If unspecified, the destination
  1445.                               port in the request is used when forwarding to a backendRef
  1446.                               or serviceName. \n Support: Core"
  1447.                             format: int32
  1448.                             maximum: 65535
  1449.                             minimum: 1
  1450.                             type: integer
  1451.                           serviceName:
  1452.                             description: "ServiceName refers to the name of the Service
  1453.                               to forward matched requests to. When specified, this
  1454.                               takes the place of BackendRef. If both BackendRef and
  1455.                               ServiceName are specified, ServiceName will be given
  1456.                               precedence. \n If the referent cannot be found, the
  1457.                               route must be dropped from the Gateway. The controller
  1458.                               should raise the \"ResolvedRefs\" condition on the Gateway
  1459.                               with the \"DegradedRoutes\" reason. The gateway status
  1460.                               for this route should be updated with a condition that
  1461.                               describes the error more specifically. \n The protocol
  1462.                               to use should be specified with the AppProtocol field
  1463.                               on Service resources. This field was introduced in Kubernetes
  1464.                               1.18. If using an earlier version of Kubernetes, a `networking.x-k8s.io/app-protocol`
  1465.                               annotation on the BackendPolicy resource may be used
  1466.                               to define the protocol. If the AppProtocol field is
  1467.                               available, this annotation should not be used. The AppProtocol
  1468.                               field, when populated, takes precedence over the annotation
  1469.                               in the BackendPolicy resource. For custom backends,
  1470.                               it is encouraged to add a semantically-equivalent field
  1471.                               in the Custom Resource Definition. \n Support: Core"
  1472.                             maxLength: 253
  1473.                             type: string
  1474.                           weight:
  1475.                             default: 1
  1476.                             description: "Weight specifies the proportion of HTTP
  1477.                               requests forwarded to the backend referenced by the
  1478.                               ServiceName or BackendRef field. This is computed as
  1479.                               weight/(sum of all weights in this ForwardTo list).
  1480.                               For non-zero values, there may be some epsilon from
  1481.                               the exact proportion defined here depending on the precision
  1482.                               an implementation supports. Weight is not a percentage
  1483.                               and the sum of weights does not need to equal 100. \n
  1484.                               If only one backend is specified and it has a weight
  1485.                               greater than 0, 100% of the traffic is forwarded to
  1486.                               that backend. If weight is set to 0, no traffic should
  1487.                               be forwarded for this entry. If unspecified, weight
  1488.                               defaults to 1. \n Support: Core"
  1489.                             format: int32
  1490.                             maximum: 1000000
  1491.                             minimum: 0
  1492.                             type: integer
  1493.                         type: object
  1494.                       maxItems: 16
  1495.                       type: array
  1496.                     matches:
  1497.                       default:
  1498.                       - path:
  1499.                           type: Prefix
  1500.                           value: /
  1501.                       description: "Matches define conditions used for matching the
  1502.                         rule against incoming HTTP requests. Each match is independent,
  1503.                         i.e. this rule will be matched if **any** one of the matches
  1504.                         is satisfied. \n For example, take the following matches configuration:
  1505.                         \n ``` matches: - path:     value: \"/foo\"   headers:     values:
  1506.                         \      version: \"2\" - path:     value: \"/v2/foo\" ``` \n
  1507.                         For a request to match against this rule, a request should
  1508.                         satisfy EITHER of the two conditions: \n - path prefixed with
  1509.                         `/foo` AND contains the header `version: \"2\"` - path prefix
  1510.                         of `/v2/foo` \n See the documentation for HTTPRouteMatch on
  1511.                         how to specify multiple match conditions that should be ANDed
  1512.                         together. \n If no matches are specified, the default is a
  1513.                         prefix path match on \"/\", which has the effect of matching
  1514.                         every HTTP request. \n Each client request MUST map to a maximum
  1515.                         of one route rule. If a request matches multiple rules, matching
  1516.                         precedence MUST be determined in order of the following criteria,
  1517.                         continuing on ties: \n * The longest matching hostname. *
  1518.                         The longest matching path. * The largest number of header
  1519.                         matches. \n If ties still exist across multiple Routes, matching
  1520.                         precedence MUST be determined in order of the following criteria,
  1521.                         continuing on ties: \n * The oldest Route based on creation
  1522.                         timestamp. For example, a Route with   a creation timestamp
  1523.                         of \"2020-09-08 01:02:03\" is given precedence over   a Route
  1524.                         with a creation timestamp of \"2020-09-08 01:02:04\". * The
  1525.                         Route appearing first in alphabetical order by   \"<namespace>/<name>\".
  1526.                         For example, foo/bar is given precedence over   foo/baz. \n
  1527.                         If ties still exist within the Route that has been given precedence,
  1528.                         matching precedence MUST be granted to the first matching
  1529.                         rule meeting the above criteria."
  1530.                       items:
  1531.                         description: "HTTPRouteMatch defines the predicate used to
  1532.                           match requests to a given action. Multiple match types are
  1533.                           ANDed together, i.e. the match will evaluate to true only
  1534.                           if all conditions are satisfied. \n For example, the match
  1535.                           below will match a HTTP request only if its path starts
  1536.                           with `/foo` AND it contains the `version: \"1\"` header:
  1537.                           \n ``` match:   path:     value: \"/foo\"   headers:     values:
  1538.                           \      version: \"1\" ```"
  1539.                         properties:
  1540.                           extensionRef:
  1541.                             description: "ExtensionRef is an optional, implementation-specific
  1542.                               extension to the \"match\" behavior. For example, resource
  1543.                               \"myroutematcher\" in group \"networking.acme.io\".
  1544.                               If the referent cannot be found, the rule is not included
  1545.                               in the route. The controller should raise the \"ResolvedRefs\"
  1546.                               condition on the Gateway with the \"DegradedRoutes\"
  1547.                               reason. The gateway status for this route should be
  1548.                               updated with a condition that describes the error more
  1549.                               specifically. \n Support: Custom"
  1550.                             properties:
  1551.                               group:
  1552.                                 description: Group is the group of the referent.
  1553.                                 maxLength: 253
  1554.                                 minLength: 1
  1555.                                 type: string
  1556.                               kind:
  1557.                                 description: Kind is kind of the referent.
  1558.                                 maxLength: 253
  1559.                                 minLength: 1
  1560.                                 type: string
  1561.                               name:
  1562.                                 description: Name is the name of the referent.
  1563.                                 maxLength: 253
  1564.                                 minLength: 1
  1565.                                 type: string
  1566.                             required:
  1567.                             - group
  1568.                             - kind
  1569.                             - name
  1570.                             type: object
  1571.                           headers:
  1572.                             description: Headers specifies a HTTP request header matcher.
  1573.                             properties:
  1574.                               type:
  1575.                                 default: Exact
  1576.                                 description: "Type specifies how to match against
  1577.                                   the value of the header. \n Support: Core (Exact)
  1578.                                   \n Support: Custom (RegularExpression, ImplementationSpecific)
  1579.                                   \n Since RegularExpression PathType has custom conformance,
  1580.                                   implementations can support POSIX, PCRE or any other
  1581.                                   dialects of regular expressions. Please read the
  1582.                                   implementation's documentation to determine the
  1583.                                   supported dialect. \n HTTP Header name matching
  1584.                                   MUST be case-insensitive (RFC 2616 - section 4.2)."
  1585.                                 enum:
  1586.                                 - Exact
  1587.                                 - RegularExpression
  1588.                                 - ImplementationSpecific
  1589.                                 type: string
  1590.                               values:
  1591.                                 additionalProperties:
  1592.                                   type: string
  1593.                                 description: "Values is a map of HTTP Headers to be
  1594.                                   matched. It MUST contain at least one entry. \n
  1595.                                   The HTTP header field name to match is the map key,
  1596.                                   and the value of the HTTP header is the map value.
  1597.                                   HTTP header field name matching MUST be case-insensitive.
  1598.                                   \n Multiple match values are ANDed together, meaning,
  1599.                                   a request must match all the specified headers to
  1600.                                   select the route."
  1601.                                 type: object
  1602.                             required:
  1603.                             - values
  1604.                             type: object
  1605.                           path:
  1606.                             default:
  1607.                               type: Prefix
  1608.                               value: /
  1609.                             description: Path specifies a HTTP request path matcher.
  1610.                               If this field is not specified, a default prefix match
  1611.                               on the "/" path is provided.
  1612.                             properties:
  1613.                               type:
  1614.                                 default: Prefix
  1615.                                 description: "Type specifies how to match against
  1616.                                   the path Value. \n Support: Core (Exact, Prefix)
  1617.                                   \n Support: Custom (RegularExpression, ImplementationSpecific)
  1618.                                   \n Since RegularExpression PathType has custom conformance,
  1619.                                   implementations can support POSIX, PCRE or any other
  1620.                                   dialects of regular expressions. Please read the
  1621.                                   implementation's documentation to determine the
  1622.                                   supported dialect."
  1623.                                 enum:
  1624.                                 - Exact
  1625.                                 - Prefix
  1626.                                 - RegularExpression
  1627.                                 - ImplementationSpecific
  1628.                                 type: string
  1629.                               value:
  1630.                                 default: /
  1631.                                 description: Value of the HTTP path to match against.
  1632.                                 type: string
  1633.                             type: object
  1634.                           queryParams:
  1635.                             description: QueryParams specifies a HTTP query parameter
  1636.                               matcher.
  1637.                             properties:
  1638.                               type:
  1639.                                 default: Exact
  1640.                                 description: "Type specifies how to match against
  1641.                                   the value of the query parameter. \n Support: Extended
  1642.                                   (Exact) \n Support: Custom (RegularExpression, ImplementationSpecific)
  1643.                                   \n Since RegularExpression QueryParamMatchType has
  1644.                                   custom conformance, implementations can support
  1645.                                   POSIX, PCRE or any other dialects of regular expressions.
  1646.                                   Please read the implementation's documentation to
  1647.                                   determine the supported dialect."
  1648.                                 enum:
  1649.                                 - Exact
  1650.                                 - RegularExpression
  1651.                                 - ImplementationSpecific
  1652.                                 type: string
  1653.                               values:
  1654.                                 additionalProperties:
  1655.                                   type: string
  1656.                                 description: "Values is a map of HTTP query parameters
  1657.                                   to be matched. It MUST contain at least one entry.
  1658.                                   \n The query parameter name to match is the map
  1659.                                   key, and the value of the query parameter is the
  1660.                                   map value. \n Multiple match values are ANDed together,
  1661.                                   meaning, a request must match all the specified
  1662.                                   query parameters to select the route. \n HTTP query
  1663.                                   parameter matching MUST be case-sensitive for both
  1664.                                   keys and values. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).
  1665.                                   \n Note that the query parameter key MUST always
  1666.                                   be an exact match by string comparison."
  1667.                                 type: object
  1668.                             required:
  1669.                             - values
  1670.                             type: object
  1671.                         type: object
  1672.                       maxItems: 8
  1673.                       type: array
  1674.                   type: object
  1675.                 maxItems: 16
  1676.                 type: array
  1677.               tls:
  1678.                 description: "TLS defines the TLS certificate to use for Hostnames
  1679.                   defined in this Route. This configuration only takes effect if the
  1680.                   AllowRouteOverride field is set to true in the associated Gateway
  1681.                   resource. \n Collisions can happen if multiple HTTPRoutes define
  1682.                   a TLS certificate for the same hostname. In such a case, conflict
  1683.                   resolution guiding principles apply, specifically, if hostnames
  1684.                   are same and two different certificates are specified then the certificate
  1685.                   in the oldest resource wins. \n Please note that HTTP Route-selection
  1686.                   takes place after the TLS Handshake (ClientHello). Due to this,
  1687.                   TLS certificate defined here will take precedence even if the request
  1688.                   has the potential to match multiple routes (in case multiple HTTPRoutes
  1689.                   share the same hostname). \n Support: Core"
  1690.                 properties:
  1691.                   certificateRef:
  1692.                     description: "CertificateRef is a reference to a Kubernetes object
  1693.                       that contains a TLS certificate and private key. This certificate
  1694.                       is used to establish a TLS handshake for requests that match
  1695.                       the hostname of the associated HTTPRoute. The referenced object
  1696.                       MUST reside in the same namespace as HTTPRoute. \n This field
  1697.                       is required when the TLS configuration mode of the associated
  1698.                       Gateway listener is set to \"Passthrough\". \n CertificateRef
  1699.                       can reference a standard Kubernetes resource, i.e. Secret, or
  1700.                       an implementation-specific custom resource. \n Support: Core
  1701.                       (Kubernetes Secrets) \n Support: Implementation-specific (Other
  1702.                       resource types)"
  1703.                     properties:
  1704.                       group:
  1705.                         description: Group is the group of the referent.
  1706.                         maxLength: 253
  1707.                         minLength: 1
  1708.                         type: string
  1709.                       kind:
  1710.                         description: Kind is kind of the referent.
  1711.                         maxLength: 253
  1712.                         minLength: 1
  1713.                         type: string
  1714.                       name:
  1715.                         description: Name is the name of the referent.
  1716.                         maxLength: 253
  1717.                         minLength: 1
  1718.                         type: string
  1719.                     required:
  1720.                     - group
  1721.                     - kind
  1722.                     - name
  1723.                     type: object
  1724.                 required:
  1725.                 - certificateRef
  1726.                 type: object
  1727.             type: object
  1728.           status:
  1729.             description: Status defines the current state of HTTPRoute.
  1730.             properties:
  1731.               gateways:
  1732.                 description: "Gateways is a list of Gateways that are associated with
  1733.                   the route, and the status of the route with respect to each Gateway.
  1734.                   When a Gateway selects this route, the controller that manages the
  1735.                   Gateway must add an entry to this list when the controller first
  1736.                   sees the route and should update the entry as appropriate when the
  1737.                   route is modified. \n A maximum of 100 Gateways will be represented
  1738.                   in this list. If this list is full, there may be additional Gateways
  1739.                   using this Route that are not included in the list. An empty list
  1740.                   means the route has not been admitted by any Gateway."
  1741.                 items:
  1742.                   description: RouteGatewayStatus describes the status of a route
  1743.                     with respect to an associated Gateway.
  1744.                   properties:
  1745.                     conditions:
  1746.                       description: Conditions describes the status of the route with
  1747.                         respect to the Gateway. The "Admitted" condition must always
  1748.                         be specified by controllers to indicate whether the route
  1749.                         has been admitted or rejected by the Gateway, and why. Note
  1750.                         that the route's availability is also subject to the Gateway's
  1751.                         own status conditions and listener status.
  1752.                       items:
  1753.                         description: "Condition contains details for one aspect of
  1754.                           the current state of this API Resource. --- This struct
  1755.                           is intended for direct use as an array at the field path
  1756.                           .status.conditions.  For example, type FooStatus struct{
  1757.                           \    // Represents the observations of a foo's current state.
  1758.                           \    // Known .status.conditions.type are: \"Available\",
  1759.                           \"Progressing\", and \"Degraded\"     // +patchMergeKey=type
  1760.                           \    // +patchStrategy=merge     // +listType=map     //
  1761.                           +listMapKey=type     Conditions []metav1.Condition `json:\"conditions,omitempty\"
  1762.                           patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
  1763.                           \n     // other fields }"
  1764.                         properties:
  1765.                           lastTransitionTime:
  1766.                             description: lastTransitionTime is the last time the condition
  1767.                               transitioned from one status to another. This should
  1768.                               be when the underlying condition changed.  If that is
  1769.                               not known, then using the time when the API field changed
  1770.                               is acceptable.
  1771.                             format: date-time
  1772.                             type: string
  1773.                           message:
  1774.                             description: message is a human readable message indicating
  1775.                               details about the transition. This may be an empty string.
  1776.                             maxLength: 32768
  1777.                             type: string
  1778.                           observedGeneration:
  1779.                             description: observedGeneration represents the .metadata.generation
  1780.                               that the condition was set based upon. For instance,
  1781.                               if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
  1782.                               is 9, the condition is out of date with respect to the
  1783.                               current state of the instance.
  1784.                             format: int64
  1785.                             minimum: 0
  1786.                             type: integer
  1787.                           reason:
  1788.                             description: reason contains a programmatic identifier
  1789.                               indicating the reason for the condition's last transition.
  1790.                               Producers of specific condition types may define expected
  1791.                               values and meanings for this field, and whether the
  1792.                               values are considered a guaranteed API. The value should
  1793.                               be a CamelCase string. This field may not be empty.
  1794.                             maxLength: 1024
  1795.                             minLength: 1
  1796.                             pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  1797.                             type: string
  1798.                           status:
  1799.                             description: status of the condition, one of True, False,
  1800.                               Unknown.
  1801.                             enum:
  1802.                             - "True"
  1803.                             - "False"
  1804.                             - Unknown
  1805.                             type: string
  1806.                           type:
  1807.                             description: type of condition in CamelCase or in foo.example.com/CamelCase.
  1808.                               --- Many .condition.type values are consistent across
  1809.                               resources like Available, but because arbitrary conditions
  1810.                               can be useful (see .node.status.conditions), the ability
  1811.                               to deconflict is important. The regex it matches is
  1812.                               (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  1813.                             maxLength: 316
  1814.                             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])$
  1815.                             type: string
  1816.                         required:
  1817.                         - lastTransitionTime
  1818.                         - message
  1819.                         - reason
  1820.                         - status
  1821.                         - type
  1822.                         type: object
  1823.                       maxItems: 8
  1824.                       type: array
  1825.                       x-kubernetes-list-map-keys:
  1826.                       - type
  1827.                       x-kubernetes-list-type: map
  1828.                     gatewayRef:
  1829.                       description: GatewayRef is a reference to a Gateway object that
  1830.                         is associated with the route.
  1831.                       properties:
  1832.                         controller:
  1833.                           description: "Controller is a domain/path string that indicates
  1834.                             the controller implementing the Gateway. This corresponds
  1835.                             with the controller field on GatewayClass. \n Example:
  1836.                             \"acme.io/gateway-controller\". \n The format of this
  1837.                             field is DOMAIN \"/\" PATH, where DOMAIN and PATH are
  1838.                             valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)."
  1839.                           maxLength: 253
  1840.                           type: string
  1841.                         name:
  1842.                           description: Name is the name of the referent.
  1843.                           maxLength: 253
  1844.                           minLength: 1
  1845.                           type: string
  1846.                         namespace:
  1847.                           description: Namespace is the namespace of the referent.
  1848.                           maxLength: 253
  1849.                           minLength: 1
  1850.                           type: string
  1851.                       required:
  1852.                       - name
  1853.                       - namespace
  1854.                       type: object
  1855.                   required:
  1856.                   - gatewayRef
  1857.                   type: object
  1858.                 maxItems: 100
  1859.                 type: array
  1860.             required:
  1861.             - gateways
  1862.             type: object
  1863.         type: object
  1864.     served: true
  1865.     storage: true
  1866.     subresources:
  1867.       status: {}
  1868. status:
  1869.   acceptedNames:
  1870.     kind: ""
  1871.     plural: ""
  1872.   conditions: []
  1873.   storedVersions: []

RBAC

  1. ---
  2. apiVersion: rbac.authorization.k8s.io/v1
  3. kind: ClusterRole
  4. metadata:
  5.   name: gateway-role
  6. rules:
  7.   - apiGroups:
  8.       - ""
  9.     resources:
  10.       - services
  11.       - endpoints
  12.       - secrets
  13.     verbs:
  14.       - get
  15.       - list
  16.       - watch
  17.   - apiGroups:
  18.       - networking.x-k8s.io
  19.     resources:
  20.       - gatewayclasses
  21.       - gateways
  22.       - httproutes
  23.       - tcproutes
  24.       - tlsroutes
  25.     verbs:
  26.       - get
  27.       - list
  28.       - watch
  29.   - apiGroups:
  30.       - networking.x-k8s.io
  31.     resources:
  32.       - gatewayclasses/status
  33.       - gateways/status
  34.       - httproutes/status
  35.       - tcproutes/status
  36.       - tlsroutes/status
  37.     verbs:
  38.       - update
  40. ---
  41. kind: ClusterRoleBinding
  42. apiVersion: rbac.authorization.k8s.io/v1beta1
  43. metadata:
  44.   name: gateway-controller
  46. roleRef:
  47.   apiGroup: rbac.authorization.k8s.io
  48.   kind: ClusterRole
  49.   name: gateway-role
  50. subjects:
  51.   - kind: ServiceAccount
  52.     name: traefik-controller
  53.     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.3.0 (v1alpha1).

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)

  1. providers:
  2.   kubernetesGateway:
  3.     endpoint: "http://localhost:8080"
  4.     # ...

File (TOML)

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

CLI

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

token

Optional, Default=””

Bearer token used for the Kubernetes client configuration.

File (YAML)

  1. providers:
  2.   kubernetesGateway:
  3.     token: "mytoken"
  4.     # ...

File (TOML)

  1. [providers.kubernetesGateway]
  2.   token = "mytoken"
  3.   # ...

CLI

  1. --providers.kubernetesgateway.token=mytoken

certAuthFilePath

Optional, Default=””

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

File (YAML)

  1. providers:
  2.   kubernetesGateway:
  3.     certAuthFilePath: "/my/ca.crt"
  4.     # ...

File (TOML)

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

CLI

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

namespaces

Optional, Default: []

Array of namespaces to watch. If left empty, watches all namespaces if the value of namespaces.

File (YAML)

  1. providers:
  2.   kubernetesGateway:
  3.     namespaces:
  4.     - "default"
  5.     - "production"
  6.     # ...

File (TOML)

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

CLI

  1. --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)

  1. providers:
  2.   kubernetesGateway:
  3.     labelselector: "app=traefik"
  4.     # ...

File (TOML)

  1. [providers.kubernetesGateway]
  2.   labelselector = "app=traefik"
  3.   # ...

CLI

  1. --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)

  1. providers:
  2.   kubernetesGateway:
  3.     throttleDuration: "10s"
  4.     # ...

File (TOML)

  1. [providers.kubernetesGateway]
  2.   throttleDuration = "10s"
  3.   # ...

CLI

  1. --providers.kubernetesgateway.throttleDuration=10s