Getting Started on Agones

Quickstart: Create a Game Server

Wed, 02 Jan 2019 06:35:31 +0000

Prerequisites

The following prerequisites are required to create a GameServer:

A Kubernetes cluster with the UDP port range 7000-8000 open on each node. Creating the firewall.
Agones controller installed in the targeted cluster
kubectl properly configured
Netcat which is already installed on most Linux/macOS distributions, for windows you can use WSL.

If you don’t have a Kubernetes cluster you can follow these instructions to create a cluster on Google Kubernetes Engine (GKE), Minikube or Azure Kubernetes Service (AKS), and install Agones.

Quickstart: Create a Game Server Fleet

Wed, 02 Jan 2019 06:42:20 +0000

Prerequisites

The following prerequisites are required to create a GameServer:

A Kubernetes cluster with the UDP port range 7000-8000 open on each node. Creating the firewall.
Agones controller installed in the targeted cluster
kubectl properly configured
Netcat which is already installed on most Linux/macOS distributions, for windows you can use WSL.

If you don’t have a Kubernetes cluster you can follow these instructions to create a cluster on Google Kubernetes Engine (GKE), Minikube or Azure Kubernetes Service (AKS), and install Agones.

Quickstart: Create a Fleet Autoscaler

Wed, 02 Jan 2019 06:42:33 +0000

Prerequisites

It is assumed that you have followed the instructions to Create a Game Server Fleet and you have a running fleet of game servers.

Objectives

Create a Fleet Autoscaler in Kubernetes using Agones custom resource.
Watch the Fleet scale up when allocating GameServers
Watch the Fleet scale down when shutting down allocated GameServers
Edit the autoscaler specification to apply live changes

1. Create a Fleet Autoscaler

Let’s create a Fleet Autoscaler using the following command :

Quickstart: Create a Fleet Autoscaler with Webhook Policy

Wed, 02 Jan 2019 06:42:44 +0000

In some cases, your game servers may need to use custom logic for scaling your fleet that is more complex than what can be expressed using the Buffer policy in the fleetautoscaler. This guide shows how you can extend Agones with an autoscaler webhook to implement a custom autoscaling policy.

When you use an autoscaler webhook the logic computing the number of target replicas is delegated to an external HTTP/S endpoint, such as one provided by a Kubernetes deployment and service in the same cluster (as shown in the examples below). The fleetautoscaler will send a request to the webhook autoscaler’s /scale endpoint every sync period (currently 30s) with a JSON body, and scale the target fleet based on the data that is returned.

Quickstart: Create a Fleet Autoscaler with Wasm

Tue, 09 Dec 2025 00:00:00 +0000

Warning

The Wasm Autoscaler feature is currently Alpha, not enabled by default, and may change in the future.

Use the FeatureGate WasmAutoscaler to enable and test this feature.

See the Feature Gate documentation for details on how to enable features.

In some cases, your game servers may need to use custom logic for scaling your fleet that is more complex than what can be expressed using the Buffer policy in the fleetautoscaler. This guide shows how you can extend Agones with a WebAssembly (Wasm) autoscaler to implement a custom autoscaling policy.

Quickstart: Edit a Game Server

Wed, 02 Jan 2019 06:42:56 +0000

This guide addresses Google Kubernetes Engine and Minikube. We would welcome a Pull Request to expand this to include other platforms as well.

Prerequisites

A Go environment
Docker
Agones installed on GKE or Minikube
kubectl properly configured

To install on GKE, follow the install instructions (if you haven’t already) at Setting up a Google Kubernetes Engine (GKE) cluster. Also complete the “Enabling creation of RBAC resources” and “Installing Agones” sets of instructions on the same page.