Reference

Command

API versionkobblestone.io/v1alpha1
KindCommand
ScopeNamespaced
kubectlkubectl get commands

A Command object executes an arbitrary command on a Minecraft server via RCON.

Commands are executed directly by the operator with zero overhead. Therefore, no additional resources such as Job/Pod will be allocated.

Target servers must have RCON enabled for commands to work (spec.rcon.disabled=null|false).

The response of commands can be observed via status.response.

spec

commandstringrequired

Raw command string that should be executed against the target via RCON.

Optional reference to a custom Secret holding the RCON password.

Automatically implied when targeting a Server object.

2 fields
keystringrequired

Name of the key.

namestringrequired

Name of the Secret.

targetRefobject

Reference to a target where the command should be executed.

The following targets are supported:

  • Server: Command targets a Server object.
  • Service: Command target a custom Service and port that exposes RCON.
4 fields

ApiVersion of the target object.

kindstring

Kind of the target object.

Supported values:

  • Server
  • Service

Default is Server.

namestringrequired

Name of the target object.

portint32

Target port that exposes RCON.

Default is 25575.

  • Minimum: 1
  • Maximum: 65535

Timeout for the command in milliseconds. Default is no timeout.

The timeout is applied individually for opening the connection and executing the command.

When a command times out, status.phase will be Failed and status.failureReason will be Timeout.

  • Minimum: 1

Policy that determines how RCON traffic flows to the target.

Default is Cluster.

Cluster means that traffic will always be routed inside the cluster to known ClusterIPs.

External means that traffic may be routed to external IPs, such as LoadBalancer IPs. This may be useful when direct connectivity from the operator to the target is not given. WARNING: RCON connections are unencrypted and should never be routed through the internet. Ensure your LoadBalancer is not exposed to the internet.

  • One of: Cluster, External

status

conditions[]object

Conditions of the Command.

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

Timestamp when the command was executed or execution was attempted.

  • Format: date-time

Reason of failure when command execution failed.

messagestring

Message explaining the current state of the Command.

phasestring

Current phase of the command.

Values:

  • Pending: Command execution is pending.
  • Completed: Command executed successfully.
  • Failed: Command execution failed.
  • One of: Pending, Completed, Failed
responsestring

Raw response of the server after executing the command.