CommandGroup
| API version | kobblestone.io/v1alpha1 |
|---|---|
| Kind | CommandGroup |
| Scope | Namespaced |
| kubectl | kubectl get commandgroups |
A CommandGroup manages a set of Command objects that are created/executed in sequential order.
spec
List of commands that should be executed on the target.
- Minimum: 1
2 fields
Raw command string that should be executed against the target via RCON.
ignoreFailurebooleanWhether 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.
passwordSecretRefobjectOptional reference to a custom Secret holding the RCON password.
Automatically implied when targeting a Server object.
targetRefobjectReference to a target where the commands should be executed.
The following targets are supported:
Server: Commands target aServerobject.Service: Commands target a customServiceand port that exposes RCON.
4 fields
apiVersionstringApiVersion of the target object.
kindstringKind of the target object.
Supported values:
ServerService
Default is Server.
Name of the target object.
timeoutMillisecondsint32Timeout 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
trafficPolicystringPolicy 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[]objectContains response information for every command that was executed (or not due to failure).
4 fields
Raw command that was executed.
failureReasonstringReason of failure when command execution failed.
responsestringRaw response of the server after executing the command.
statusstringStatus 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[]objectConditions of the CommandGroup.
6 fields
lastTransitionTimestring- Format:
date-time
messagestringobservedGenerationint64reasonstringstatusstringtypestringmessagestringMessage explaining the current state of the CommandGroup.
phasestringCurrent 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