Installation
Install the Kobblestone operator and its custom resources with Helm.
Requirements
- A Kubernetes cluster, version 1.29 or later, and
kubectlconfigured to talk to it. - Helm 3.8 or later.
- A default StorageClass, or a StorageClass you can name, if your servers should keep their data. Without storage, a server loses its world whenever its pod is recreated.
- Optional: Gateway API v1.6.0 or later with
TCPRoutesupport, if you want to expose servers through your Gateways.
Install with Helm
Add the Kobblestone chart repository and install the chart:
helm repo add kobblestone https://kobblestoneio.github.io/chartshelm repo updatehelm install kobblestone kobblestone/kobblestone \ --namespace kobblestone-system --create-namespaceThe chart is also published as an OCI artifact, so you can install it without adding the repository:
helm install kobblestone oci://ghcr.io/kobblestoneio/charts/kobblestone \ --namespace kobblestone-system --create-namespaceThe chart installs:
- the custom resource definitions in the API group
kobblestone.io, - the operator
Deployment, itsServiceAccountand the cluster-wide RBAC permissions it needs, - a
Servicefor the operator’s HTTP endpoint, which serves the auto sleep webhook.
Check that it is running
kubectl -n kobblestone-system get podskubectl get crds | grep kobblestone.ioOnce the operator pod is ready, it watches all namespaces for Kobblestone resources. Continue with your first server.
Configuration
The defaults work for most clusters. These values are the ones you are most likely to change:
| Value | Default | Description |
|---|---|---|
replicaCount | 1 | Number of operator pods. Only the elected leader works, additional pods are hot standbys. |
image.tag | the chart’s app version | Operator version to run. image.digest takes precedence if set. |
crds.install | true | Install and upgrade the CRDs with the release. |
crds.keep | true | Keep the CRDs, and with them all Kobblestone resources, when the release is uninstalled. |
resources | 50m CPU / 64Mi requested | Resources of the operator pod. |
Node selectors, tolerations, affinity, extra environment variables and volumes can be set as well. Run helm show values kobblestone/kobblestone for the full list, and pass your own values with --values my-values.yaml or --set.
Upgrading
Before upgrading, read the upgrade notes of the new release in the changelog: while Kobblestone is in alpha, releases can contain breaking changes that need manual steps, for example letting running backups finish first. Then upgrade the release:
helm repo updatehelm upgrade kobblestone kobblestone/kobblestone --namespace kobblestone-systemWith crds.install: true, the CRDs are upgraded together with the operator.
Uninstalling
Delete your Kobblestone resources first, so the operator can clean up after them. Some resources use finalizers, for example a Backup with retainPolicy: RequireDelete, and get stuck in deletion when the operator is already gone. Then remove the release:
helm uninstall kobblestone --namespace kobblestone-systemBy default the CRDs stay in the cluster (crds.keep: true), so an accidental uninstall doesn’t take your servers with it. To remove Kobblestone completely, delete the CRDs afterwards:
kubectl get crds -o name | grep kobblestone.io | xargs kubectl deleteNote: Deleting a
Server, or the CRDs, also deletes the servers’ volumes, and with them the worlds. Create aBackupfirst if you want to keep them.
Without Helm
Each release also comes with a plain manifest that contains everything in one file:
kubectl apply -f https://get.kobblestone.io/v0.3.0/kobblestone.yamlIt installs the same components into the namespace kobblestone-system. To upgrade, apply the manifest of the new release; to uninstall, kubectl delete -f the manifest you installed.