Code for Life
Search…
Kurono (aimmo) Setup
The setup process specific to Kurono (aimmo).
Before you follow this section, please make sure that you have done the Common Setup.
To work on Kurono (aimmo) you will need some knowledge and familiarity with containerisation technology: Docker and Kubernetes.

Install with the setup script

Run in the aimmo repo root directory
1
python aimmo_setup.py
Copied!
Troubleshooting (to be reviewed)
    If the script fails when attempting to install Docker, it may be because you have an old version of docker currently installed. To fix this, run: sudo apt-get remove docker docker-engine docker.io, then re-run the script.
    If there is an issue when using containers or the virtual environment, then there small chance that VT-x/AMD-x virtualization has not been enabled on your machine. If this is the case the main way to solve this is to enable it through the BIOS settings.
If for whatever reason the setup script does not work for you, you can try to do the installations manually (continue to the next section). If it runs correctly, jump ahead to run Kurono.

Install docker and kubernetes manually

Mac setup

    First run brew update to make sure it's up to date.
    ‚ÄčInstall Minikube: brew install minikube.
    Install helm: brew install helm.
    Add agones repo to helm: helm repo add agones https://agones.dev/chart/stable && helm repo update.
    Create a minikube profile for agones: minikube start -p agones --driver=hyperkit.
    Set the minikube profile to agones: minikube profile agones
    Install agones using helm: helm install aimmo --namespace agones-system --create-namespace agones/agones.

Ubuntu setup

    First run sudo apt-get update to make sure it's up to date and save having to do it later in the process.
    Install Snap using sudo apt install snapd.
    Now run sudo snap install kubectl --classic to install kubectl (Kubernetes).
    To install Docker, either use sudo apt-get install docker-ce to install a fixed version of the latest release, or follow the Ubuntu install instructions on the Docker website.
    Install Minikube, running curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64, then sudo install minikube-linux-amd64 /usr/local/bin/minikube
    Install helm: sudo snap install helm --classic
    Add agones repo to helm: helm repo add agones https://agones.dev/chart/stable && helm repo update
    Create a minikube profile for agones: minikube start -p agones.
    Set the minikube profile to agones: minikube profile agones.
    Install agones using helm: helm install aimmo --namespace agones-system --create-namespace agones/agones

Windows setup

    ‚ÄčDownload chocolatey and run choco install kubernetes-cli.
    Install minikube: choco install minikube.
    Install helm: choco install kubernetes-helm.
    Add agones repo to helm: helm repo add agones https://agones.dev/chart/stable && helm repo update.
    Create a minikube profile for agones: minikube start -p agones.
    Set the minikube profile to agones: minikube profile agones.
    Install agones using helm: helm install aimmo --namespace agones-system --create-namespace agones/agones.

To run Kurono

    Ensure you are inside the python virtualenv with pipenv shell.
    Start the agones cluster with:
    ‚Äč
      Mac: minikube start -p agones --driver=hyperkit.
    ‚Äč
      Linux and Windows: minikube start -p agones
    Use python run.py to run the project.

Interacting with the cluster

    kubectl and minikube command lines can be used to interact with the cluster.
    Use minikube dashboard to open the Kubernetes dashboard on your browser.
‚Äč
Follow the instructions at game frontend documentation in order to set up the frontend requirements.
Last modified 3mo ago