This document describes how you can build and test Kilo.
To follow along, you need to install the following utilities:
gonot for building but formatting the code and running unit tests
Clone the Repository and
cd into it.
git clone https://github.com/squat/kilo.gitcd kilo
For consistency, the Kilo binaries are compiled in a Docker container, so make sure the
docker package is installed and the daemon is running.
To compile the
kgctl binaries run:
Binaries are always placed in a directory corresponding to the local system's OS and architecture following the pattern
bin/<os>/<architecture>/, so on an AMD64 machine running Linux, the binaries will be stored in
You can build the binaries for a different architecture by setting the
ARCH environment variable before invoking
Likewise, to build
kg for another OS, set the
OS environment variable before invoking
To execute the unit tests, run:
To lint the code in the repository, run:
To execute basic end to end tests, run:
Note: The end to end tests are currently flaky, so try running them again if they fail.
To instead run all of the tests with a single command, run:
If you want to build containers for a processor architecture that is different from your computer's, then you will first need to configure QEMU as the interpreter for binaries built for non-native architectures:
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
$IMAGE environment variable to
<your Docker Hub user name>/kilo.
This way the generated container images and manifests will be named accordingly.
By skipping this step, you will be able to tag images but will not be able to push the containers and manifests to your own Docker Hub.
export IMAGE=<docker hub user name>/kilo
If you want to use a different container registry, run:
export REGISTRY=<your registry without a trailing slash>
To build containers with the
kg image for
Push the container images and build a manifest with:
To tag and push the manifest with
Now you can deploy the custom build of Kilo to your cluster.
If you are already running Kilo, change the image from