Custom Resources

Sub Resources

Minecraft

Minecraft is the Schema for the minecrafts API

FieldDescriptionSchemeRequired
metadatametav1.ObjectMetafalse
specMinecraftSpecfalse
statusMinecraftStatusfalse

Back to Custom Resources

MinecraftList

MinecraftList contains a list of Minecraft

FieldDescriptionSchemeRequired
metadatametav1.ListMetafalse
items[]Minecrafttrue

Back to Custom Resources

MinecraftSpec

MinecraftSpec defines the desired state of Minecraft

FieldDescriptionSchemeRequired
podTemplatePodTemplate is a Pod template for Minecraft server container.PodTemplateSpectrue
volumeClaimTemplatesPersistentVolumeClaimSpec is a specification of PersistentVolumeClaim for persisting data in minecraft. A claim named "minecraft-data" must be included in the list.[]PersistentVolumeClaimtrue
serviceTemplateServiceTemplate is a Service template.*ServiceTemplatefalse
opsoperators on server. exec /op or /deopOpsfalse
whitelistwhitelistWhitelistfalse
serverPropertiesConfigMapNameServerPropertiesConfigMapName is a ConfigMap name of server.properties.*stringfalse
otherConfigMapNameOtherConfigMapName is a ConfigMap name of other configurations file(eg. banned-ips.json, ops.json etc)*stringfalse

Back to Custom Resources

ObjectMeta

ObjectMeta is metadata of objects. This is partially copied from metav1.ObjectMeta.

FieldDescriptionSchemeRequired
nameName is the name of the object.stringfalse
labelsLabels is a map of string keys and values.map[string]stringfalse
annotationsAnnotations is a map of string keys and values.map[string]stringfalse

Back to Custom Resources

Ops

FieldDescriptionSchemeRequired
usersuser name exec /op or /deop[]stringfalse

Back to Custom Resources

PersistentVolumeClaim

PersistentVolumeClaim is a user's request for and claim to a persistent volume. This is slightly modified from corev1.PersistentVolumeClaim.

FieldDescriptionSchemeRequired
metadataStandard object's metadata.ObjectMetatrue
specSpec defines the desired characteristics of a volume requested by a pod author.corev1.PersistentVolumeClaimSpectrue

Back to Custom Resources

PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template. This is slightly modified from corev1.PodTemplateSpec.

FieldDescriptionSchemeRequired
metadataStandard object's metadata. The name in this metadata is ignored.ObjectMetafalse
specSpecification of the desired behavior of the pod. The name of the MySQL server container in this spec must be minecraft.corev1.PodSpectrue

Back to Custom Resources

ServiceTemplate

ServiceTemplate define the desired spec and annotations of Service

FieldDescriptionSchemeRequired
metadataStandard object's metadata. Only annotations and labels are valid.ObjectMetafalse
specSpec is the ServiceSpec*corev1.ServiceSpecfalse

Back to Custom Resources

Whitelist

FieldDescriptionSchemeRequired
enabledexec /whitelist onbooltrue
usersuser name exec /whitelist add or /whitelist remove[]stringfalse

Back to Custom Resources