Reference

Server

API versionkobblestone.io/v1alpha1
KindServer
ScopeNamespaced
kubectlkubectl get servers

A Server runs a single Minecraft server.

The server is based on the itzg/minecraft-server image and runs as a StatefulSet with one replica. The operator also manages its Service, RCON Secret and NetworkPolicy and, if configured, its PersistentVolumeClaim, Route and TCPRoute.

Servers can be backed up with Backups and restored with Restores if they have storage configured.

spec

accessobject

Configures the whitelist and the operators of the server.

2 fields
opsobject

Configures the operators of the server.

1 field
users[]string

Players with operator permissions, as usernames or UUIDs.

Note: The operators are synchronized: players not listed here lose their operator permissions.

whitelistobject

Configures the whitelist. Only whitelisted players can join.

2 fields
enforceboolean

If set to true, online players who are not whitelisted are kicked when the whitelist changes.

Default is false.

users[]string

Players allowed to join, as usernames or UUIDs.

Note: The whitelist is synchronized: players not listed here are removed from it.

Commands executed via RCON on certain events. Each entry is a single command.

5 fields
onConnect[]string

Commands executed when a player connects.

onDisconnect[]string

Commands executed when a player disconnects.

Commands executed when the first player connects to the empty server.

Commands executed when the last player disconnects.

onStartup[]string

Commands executed once the server has started.

autoSleepobject

Configures putting the server to sleep while no players are online.

2 fields
modestring

How the server sleeps while no players are online.

Default is Pause.

Values:

  • None: The server never sleeps.
  • Pause: The server pauses ticking while it is empty (requires Minecraft 1.21.2 or later).
  • Hibernate: The server is stopped while it is empty and started again when a player connects through a Router.
  • LegacyPause: The server process is paused while it is empty, using the autopause feature of the image. For older versions.
  • One of: None, Pause, Hibernate, LegacyPause

Time in seconds without players after which the server goes to sleep.

Default is 60.

  • Minimum: 1
contentobject

Configures plugins, mods, modpacks and other content installed on startup.

9 fields

Configures content from CurseForge.

3 fields

Reference to a key of a Secret containing a CurseForge API key. Required to download from CurseForge.

2 fields
keystringrequired

Name of the key.

namestringrequired

Name of the Secret.

files[]string

CurseForge projects or files to install, by slug, ID or URL.

URL of the CurseForge page of a modpack to install. Requires the server type AutoCurseforge.

iconUrlstring

URL of an image used as the server icon.

URL of a modpack ZIP file to install.

modrinthobject

Configures content from Modrinth.

1 field
projects[]string

Modrinth projects to install, by slug or ID.

mods[]object

Mods to install, for modded server types (e.g. Fabric).

1 field
urlstringrequired

URL of the mod .jar file.

URL of a packwiz pack.toml to install.

plugins[]object

Plugins to install, for server types that support plugins (e.g. Paper).

1 field
urlstringrequired

URL of the plugin .jar file.

Configures a resource pack that players are prompted to download.

3 fields
enforceboolean

If set to true, players who decline the resource pack are disconnected.

Default is false.

sha1string

SHA-1 checksum of the resource pack. Lets clients cache the pack.

urlstringrequired

URL of the resource pack ZIP file.

IDs of Spigot resources to install.

eulabooleanrequired

Whether you accept the Minecraft EULA. The server does not start unless this is true.

Configures the server to accept players forwarded by a Velocity proxy (modern forwarding). The server then runs in offline mode and trusts the player information sent by the proxy.

Supported server types: Paper, Pufferfish, Purpur, Folia (built in), Fabric and Quilt (installs FabricProxy-Lite and Fabric API from Modrinth). For other types, it is ignored and the server keeps verifying players itself.

Warning: For Paper-based servers, config/paper-global.yml is managed by Kobblestone and replaced on every start. Changes to it on the server’s volume are lost.

Note: Set and managed by the Network for its managed servers.

1 field
secretRefobjectrequired

Reference to a key of a Secret containing the forwarding secret of the proxy.

2 fields
keystringrequired

Name of the key.

namestringrequired

Name of the Secret.

jvmobject

Configures the JVM of the server.

2 fields
memoryobject

Configures memory settings for the JVM.

1 field

Configures the percentage of memory reserved for the heap.

Default is 75.

Note: For low-memory servers, you might have to lower this.

  • Minimum: 1
  • Maximum: 99
versionstring

Configures a specific version of the JVM to be used.

Default is java25.

Note: This corresponds to the Java part of the server image tag. See Image tags.

lifecycleobject

Configures settings related to the lifecycle of the Server.

1 field

Specifies when changes to spec are rolled out to running servers.

Default is Immediate.

