Kubernetes clusters
Watch your clusters, change their settings, and put game servers on them.
Each cluster reaches the panel through an orchestrator. To install one, read Orchestrators.
Your clusters
Go to Admin > Kubernetes. The Clusters tab lists every cluster a connected orchestrator reports.
The page shows four counts: Total Clusters, Nodes Ready, Pods Running, and a breakdown by cluster type.
Each card shows the name, the type, the version and the status. It also names the orchestrator that manages it, the ready nodes, the running pods, and bars for processor and memory use.
| Status | Meaning |
|---|---|
| Connected | The panel is talking to the cluster. |
| Syncing | The panel is reading the state of the cluster. |
| Disconnected | The orchestrator is not reporting. |
| Error | The orchestrator reported a problem. |
Clusters find themselves
There is no form for adding a cluster. The panel creates the record itself as soon as an orchestrator connects.
To add one, install an orchestrator on the cluster machine.
To clear out clusters whose orchestrator is long gone, click Cleanup Orphaned.
Inside a cluster
Click a cluster to open it.
| Tab | What it shows |
|---|---|
| Overview | The state of the cluster and its resource use. |
| Nodes | The Kubernetes nodes, with their state and their capacity. |
| Pods | The pods, with their state. You can read the log of a pod here. |
| Deployments | The deployments. You can change the number of replicas here. |
| Services | The services of the cluster. |
| Events | Recent Kubernetes events. |
| Migrations | Move a server to another cluster, and set the auto-migration rules. |
| Settings | The settings below. |
To make the panel read the cluster again straight away, open the actions menu on its card and click Sync Now.
Cluster settings
Open the cluster and click Settings.
Basic information
| Field | Description |
|---|---|
| Cluster Name | The name in the panel. |
| Cluster Type | k3s or k8s. This field is read-only. |
| API URL | The address of the Kubernetes API. |
| Description | Optional text for your own reference. |
Certificates
Tick Update certificates to upload a new Client Certificate, a Client Key, and an optional CA Certificate.
Game server settings
| Field | Description | Default |
|---|---|---|
| Connection Address | The address that players use. Leave it empty to use the hostname of the cluster API. | Empty |
| Service Type | NodePort gives every server a port on one shared IP address. LoadBalancer gives every server its own external IP address. | NodePort |
| Memory Overhead Percent | Extra memory for each pod, above the limit of the server. | 25 |
| Host Network Mode | Game servers use the network of the machine they land on. It avoids a class of network fault, and suits k3s. | On |
LoadBalancer needs a load balancer in the cluster. k3s comes with one. Upstream Kubernetes needs MetalLB or one from your cloud provider.
Namespaces
Name the namespaces the orchestrator may use, or leave the list empty to allow any of them.
The orchestrator keeps its own resources in badger-system. The game server pods go in badger-servers.
Putting a server on a cluster
- Go to Admin > Servers and start a new server.
- At Select Deployment Target, click Kubernetes.
- Under Select Orchestrator, click the orchestrator of the cluster that you want.
- Work through the rest of the form.
The list holds connected orchestrators that are linked to a cluster. An empty list means you need to install an orchestrator, or link one you have to a cluster.
There is no allocation to pick, because the cluster hands the server its ports.
Moving a server between clusters
The Migrations tab moves a server to a different cluster.
DANGER
A move between clusters does not copy the server files. The game installs again from scratch. Take a backup first, then restore it after the move.
The auto-migration settings on the same tab apply to the whole panel, not to one cluster.
To move a server between daemon nodes instead, read Server migration, which does copy the files.
Removing a cluster
Delete the orchestrator that manages it.
WARNING
Removing the last orchestrator on a cluster deletes the servers on it. Read the removal section of Orchestrators first.
To clear a record whose orchestrator has gone, click Cleanup Orphaned on the cluster list.
Next steps
- Orchestrators to install and look after the agent
- Server management to create servers