Reference

Account

API versionkobblestone.io/v1alpha1
KindAccount
ScopeNamespaced
kubectlkubectl get accounts

Account represents a Microsoft account that can be used to authenticate against online Minecraft servers. They can be referenced by Bots to connect to online servers.

Once an Account is created, an authorization flow (OAuth device flow) is initiated. The field status.deviceFlow will contain all necessary information for users to complete the authorization.

Once authorization is completed, the session is stored in the Secret named like the Account (type kobblestone.io/minecraft-session) in a standard, client independent format, so it can be mounted by any workload. The refresh token is kept separately in the internal <account>-credentials Secret.

Accounts automatically refresh their session before it expires for as long as the authorization state is valid.

spec

Configurations related to the authorization flows.

1 field
podobject

Configures the managed Pod resource that is spawned for authorization flows.

6 fields
affinityobject

Affinity of the authorization Pod.

Documentation
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 authorization container.

Default is ghcr.io/kobblestoneio/account-auth (Kobblestone.AccountAuth).

Documentation

Image pull policy of the authorization container.

Documentation
nodeNamestring

Name of the node the authorization Pod is scheduled on.

Documentation
nodeSelectormap[string]string

Node selector of the authorization Pod.

Documentation
tolerations[]object

Tolerations of the authorization Pod.

Documentation
5 fields
effectstring
keystring
operatorstring
valuestring
inactiveboolean

Whether this account is considered inactive and will not attempt any authorization.

Inactive accounts will permanently stay in phase Unauthorized.

Default is false.

Configures the max. leftover TTL of sessions in minutes before they are refreshed.

Default is 60 (1 hour).

  • Minimum: 5

status

Timestamp when this Account was last authorized and a session was created.

  • Format: date-time
conditions[]object

Conditions of the Account.

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

Contains information for completing the device flow authorization.

Only set when status.phase is AwaitingAuthorization.

4 fields
expiresAtstring

Timestamp when the code expires.

  • Format: date-time
messagestring

Message that can be shown to the human from whom action is required.

userCodestringrequired

Code with which the flow may be authorized.

verificationUristringrequired

URI where verification may take place.

  • Format: uri
messagestring

Message explaining the current state of the Account.

phasestring

Current phase of the Account.

Values:

  • Unauthorized: The Account is not authorized and is currently not awaiting authorization.
  • AwaitingAuthorization: The Account awaits manual authorization via the device flow.
  • Authorized: The Account was successfully authorized and is considered ready.
  • One of: Unauthorized, AwaitingAuthorization, Authorized
profileobject

Contains user profile information.

Only set when status.phase is Authorized.

2 fields
namestring

Name of the user.

uuidstring

UUID of the user.

Timestamp when the current session expires.

  • Format: date-time