Reference

Network

API versionkobblestone.io/v1alpha1
KindNetwork
ScopeNamespaced
kubectlkubectl get networks

A Network runs a Velocity proxy and the Servers behind it.

Managed servers (the default) are Server resources created and kept compatible by the Network: they are rendered from serverTemplate and their entry in servers, and always trust the proxy (modern forwarding with the network’s secret, offline mode, reachable only through the proxy). An existing Server joins the network, keeping its data, by naming it in servers[].serverName.

Unmanaged entries (unmanaged: true) only add an existing Server or Network to the proxy’s configuration, without configuring it.

The proxy runs as a Deployment. The operator also manages its Service, configuration and forwarding Secret and, if configured, its Route and TCPRoute.

spec

proxyobject

Configures the Velocity proxy.

9 fields
configstring

Custom velocity.toml.

The operator always sets servers, forced-hosts, player-info-forwarding-mode (modern) and forwarding-secret-file (and online-mode if offline is true), overriding the values given here.

contentobject

Configures plugins and the server icon of the proxy.

2 fields
iconUrlstring

URL of an image used as the server icon of the proxy.

plugins[]object

Plugins to install on the proxy.

1 field
urlstringrequired

URL of the plugin .jar file.

Reference to a key of a Secret containing the forwarding secret shared with the backend servers.

If not set, a random secret is generated. Managed servers are configured with it automatically; unmanaged servers have to be configured with it manually.

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

2 fields
keystringrequired

Name of the key.

namestringrequired

Name of the Secret.

jvmobject

Configures the JVM of the proxy.

1 field
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 deployments, you might have to lower this.

  • Minimum: 1
  • Maximum: 99
offlineboolean

If set to true, the proxy runs in offline mode (online-mode = false): player accounts are not verified.

Default is false.

podobject

Configures the proxy Pods.

6 fields
affinityobject

Affinity of the proxy 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
imagestring

Custom image for the proxy container.

Default is itzg/mc-proxy.

Image pull policy of the proxy container.

nodeNamestring

Name of the node the proxy Pod is scheduled on.

nodeSelectormap[string]string

Node selector of the proxy Pod.

tolerations[]object

Tolerations of the proxy Pod.

5 fields
effectstring
keystring
operatorstring
valuestring

Number of proxy replicas.

Default is 1.

resourcesobject

Compute resources of the proxy container.

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

Velocity version.

Default is LATEST.

routeobject

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

Removing it deletes the Route.

2 fields
hostnamestringrequired

Hostname under which the network is reachable through the Router.

parentRefobjectrequired

Reference to the Router the Route is attached to.

1 field
namestring

What happens to a managed Server when it is removed from servers or the Network is deleted.

Default is Retain.

Values:

  • Retain: The Server and its data are kept. It leaves the network and runs as a standalone server again (forwarding is removed, so it verifies players itself).
  • Delete: The Server is deleted, including its data.
  • One of: Retain, Delete

The software, version and EULA shared by all managed servers, and defaults for their other settings. Each managed server’s spec is merged onto it.

Required if the network has managed servers.

17 fields
accessobject

Whitelist and operators, see Server spec.access.

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, see Server spec.autoCommands.

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

Sleeping while no players are online, see Server spec.autoSleep.

Note: Hibernate is not supported behind a proxy, because nothing wakes the server up again.

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

Plugins, mods, modpacks and other content, see Server spec.content.

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 for all servers of the network. The servers do not start unless this is true.

jvmobject

JVM settings, see Server spec.jvm.

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

Lifecycle settings, see Server spec.lifecycle.

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

The server’s NetworkPolicy, see Server spec.networkPolicy.

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
podobject

Configures the server Pod, see Server spec.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 spec.properties.

rconobject

Remote console of the server, see Server spec.rcon.

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
statestring

Desired state of the server, see Server spec.state.

Default is Running.

  • One of: Stopped, Running
storageobject

Persistent volume for the server’s data, see Server spec.storage.

Warning: Without storage, the server’s world is lost whenever its Pod is recreated.

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.

timeoutsobject

Health checks, see Server spec.timeouts.

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.

typestringrequired

Type of the server software of all servers, see Server spec.type.

