Custom Resources
Sub Resources
- AutoPause
- Backup
- MinecraftList
- MinecraftSpec
- ObjectMeta
- Ops
- PersistentVolumeClaim
- PodTemplateSpec
- ServiceTemplate
- Whitelist
AutoPause
AutoPause defines the auto-pause configuration for the Minecraft server.
| Field | Description | Scheme | Required |
|---|---|---|---|
| enabled | Enabled enables the auto-pause function. | *bool | false |
| timeoutSeconds | TimeoutSeconds is the time in seconds to wait before pausing the server. Default is 300 seconds. | int | false |
Backup
Backup defines the backup configuration for the Minecraft server.
| Field | Description | Scheme | Required |
|---|---|---|---|
| excludes | Excludes is a list of file patterns to exclude from the backup. | []string | false |
Minecraft
Minecraft is the Schema for the minecrafts API.
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | metav1.ObjectMeta | false | |
| spec | MinecraftSpec | false | |
| status | MinecraftStatus | false |
MinecraftList
MinecraftList contains a list of Minecraft.
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | metav1.ListMeta | false | |
| items | []Minecraft | true |
MinecraftSpec
MinecraftSpec defines the desired state of Minecraft.
| Field | Description | Scheme | Required |
|---|---|---|---|
| podTemplate | PodTemplate is a Pod template for Minecraft server container. | PodTemplateSpec | true |
| volumeClaimTemplates | PersistentVolumeClaimSpec is a specification of PersistentVolumeClaim for persisting data in minecraft. A claim named "minecraft-data" must be included in the list. | []PersistentVolumeClaim | true |
| serviceTemplate | ServiceTemplate is a Service template. | *ServiceTemplate | false |
| ops | operators on server. exec /op or /deop | Ops | false |
| whitelist | whitelist | Whitelist | false |
| serverPropertiesConfigMapName | ServerPropertiesConfigMapName is a ConfigMap name of server.properties. | *string | false |
| otherConfigMapName | OtherConfigMapName is a ConfigMap name of other configurations file(eg. banned-ips.json, ops.json etc) | *string | false |
| rconPasswordSecretName | RconPasswordSecretName is a Secret name for RCON password. | *string | false |
| autoPause | AutoPause configuration | AutoPause | false |
| backup | Backup configuration | Backup | false |
| externalHostname | ExternalHostname is the custom hostname for mc-router routing. If not set, FQDN will be generated as | *string | false |
ObjectMeta
ObjectMeta is metadata of objects. This is partially copied from metav1.ObjectMeta.
| Field | Description | Scheme | Required |
|---|---|---|---|
| name | Name is the name of the object. | string | false |
| labels | Labels is a map of string keys and values. | map[string]string | false |
| annotations | Annotations is a map of string keys and values. | map[string]string | false |
Ops
Ops represents the ops.json file.
| Field | Description | Scheme | Required |
|---|---|---|---|
| users | user name exec /op or /deop | []string | false |
PersistentVolumeClaim
PersistentVolumeClaim is a user’s request for and claim to a persistent volume. This is slightly modified from corev1.PersistentVolumeClaim.
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | Standard object’s metadata. | ObjectMeta | true |
| spec | Spec defines the desired characteristics of a volume requested by a pod author. | corev1.PersistentVolumeClaimSpec | true |
PodTemplateSpec
PodTemplateSpec describes the data a pod should have when created from a template. This is slightly modified from corev1.PodTemplateSpec.
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | Standard object’s metadata. The name in this metadata is ignored. | ObjectMeta | false |
| spec | Specification of the desired behavior of the pod. The name of the Minecraft server container in this spec must be minecraft. | corev1.PodSpec | true |
ServiceTemplate
ServiceTemplate define the desired spec and annotations of Service.
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | Standard object’s metadata. Only annotations and labels are valid. | ObjectMeta | false |
| spec | Spec is the ServiceSpec | *corev1.ServiceSpec | false |
Whitelist
Whitelist represents the whitelist.json file.
| Field | Description | Scheme | Required |
|---|---|---|---|
| enabled | exec /whitelist on | bool | true |
| users | user name exec /whitelist add or /whitelist remove | []string | false |