build/

README

Agones Development Documentation

Tooling for building and developing against Agones, with only dependencies being Make and Docker

Rather than installing all the dependencies locally, you can test and build Agones using the Docker image that is built from the Dockerfile in this directory. There is an accompanying Makefile for all the common tasks you may wish to accomplish.

Quick Start

1. Platform Setup: Set up your development environment → Platform Setup Guide
2. Build & Test: Learn basic build workflows → Building and Testing Guide
3. Cluster Setup: Set up a development cluster → Cluster Setup Guide

Documentation

Guides

• Platform Setup - Set up development environment on Linux, Windows, macOS
• Building and Testing - Core build workflows and testing procedures
• Cluster Setup - Set up GKE, Minikube, Kind, or custom clusters
• Development Workflow - Advanced development patterns and remote debugging
• Dependencies - Go modules and vendoring
• Performance Testing - Performance testing setup and procedures
• Troubleshooting - Common issues and solutions

Reference

• Make Reference - Complete documentation of all make variables and targets

Common Quick Commands

# Run tests and build images
make lint test-go build-images

# Set up Minikube cluster (with 2 nodes) and install Agones
make minikube-test-cluster MINIKUBE_NODES=2
make build-images minikube-push minikube-install

# Debug with Minikube
make build-debug-images minikube-push minikube-install-debug
make minikube-debug-portforward

# Run end-to-end tests
# This takes a _while_, so run at your peril!
make minikube-test-e2e
# You can specify ARGS to run specific tests
make minikube-test-e2e ARGS='-run TestAllocatorWithSelectors'

For detailed command documentation, see the Make Reference.

Need Help?

• Issues: Check the Troubleshooting Guide
• Build Problems: See Building and Testing Guide
• Setup Issues: Check Platform Setup Guide or Cluster Setup Guide
• Remote Debugging: See Development Workflow Guide
• #development Slack: Join the development channel on Slack and talk to fellow Agones developers.