Only types that can trust a Velocity proxy are supported: Paper, Pufferfish, Purpur, Folia, Fabric, Quilt.

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

Minecraft version of all servers, see Server spec.version.

servers[]object

Servers of the network.

The order matters: players join the first available server with try enabled, in the order of this list, unless a forced host applies. If several servers share a hostname, they are tried in this order as well.

Note: The proxy only reads its configuration on startup, so it is restarted whenever this list changes in a way that affects it: servers added, removed, renamed or reordered, or a changed hostname or try. Players connected to the proxy are disconnected. Servers that are created, deleted or restarted do not restart the proxy.

7 fields
hostnamestring

Hostname that sends players directly to this server (forced host).

If several servers have the same hostname, players join the first available one, in the order of servers.

namestringrequired

Name of the server in the proxy, e.g. for /server <name>.

For managed servers, the Server resource is named <network>-<name> unless serverName is set.

  • Maximum length: 63
  • Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Name of the managed Server resource in the network’s namespace.

Default is <network>-<name>. If a Server with this name already exists and does not belong to another network, it joins the network and keeps its data.

Only for managed servers.

  • Maximum length: 63
  • Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
specobject

Settings of this managed server, merged onto serverTemplate: objects are merged field by field, all other values (including lists) replace the template’s value.

type, version and eula are shared by all servers and only set in serverTemplate.

Only for managed servers.

14 fields
accessobject

Whitelist and operators, see Server spec.access.

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, see Server spec.autoCommands.

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

Sleeping while no players are online, see Server spec.autoSleep.

Note: Hibernate is not supported behind a proxy, because nothing wakes the server up again.

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

Plugins, mods, modpacks and other content, see Server spec.content.

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.

jvmobject

JVM settings, see Server spec.jvm.

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

Lifecycle settings, see Server spec.lifecycle.

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

The server’s NetworkPolicy, see Server spec.networkPolicy.

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
podobject

Configures the server Pod, see Server spec.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 spec.properties.

rconobject

Remote console of the server, see Server spec.rcon.

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
statestring

Desired state of the server, see Server spec.state.

Default is Running.

  • One of: Stopped, Running
storageobject

Persistent volume for the server’s data, see Server spec.storage.

Warning: Without storage, the server’s world is lost whenever its Pod is recreated.

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.

timeoutsobject

Health checks, see Server spec.timeouts.

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.

targetRefobject

Reference to the Server or Network to forward players to.

Supported kinds: Server (default), Network.

Only for unmanaged servers.

4 fields
apiGroupstring
kindstring
namestring
namespacestring
tryboolean

Whether players are sent to this server when they join the network (Velocity’s try list, in the order of servers). Servers with try disabled are only reachable via /server or their hostname.

Default is true.

unmanagedboolean

If set to true, the server is not managed by the network: the proxy only forwards players to targetRef, and the target has to be configured to trust the proxy manually.

targetRef is required, serverName and spec must not be set.

Default is false.

serviceobject

Configures the Service of the proxy.

5 fields
annotationsmap[string]string

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

External traffic policy of the proxy’s Service.

IP family policy of the proxy’s Service.

portint32

Port on the Service that exposes Minecraft.

Default is 25565.

typestring

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

Default is ClusterIP.

tcpRouteobject

Configures an optional TCPRoute exposing the Networks 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 proxy’s Service. External addresses are preferred: the IP assigned by a load balancer, then the first of externalIPs, then the cluster IP.

messagestring

Message explaining the current state of the Network, e.g. why a server cannot be managed.

Ready proxy replicas out of the desired ones, e.g. 1/1.

Number of proxy replicas that are ready to accept players.

Desired number of proxy replicas (spec.proxy.replicas).

Number of running servers of the network.

Number of servers of the network.

servers[]object

State of each server of the network.

5 fields
managedboolean

Whether the server is managed by the network.

messagestring

Why the server cannot be managed, if so.

namestring

Name of the server in the proxy.

phasestring

Phase of the Server (status.phase), or Missing if it does not exist.

serverstring

Name of the Server resource, or of the target of an unmanaged entry.

Running servers out of all servers of the network, e.g. 2/3.

tcpRouteboolean

Whether a managed TCPRoute exists.