← Back to index Esc
Kind
Ingressroutetcp
Group
traefik.io
Version
v1alpha1
apiVersion: traefik.io/v1alpha1 kind: Ingressroutetcp metadata: name: example
View raw schema
apiVersion string
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
kind string
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
metadata object required
spec object required
IngressRouteTCPSpec defines the desired state of IngressRouteTCP.
entryPoints []string
EntryPoints defines the list of entry point names to bind to. Entry points have to be configured in the static configuration. More info: https://doc.traefik.io/traefik/v3.6/reference/install-configuration/entrypoints/ Default: all.
routes []object required
Routes defines the list of routes.
match string required
Match defines the router's rule. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/routing/rules-and-priority/
middlewares []object
Middlewares defines the list of references to MiddlewareTCP resources.
name string required
Name defines the name of the referenced Traefik resource.
namespace string
Namespace defines the namespace of the referenced Traefik resource.
priority integer
Priority defines the router's priority. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/routing/rules-and-priority/#priority
maximum: 9.223372036854775e+18
services []object
Services defines the list of TCP services.
name string required
Name defines the name of the referenced Kubernetes Service.
namespace string
Namespace defines the namespace of the referenced Kubernetes Service.
nativeLB boolean
NativeLB controls, when creating the load-balancer, whether the LB's children are directly the pods IPs or if the only child is the Kubernetes Service clusterIP. The Kubernetes Service itself does load-balance to the pods. By default, NativeLB is false.
nodePortLB boolean
NodePortLB controls, when creating the load-balancer, whether the LB's children are directly the nodes internal IPs using the nodePort when the service type is NodePort. It allows services to be reachable when Traefik runs externally from the Kubernetes cluster but within the same network of the nodes. By default, NodePortLB is false.
port object required
Port defines the port of a Kubernetes Service. This can be a reference to a named port.
proxyProtocol object
ProxyProtocol defines the PROXY protocol configuration. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/service/#proxy-protocol Deprecated: ProxyProtocol will not be supported in future APIVersions, please use ServersTransport to configure ProxyProtocol instead.
version integer
Version defines the PROXY Protocol version to use.
minimum: 1
maximum: 2
serversTransport string
ServersTransport defines the name of ServersTransportTCP resource to use. It allows to configure the transport between Traefik and your servers. Can only be used on a Kubernetes Service.
terminationDelay integer
TerminationDelay defines the deadline that the proxy sets, after one of its connected peers indicates it has closed the writing capability of its connection, to close the reading capability as well, hence fully terminating the connection. It is a duration in milliseconds, defaulting to 100. A negative value means an infinite deadline (i.e. the reading capability is never closed). Deprecated: TerminationDelay will not be supported in future APIVersions, please use ServersTransport to configure the TerminationDelay instead.
tls boolean
TLS determines whether to use TLS when dialing with the backend.
weight integer
Weight defines the weight used when balancing requests between multiple Kubernetes Service.
minimum: 0
syntax string
Syntax defines the router's rule syntax. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/routing/rules-and-priority/#rulesyntax Deprecated: Please do not use this field and rewrite the router rules to use the v3 syntax.
enum: v3, v2
tls object
TLS defines the TLS configuration on a layer 4 / TCP Route. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/routing/router/#tls
certResolver string
CertResolver defines the name of the certificate resolver to use. Cert resolvers have to be configured in the static configuration. More info: https://doc.traefik.io/traefik/v3.6/reference/install-configuration/tls/certificate-resolvers/acme/
domains []object
Domains defines the list of domains that will be used to issue certificates. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/tls/#domains
main string
Main defines the main domain name.
sans []string
SANs defines the subject alternative domain names.
options object
Options defines the reference to a TLSOption, that specifies the parameters of the TLS connection. If not defined, the `default` TLSOption is used. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/tcp/tls/#tls-options
name string required
Name defines the name of the referenced Traefik resource.
namespace string
Namespace defines the namespace of the referenced Traefik resource.
passthrough boolean
Passthrough defines whether a TLS router will terminate the TLS connection.
secretName string
SecretName is the name of the referenced Kubernetes Secret to specify the certificate details.
store object
Store defines the reference to the TLSStore, that will be used to store certificates. Please note that only `default` TLSStore can be used.
name string required
Name defines the name of the referenced Traefik resource.
namespace string
Namespace defines the namespace of the referenced Traefik resource.
Copied!