Reference

Router

API versionkobblestone.io/v1alpha1
KindRouter
ScopeNamespaced
kubectlkubectl 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[]string

List 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.

Networking options.

5 fields

List of IPs and networks (CIDR) to allow. Allows everything by default.

Configures a timeout when connecting to backend servers. Default is no timeout.

List of IPs and networks (CIDR) to deny.

Configures the max. number of connections per second this Router accepts.

Default is 1.

  • Minimum: 1

Configures the PROXY protocol.

3 fields
receiveboolean

Whether the Router should accept the PROXY protocol.

Default is false.

sendboolean

Whether the Router should send the PROXY protocol to backends.

Default is false.

List of trusted proxy IPs and networks (CIDR).

An empty list accepts all IPs.

podobject

Configures the spec of the managed Pod objects.

6 fields
affinityobject

Affinity of the router Pod.

Documentation
3 fields
2 fields
2 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchFields[]object
3 fields
keystring
operatorstring
values[]string
weightint32
1 field
2 fields
3 fields
keystring
operatorstring
values[]string
matchFields[]object
3 fields
keystring
operatorstring
values[]string
2 fields
2 fields
6 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
namespaces[]string
weightint32
6 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
namespaces[]string
2 fields
2 fields
6 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
namespaces[]string
weightint32
6 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
namespaces[]string
imagestring

Allows specifying a custom image for the Router pod.

Documentation

Image pull policy of the router container.

Documentation
nodeNamestring

Name of the node the router Pod is scheduled on.

Documentation
nodeSelectormap[string]string

Node selector of the router Pod.

Documentation
tolerations[]object

Tolerations of the router Pod.

Documentation
5 fields
effectstring
keystring
operatorstring
valuestring

Number of replicas this Router should run.

resourcesobject

Resource requirements for the Router pods.

Documentation
3 fields
claims[]object
2 fields
namestring
requeststring
limitsmap[string]string
requestsmap[string]string
serviceobject

Configures 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]string

Annotations added to the Router’s Service, e.g. to configure a load balancer.

Documentation

External traffic policy of the Router’s Service.

Documentation

IP family policy of the Router’s Service.

Documentation
portint32

Port on the Service that exposes Minecraft.

Default is 25565.

  • Minimum: 1
  • Maximum: 65535
typestring

Type of the Router’s Service, e.g. ClusterIP or LoadBalancer.

Default is ClusterIP.

Documentation
staticRoutes[]object

Statically defined routes that are always available on the Router (not defined by Route objects).

2 fields
backendstringrequired

Address (IP+port) of the target backend.

hostnamestringrequired

Hostname.

  • Format: hostname
tcpRouteobject

Configures 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[]object

References to gateways the TCPRoute should attach to.

6 fields
groupstring
kindstring
namestring
namespacestring
portint32

status

addressstring

IP 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[]object

Conditions of the Router.

6 fields
  • Format: date-time
messagestring
reasonstring
statusstring
typestring
tcpRouteboolean

Whether a managed TCPRoute exists.