Router
| API version | kobblestone.io/v1alpha1 |
|---|---|
| Kind | Router |
| Scope | Namespaced |
| kubectl | kubectl get routers |
A Router defines a lightweight proxy routing Minecraft traffic based on the Server Address field of handshakes.
Usually, routers sit on the edge of your Minecraft infrastructure and may very well be exposed to the internet.
Routes are configured via Route objects.
spec
hostnames[]stringList of hostnames this Router accepts. Supports wildcard.
Note: An empty list does not mean “accept any”, it means “accept none”. Use * entry to accept any.
networkingobjectNetworking options.
5 fields
allowAddresses[]stringList of IPs and networks (CIDR) to allow. Allows everything by default.
backendDialTimeoutstringConfigures a timeout when connecting to backend servers. Default is no timeout.
denyAddresses[]stringList of IPs and networks (CIDR) to deny.
Configures the max. number of connections per second this Router accepts.
Default is 1.
- Minimum: 1
proxyProtocolobjectConfigures the PROXY protocol.
3 fields
receivebooleanWhether the Router should accept the PROXY protocol.
Default is false.
sendbooleanWhether the Router should send the PROXY protocol to backends.
Default is false.
trustedProxies[]stringList of trusted proxy IPs and networks (CIDR).
An empty list accepts all IPs.
podobjectConfigures the spec of the managed Pod objects.
6 fields
affinityobjectAffinity of the router Pod.
3 fields
nodeAffinityobject2 fields
1 field
nodeSelectorTerms[]objectpodAffinityobject2 fields
2 fields
podAffinityTermobject6 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringweightint326 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringpodAntiAffinityobject2 fields
2 fields
podAffinityTermobject6 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringweightint326 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringreplicasint32Number of replicas this Router should run.
serviceobjectConfigures the spec of the managed Service object.
By default, every Router creates Service of type ClusterIP.
If you want to expose your Router externally, you may switch to LoadBalancer.
5 fields
annotationsmap[string]stringAnnotations added to the Router’s Service, e.g. to configure a load balancer.
typestringType of the Router’s Service, e.g. ClusterIP or LoadBalancer.
Default is ClusterIP.
staticRoutes[]objectStatically defined routes that are always available on the Router (not defined by Route objects).
tcpRouteobjectConfigures an optional TCPRoute exposing the Routers Minecraft port.
Note: Using TCPRoute requires at least Gateway API v1.6.0 to be installed on your cluster.
1 field
parentRefs[]objectReferences to gateways the TCPRoute should attach to.
status
addressstringIP address of the Router’s Service. External addresses are preferred: the IP assigned by a load balancer, then the first of externalIPs, then the cluster IP.
conditions[]objectConditions of the Router.
6 fields
lastTransitionTimestring- Format:
date-time
messagestringobservedGenerationint64reasonstringstatusstringtypestringtcpRoutebooleanWhether a managed TCPRoute exists.