2021-05-20 09:50:12 +00:00
---
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2021-07-15 15:20:08 +00:00
controller-gen.kubebuilder.io/version : v0.5.0
2021-05-20 09:50:12 +00:00
creationTimestamp : null
name : tcproutes.networking.x-k8s.io
spec :
group : networking.x-k8s.io
names :
2021-07-15 15:20:08 +00:00
categories :
- gateway-api
2021-05-20 09:50:12 +00:00
kind : TCPRoute
listKind : TCPRouteList
plural : tcproutes
singular : tcproute
scope : Namespaced
versions :
2021-07-15 15:20:08 +00:00
- additionalPrinterColumns :
- jsonPath : .metadata.creationTimestamp
name : Age
type : date
name : v1alpha1
2021-05-20 09:50:12 +00:00
schema :
openAPIV3Schema :
description : TCPRoute is the Schema for the TCPRoute resource.
properties :
apiVersion :
2021-07-15 15:20:08 +00:00
description : 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
2021-05-20 09:50:12 +00:00
type : string
kind :
2021-07-15 15:20:08 +00:00
description : 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
2021-05-20 09:50:12 +00:00
type : string
metadata :
type : object
spec :
description : Spec defines the desired state of TCPRoute.
properties :
gateways :
default :
allow : SameNamespace
description : Gateways defines which Gateways can use this Route.
properties :
allow :
default : SameNamespace
2021-07-15 15:20:08 +00:00
description : 'Allow indicates which Gateways will be allowed to
use this route. Possible values are: * All : Gateways in any
namespace can use this route. * FromList : Only Gateways specified
in GatewayRefs may use this route. * SameNamespace : Only Gateways
in the same namespace may use this route.'
2021-05-20 09:50:12 +00:00
enum :
- All
- FromList
- SameNamespace
type : string
gatewayRefs :
2021-07-15 15:20:08 +00:00
description : GatewayRefs must be specified when Allow is set to
"FromList" . In that case, only Gateways referenced in this list
will be allowed to use this route. This field is ignored for
other values of "Allow".
2021-05-20 09:50:12 +00:00
items :
2021-07-15 15:20:08 +00:00
description : GatewayReference identifies a Gateway in a specified
namespace.
2021-05-20 09:50:12 +00:00
properties :
name :
description : Name is the name of the referent.
maxLength : 253
minLength : 1
type : string
namespace :
description : Namespace is the namespace of the referent.
maxLength : 253
minLength : 1
type : string
required :
- name
- namespace
type : object
type : array
type : object
rules :
description : Rules are a list of TCP matchers and actions.
items :
description : TCPRouteRule is the configuration for a given rule.
properties :
forwardTo :
2021-07-15 15:20:08 +00:00
description : ForwardTo defines the backend(s) where matching
requests should be sent.
2021-05-20 09:50:12 +00:00
items :
2021-07-15 15:20:08 +00:00
description : RouteForwardTo defines how a Route should forward
a request.
2021-05-20 09:50:12 +00:00
properties :
backendRef :
2021-07-15 15:20:08 +00:00
description : "BackendRef is a reference to a backend to
forward matched requests to. If both BackendRef and
ServiceName are specified, ServiceName will be given
precedence. \n If the referent cannot be found, the
rule is not included in the route. The controller should
raise the \"ResolvedRefs\" condition on the Gateway
with the \"DegradedRoutes\" reason. The gateway status
for this route should be updated with a condition that
describes the error more specifically. \n Support : Custom"
2021-05-20 09:50:12 +00:00
properties :
group :
description : Group is the group of the referent.
maxLength : 253
minLength : 1
type : string
kind :
description : Kind is kind of the referent.
maxLength : 253
minLength : 1
type : string
name :
description : Name is the name of the referent.
maxLength : 253
minLength : 1
type : string
required :
- group
- kind
- name
type : object
port :
2021-07-15 15:20:08 +00:00
description : "Port specifies the destination port number
to use for the backend referenced by the ServiceName
or BackendRef field. If unspecified, the destination
port in the request is used when forwarding to a backendRef
or serviceName. \n Support : Core"
2021-05-20 09:50:12 +00:00
format : int32
maximum : 65535
minimum : 1
type : integer
serviceName :
2021-07-15 15:20:08 +00:00
description : "ServiceName refers to the name of the Service
to forward matched requests to. When specified, this
takes the place of BackendRef. If both BackendRef and
ServiceName are specified, ServiceName will be given
precedence. \n If the referent cannot be found, the
rule is not included in the route. The controller should
raise the \"ResolvedRefs\" condition on the Gateway
with the \"DegradedRoutes\" reason. The gateway status
for this route should be updated with a condition that
describes the error more specifically. \n The protocol
to use is defined using AppProtocol field (introduced
in Kubernetes 1.18) in the Service resource. In the
absence of the AppProtocol field a `networking.x-k8s.io/app-protocol`
annotation on the BackendPolicy resource may be used
to define the protocol. If the AppProtocol field is
available, this annotation should not be used. The AppProtocol
field, when populated, takes precedence over the annotation
in the BackendPolicy resource. For custom backends,
it is encouraged to add a semantically-equivalent field
in the Custom Resource Definition. \n Support : Core"
2021-05-20 09:50:12 +00:00
maxLength : 253
type : string
weight :
default : 1
2021-07-15 15:20:08 +00:00
description : "Weight specifies the proportion of HTTP
requests forwarded to the backend referenced by the
ServiceName or BackendRef field. This is computed as
weight/(sum of all weights in this ForwardTo list).
For non-zero values, there may be some epsilon from
the exact proportion defined here depending on the precision
an implementation supports. Weight is not a percentage
and the sum of weights does not need to equal 100. \n
If only one backend is specified and it has a weight
greater than 0, 100% of the traffic is forwarded to
that backend. If weight is set to 0, no traffic should
be forwarded for this entry. If unspecified, weight
defaults to 1. \n Support : Extended"
2021-05-20 09:50:12 +00:00
format : int32
maximum : 1000000
minimum : 0
type : integer
type : object
maxItems : 16
minItems : 1
type : array
matches :
2021-07-15 15:20:08 +00:00
description : "Matches define conditions used for matching the
rule against incoming TCP connections. Each match is independent,
i.e. this rule will be matched if **any** one of the matches
is satisfied. If unspecified (i.e. empty), this Rule will
match all requests for the associated Listener. \n Each client
request MUST map to a maximum of one route rule. If a request
matches multiple rules, matching precedence MUST be determined
in order of the following criteria, continuing on ties : \n
* The most specific match specified by ExtensionRef. Each
implementation that supports ExtensionRef may have different
ways of determining the specificity of the referenced extension.
\n If ties still exist across multiple Routes, matching precedence
MUST be determined in order of the following criteria, continuing
on ties : \n * The oldest Route based on creation timestamp.
For example, a Route with a creation timestamp of \"2020-09-08
01 : 02 : 03 \" is given precedence over a Route with a creation
timestamp of \"2020-09-08 01:02:04\". * The Route appearing
first in alphabetical order by \"<namespace>/<name>\". For
example, foo/bar is given precedence over foo/baz. \n If
ties still exist within the Route that has been given precedence,
matching precedence MUST be granted to the first matching
rule meeting the above criteria."
2021-05-20 09:50:12 +00:00
items :
2021-07-15 15:20:08 +00:00
description : TCPRouteMatch defines the predicate used to match
connections to a given action.
2021-05-20 09:50:12 +00:00
properties :
extensionRef :
2021-07-15 15:20:08 +00:00
description : "ExtensionRef is an optional, implementation-specific
extension to the \"match\" behavior. For example, resource
\"mytcproutematcher\" in group \"networking.acme.io\".
If the referent cannot be found, the rule is not included
in the route. The controller should raise the \"ResolvedRefs\"
condition on the Gateway with the \"DegradedRoutes\"
reason. The gateway status for this route should be
updated with a condition that describes the error more
specifically. \n Support : Custom"
2021-05-20 09:50:12 +00:00
properties :
group :
description : Group is the group of the referent.
maxLength : 253
minLength : 1
type : string
kind :
description : Kind is kind of the referent.
maxLength : 253
minLength : 1
type : string
name :
description : Name is the name of the referent.
maxLength : 253
minLength : 1
type : string
required :
- group
- kind
- name
type : object
type : object
maxItems : 8
type : array
required :
- forwardTo
type : object
maxItems : 16
minItems : 1
type : array
required :
- rules
type : object
status :
description : Status defines the current state of TCPRoute.
properties :
gateways :
2021-07-15 15:20:08 +00:00
description : "Gateways is a list of Gateways that are associated with
the route, and the status of the route with respect to each Gateway.
When a Gateway selects this route, the controller that manages the
Gateway must add an entry to this list when the controller first
sees the route and should update the entry as appropriate when the
route is modified. \n A maximum of 100 Gateways will be represented
in this list. If this list is full, there may be additional Gateways
using this Route that are not included in the list. An empty list
means the route has not been admitted by any Gateway."
2021-05-20 09:50:12 +00:00
items :
2021-07-15 15:20:08 +00:00
description : RouteGatewayStatus describes the status of a route
with respect to an associated Gateway.
2021-05-20 09:50:12 +00:00
properties :
conditions :
2021-07-15 15:20:08 +00:00
description : Conditions describes the status of the route with
respect to the Gateway. The "Admitted" condition must always
be specified by controllers to indicate whether the route
has been admitted or rejected by the Gateway, and why. Note
that the route's availability is also subject to the Gateway's
own status conditions and listener status.
2021-05-20 09:50:12 +00:00
items :
2021-07-15 15:20:08 +00:00
description : "Condition contains details for one aspect of
the current state of this API Resource. --- This struct
is intended for direct use as an array at the field path
.status.conditions. For example, type FooStatus struct{
\ // Represents the observations of a foo's current state.
\ // Known .status.conditions.type are : \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type
\ // +patchStrategy=merge // +listType=map //
+listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
\n // other fields }"
2021-05-20 09:50:12 +00:00
properties :
lastTransitionTime :
2021-07-15 15:20:08 +00:00
description : lastTransitionTime is the last time the condition
transitioned from one status to another. This should
be when the underlying condition changed. If that is
not known, then using the time when the API field changed
is acceptable.
2021-05-20 09:50:12 +00:00
format : date-time
type : string
message :
2021-07-15 15:20:08 +00:00
description : message is a human readable message indicating
details about the transition. This may be an empty string.
2021-05-20 09:50:12 +00:00
maxLength : 32768
type : string
observedGeneration :
2021-07-15 15:20:08 +00:00
description : observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance,
if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the
current state of the instance.
2021-05-20 09:50:12 +00:00
format : int64
minimum : 0
type : integer
reason :
2021-07-15 15:20:08 +00:00
description : reason contains a programmatic identifier
indicating the reason for the condition's last transition.
Producers of specific condition types may define expected
values and meanings for this field, and whether the
values are considered a guaranteed API. The value should
be a CamelCase string. This field may not be empty.
2021-05-20 09:50:12 +00:00
maxLength : 1024
minLength : 1
pattern : ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type : string
status :
2021-07-15 15:20:08 +00:00
description : status of the condition, one of True, False,
Unknown.
2021-05-20 09:50:12 +00:00
enum :
- "True"
- "False"
- Unknown
type : string
type :
2021-07-15 15:20:08 +00:00
description : type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across
resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability
to deconflict is important. The regex it matches is
(dns1123SubdomainFmt/)?(qualifiedNameFmt)
2021-05-20 09:50:12 +00:00
maxLength : 316
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])$
type : string
required :
- lastTransitionTime
- message
- reason
- status
- type
type : object
maxItems : 8
type : array
x-kubernetes-list-map-keys :
- type
x-kubernetes-list-type : map
gatewayRef :
2021-07-15 15:20:08 +00:00
description : GatewayRef is a reference to a Gateway object that
is associated with the route.
2021-05-20 09:50:12 +00:00
properties :
2021-07-15 15:20:08 +00:00
controller :
description : "Controller is a domain/path string that indicates
the controller implementing the Gateway. This corresponds
with the controller field on GatewayClass. \n Example :
\"acme.io/gateway-controller\". \n The format of this
field is DOMAIN \"/\" PATH, where DOMAIN and PATH are
valid Kubernetes names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)."
maxLength : 253
type : string
2021-05-20 09:50:12 +00:00
name :
description : Name is the name of the referent.
maxLength : 253
minLength : 1
type : string
namespace :
description : Namespace is the namespace of the referent.
maxLength : 253
minLength : 1
type : string
required :
- name
- namespace
type : object
required :
- gatewayRef
type : object
maxItems : 100
type : array
required :
- gateways
type : object
type : object
served : true
storage : true
subresources :
status : {}
status :
acceptedNames :
kind : ""
plural : ""
conditions : [ ]
storedVersions : [ ]