Values:

  • Immediate: Changes to spec are rolled out immediately. For example, if you update spec.version, the server will be restarted.
  • Manual: Changes to spec are rolled out when the server Pod is recreated, e.g. when the server is stopped and started again or the Pod is deleted. Note: This does not apply to restarts of the server container after a crash.
  • One of: Immediate, Manual

Configures the NetworkPolicy of the server.

By default, it only allows Minecraft traffic from Routers, Networks and Bots, RCON traffic from Backups, and all traffic to the Service if it is of type LoadBalancer.

2 fields
disabledboolean

If set to true, the server’s default NetworkPolicy will not be created.

Default is false.

Additional Ingress rules applied to the policy.

2 fields
from[]object
3 fields
ipBlockobject
2 fields
cidrstring
except[]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
ports[]object
3 fields
endPortint32
portint | string
protocolstring
offlineboolean

If set to true, the server runs in offline mode: player accounts are not verified.

Default is false.

Warning: Only use this for servers behind a proxy that verifies players (e.g. a Network), never for servers that players can reach directly.

podobject

Configures the server Pod.

9 fields
affinityobject

Affinity of the server Pod.

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

Additional environment variables of the server container.

Can be used to set any option of the image that is not covered by the Server spec.

3 fields
namestring
valuestring
valueFromobject
5 fields
3 fields
keystring
namestring
optionalboolean
fieldRefobject
2 fields
fieldPathstring
4 fields
keystring
optionalboolean
pathstring
3 fields
divisorstring
resourcestring
3 fields
keystring
namestring
optionalboolean
imagestring

Custom image for the server container.

Default is itzg/minecraft-server with the Java version of spec.jvm.version.

Image pull policy of the server container.

nodeNamestring

Name of the node the server Pod is scheduled on.

nodeSelectormap[string]string

Node selector of the server Pod.

tolerations[]object

Tolerations of the server Pod.

5 fields
effectstring
keystring
operatorstring
valuestring
volumeMounts[]object

Additional volume mounts of the server container.

8 fields
mountPathstring
namestring
readOnlyboolean
subPathstring
volumes[]object

Additional volumes of the server Pod.

31 fields
4 fields
fsTypestring
readOnlyboolean
volumeIDstring
azureDiskobject
6 fields
diskNamestring
diskURIstring
fsTypestring
kindstring
readOnlyboolean
azureFileobject
3 fields
readOnlyboolean
shareNamestring
cephfsobject
6 fields
monitors[]string
pathstring
readOnlyboolean
secretRefobject
1 field
namestring
userstring
cinderobject
4 fields
fsTypestring
readOnlyboolean
secretRefobject
1 field
namestring
volumeIDstring
configMapobject
5 fields
items[]object
4 fields
keystring
modeint32
pathstring
userint64
namestring
optionalboolean
csiobject
5 fields
driverstring
fsTypestring
1 field
namestring
readOnlyboolean
volumeAttributesmap[string]string
3 fields
items[]object
5 fields
fieldRefobject
2 fields
fieldPathstring
modeint32
pathstring
3 fields
divisorstring
resourcestring
userint64
emptyDirobject
3 fields
mediumstring
modeint32
sizeLimitstring
ephemeralobject
1 field
2 fields
metadataobject
specobject
9 fields
accessModes[]string
3 fields
apiGroupstring
kindstring
namestring
4 fields
apiGroupstring
kindstring
namestring
namespacestring
resourcesobject
2 fields
limitsmap[string]string
requestsmap[string]string
selectorobject
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
fcobject
5 fields
fsTypestring
lunint32
readOnlyboolean
targetWWNs[]string
wwids[]string
5 fields
driverstring
fsTypestring
optionsmap[string]string
readOnlyboolean
secretRefobject
1 field
namestring
flockerobject
2 fields
4 fields
fsTypestring
pdNamestring
readOnlyboolean
gitRepoobject
3 fields
directorystring
revisionstring
glusterfsobject
3 fields
endpointsstring
pathstring
readOnlyboolean
hostPathobject
2 fields
pathstring
typestring
imageobject
2 fields
referencestring
iscsiobject
11 fields
fsTypestring
iqnstring
lunint32
portals[]string
readOnlyboolean
secretRefobject
1 field
namestring
namestring
nfsobject
3 fields
pathstring
readOnlyboolean
serverstring
2 fields
claimNamestring
readOnlyboolean
2 fields
fsTypestring
pdIDstring
3 fields
fsTypestring
readOnlyboolean
volumeIDstring
projectedobject
3 fields
sources[]object
6 fields
6 fields
2 fields
3 fields
keystring
operatorstring
values[]string
matchLabelsmap[string]string
namestring
optionalboolean
pathstring
userint64
configMapobject
3 fields
items[]object
4 fields
keystring
modeint32
pathstring
userint64
namestring
optionalboolean
1 field
items[]object
5 fields
fieldRefobject
2 fields
fieldPathstring
modeint32
pathstring
3 fields
divisorstring
resourcestring
userint64
secretobject
3 fields
items[]object
4 fields
keystring
modeint32
pathstring
userint64
namestring
optionalboolean
4 fields
audiencestring
pathstring
userint64
quobyteobject
6 fields
groupstring
readOnlyboolean
registrystring
tenantstring
userstring
volumestring
rbdobject
8 fields
fsTypestring
imagestring
keyringstring
monitors[]string
poolstring
readOnlyboolean
secretRefobject
1 field
namestring
userstring
scaleIOobject
10 fields
fsTypestring
gatewaystring
readOnlyboolean
secretRefobject
1 field
namestring
sslEnabledboolean
systemstring
secretobject
5 fields
items[]object
4 fields
keystring
modeint32
pathstring
userint64
optionalboolean
storageosobject
5 fields
fsTypestring
readOnlyboolean
secretRefobject
1 field
namestring
propertiesmap[string]string

