README
¶
Agones
Agones is a library for hosting, running and scaling dedicated game servers on Kubernetes.
Agones, is derived from the Greek word agōn which roughly translates to “contest”, “competition at games” and “gathering”. (source)
Disclaimer
This software is currently alpha, and subject to change. Not to be used in production systems.
Major Features
- Be able to define a
GameServerwithin Kubernetes - either through yaml or via the API - Manage GameServer lifecycles - including health checking and connection information.
- Client SDKs for integration with dedicated game servers to work with Agones.
Why does this project exist?
For more details on why this project was written, read the announcement blog post.
Requirements
- Kubernetes cluster version 1.9+
- Minikube, Google Kubernetes Engine and Azure Kubernetes Service have been tested
- If you are creating and managing your own Kubernetes cluster, the MutatingAdmissionWebhook, and ValidatingAdmissionWebhook admission controllers are required. We also recommend following the recommended set of admission controllers.
- Firewall access for the range of ports that Game Servers can be connected to in the cluster.
- Game Servers must have the project SDK integrated, to manage Game Server state, health checking, etc.
Installation
Follow these instructions to create a cluster on Google Kubernetes Engine (GKE), Minikube or Azure Kubernetes Service (AKS), and install Agones.
Usage
Documentation and usage guides on how to develop and host dedicated game servers on top of Agones.
Quickstarts:
Guides
Reference
Examples
- Full GameServer Configuration
- Full Fleet Configuration
- Full Fleet Allocation Configuration
- Simple UDP (Go) - simple server and client that send UDP packets back and forth.
- CPP Simple (C++) - C++ example that starts up, stays healthy and then shuts down after 60 seconds.
- Xonotic - Wraps the SDK around the open source FPS game Xonotic and hosts it on Agones.
Get involved
Code of Conduct
Participation in this project comes under the Contributor Covenant Code of Conduct
Development and Contribution
Please read the contributing guide for directions on submitting Pull Requests to Agones.
See the Developing, Testing and Building Agones documentation for developing, testing and building Agones from source.
The Release Process documentation displays the project's upcoming release calendar and release process.
Agones is in active development - we would love your help in shaping its future!
This all sounds great, but can you explain Docker and/or Kubernetes to me?
Docker
Kubernetes
- You should totally read this comic, and interactive tutorial
- Katacoda's free, interactive Kubernetes course
Licence
Apache 2.0
Documentation
¶
Overview ¶
Package agones is a library for hosting, running and scaling dedicated game servers on Kubernetes.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
controller
Controller for gameservers
|
Controller for gameservers |
|
sdk-server
sidecar for the game server that the sdk connects to
|
sidecar for the game server that the sdk connects to |
|
examples
|
|
|
simple-udp/client
Package main implements a client that reads a line from stdin and then sends it as a UDP packet to the -address flag
|
Package main implements a client that reads a line from stdin and then sends it as a UDP packet to the -address flag |
|
simple-udp/server
Package main is a very simple echo UDP server
|
Package main is a very simple echo UDP server |
|
apis
Package apis contains all the types for the Custom Resource Definitions
|
Package apis contains all the types for the Custom Resource Definitions |
|
apis/stable/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
client
Package client contains the generated client for the Custom Resource Definitions
|
Package client contains the generated client for the Custom Resource Definitions |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/stable/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/stable/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
fleetallocation
Package fleetallocation handles management of allocation GameServers from running Fleets
|
Package fleetallocation handles management of allocation GameServers from running Fleets |
|
fleets
Package fleets handles management of the Fleet Custom Resource Definition
|
Package fleets handles management of the Fleet Custom Resource Definition |
|
gameservers
Package gameservers handles management of the GameServer Custom Resource Definition
|
Package gameservers handles management of the GameServer Custom Resource Definition |
|
gameserversets
Package gameserversets handles management of the GameServerSet Custom Resource Definition
|
Package gameserversets handles management of the GameServerSet Custom Resource Definition |
|
sdk
Package sdk is a reverse proxy.
|
Package sdk is a reverse proxy. |
|
testing
Package testing is for project wide testing utilities.
|
Package testing is for project wide testing utilities. |
|
util
Package util is for general libraries that aren't specific to Agones
|
Package util is for general libraries that aren't specific to Agones |
|
util/crd
Package crd contains utilities for working with CustomResourceDefinitions.
|
Package crd contains utilities for working with CustomResourceDefinitions. |
|
util/runtime
Package runtime handles runtime errors Wraps and reconfigures functionality in apimachinery/pkg/runtime
|
Package runtime handles runtime errors Wraps and reconfigures functionality in apimachinery/pkg/runtime |
|
util/signals
Package signals contains utilities for managing process signals, particularly around stopping processes
|
Package signals contains utilities for managing process signals, particularly around stopping processes |
|
util/webhooks
Package webhooks manages and receives Kubernetes Webhooks
|
Package webhooks manages and receives Kubernetes Webhooks |
|
util/workerqueue
Package workerqueue extends client-go's workqueue functionality into an opinionated queue + worker model that is reusable
|
Package workerqueue extends client-go's workqueue functionality into an opinionated queue + worker model that is reusable |
|
sdks
|
|
|
go
Package sdk is the Go game server sdk
|
Package sdk is the Go game server sdk |
Click to show internal directories.
Click to hide internal directories.