Reference

CommandGroup

API versionkobblestone.io/v1alpha1
KindCommandGroup
ScopeNamespaced
kubectlkubectl get commandgroups

A CommandGroup manages a set of Command objects that are created/executed in sequential order.

spec

commands[]objectrequired

List of commands that should be executed on the target.

  • Minimum: 1
2 fields
commandstringrequired

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

Whether to ignore failures when executing the command.

If enabled, the CommandGroup will keep executing subsequent commands in case of failure. Additionally, it will not have any negative impact o

Default is false.

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 commands should be executed.

The following targets are supported:

  • Server: Commands target a Server object.
  • Service: Commands 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 commands 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

commands[]object

Contains response information for every command that was executed (or not due to failure).

4 fields
commandstringrequired

Raw command that was executed.

Reason of failure when command execution failed.

responsestring

Raw response of the server after executing the command.

statusstring

Status of the individual command response.

Values:

  • Completed: The command was executed successfully.
  • Failed: The command failed.
  • Skipped: Command execution was skipped due to previous failure.
  • One of: Completed, Failed, Skipped
conditions[]object

Conditions of the CommandGroup.

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

Message explaining the current state of the CommandGroup.

phasestring

Current phase of the CommandGroup.

Values:

  • Pending: Commands are pending or being executed.
  • Completed: All commands executed successfully or failures have been explicitly ignored.
  • Failed: A command has failed executing.
  • One of: Pending, Completed, Failed