Additional entries for server.properties.

See server.properties for available properties.

rconobject

Configures RCON, the remote console of the server.

RCON is required for Commands, CommandGroups, autoCommands and online Backups.

3 fields
disabledboolean

If set to true, RCON is disabled.

Default is false.

Note: Commands, CommandGroups, autoCommands and online Backups require RCON.

Reference to a key of a Secret containing the RCON password.

If not set, a random password is generated.

Note: Only read when the server’s own Secret is created.

2 fields
keystringrequired

Name of the key.

namestringrequired

Name of the Secret.

portint32

Port of RCON on the server’s Service. Inside the Pod, RCON always listens on 25575.

Default is 25575.

resourcesobject

Compute resources of the server container.

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

Configures a Route that makes the server reachable through a Router under a hostname.

Removing it deletes the Route.

2 fields
hostnamestringrequired

Hostname under which the server is reachable through the Router.

parentRefobjectrequired

Reference to the Router the Route is attached to.

1 field
namestring
serviceobject

Configures the Service of the server.

5 fields
annotationsmap[string]string

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

External traffic policy of the server’s Service.

IP family policy of the server’s Service.

portint32

Port on the Service that exposes Minecraft.

Default is 25565.

typestring

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

Default is ClusterIP.

Warning: With LoadBalancer, the RCON port is reachable from anywhere as well, unless RCON is disabled.

statestring

Desired state of the Server.

Default is Running.

Values:

  • Running: The server is started.
  • Stopped: The server is stopped. Its data is kept.

Note: The server is kept stopped while a Restore or an offline Backup of it is running.

  • One of: Stopped, Running
storageobject

Configures a persistent volume for the server’s data (worlds, configuration, …).

Without storage, all data is lost when the server Pod is recreated, and Backups and Restores are not supported.

Warning: Removing storage deletes the server’s PersistentVolumeClaim and thus its data.

2 fields
sizestringrequired

Size of the PersistentVolumeClaim, e.g. 10Gi.

Note: Increasing the size requires a storage class that supports volume expansion.

Storage class of the PersistentVolumeClaim.

Default is the default storage class of the cluster.

Note: Only applied when the claim is created.

tcpRouteobject

Configures an optional TCPRoute exposing the Servers 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
timeoutsobject

Configures the health checks of the server.

2 fields

Maximum time in seconds the server may take to start before it is restarted.

Default is 360. Must be a multiple of 5.

Maximum time in seconds a started server may be unresponsive before it is restarted.

Default is 15. Must be a multiple of 5.

typestring

Type of the server software, e.g. a mod loader or plugin platform.

Default is Vanilla.

See Server types for details on each type.

  • One of: Vanilla, Bukkit, Spigot, Fabric, Forge, Magma, Ketting, Mohist, Catserver, Spongevanilla, Limbo, Crucible, Paper, Pufferfish, Purpur, Folia, Quilt, AutoCurseforge
versionstringrequired

Minecraft version of the server.

Use LATEST for the latest release or SNAPSHOT for the latest snapshot.

status

addressstring

IP address of the Server’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 Server.

Types: Running, Stopped, Progressing, Hibernating, RconAvailable, BackupInProgress, RestoreInProgress, Error.

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

Current phase of the Server.

Values:

  • Stopped: The server is stopped.
  • Starting: The server is starting.
  • Running: The server is running and ready for players.
  • Stopping: The server is stopping.
  • Hibernating: The server was stopped by auto-sleep and is started again when a player connects.
  • One of: Stopped, Running, Starting, Stopping, Hibernating
tcpRouteboolean

Whether a managed TCPRoute exists.

typestring

Type of the server software, see spec.type.

  • One of: Vanilla, Bukkit, Spigot, Fabric, Forge, Magma, Ketting, Mohist, Catserver, Spongevanilla, Limbo, Crucible, Paper, Pufferfish, Purpur, Folia, Quilt, AutoCurseforge