There are many ways you can setup you local environment, this is just a basic quick example of how to setup everything you'll need to get started running and developing Armada.
To follow this section it is assumed you have:
- Golang >= 1.12 installed (https://golang.org/doc/install)
kubectlinstalled (https://kubernetes.io/docs/tasks/tools/install-kubectl/)- Docker installed, configured for the current user
- This repository cloned. The guide will assume you are in the root directory of this repository
It is possible to develop Armada locally with kind Kubernetes clusters.
- Get kind (Installation help here)
GO111MODULE="on" go get sigs.k8s.io/kind@v0.5.1- Create kind clusters (you can create any number of clusters)
As this step is using Docker, it will require root to run
kind create cluster --name demoA --config ./example/kind-config.yaml
kind create cluster --name demoB --config ./example/kind-config.yaml - Start Redis
docker run -d -p 6379:6379 redis- Start server in one terminal
go run ./cmd/armada/main.go- Start executor for demoA in a new terminal
KUBECONFIG=$(kind get kubeconfig-path --name="demoA") ARMADA_APPLICATION_CLUSTERID=demoA ARMADA_METRICSPORT=9001 go run ./cmd/executor/main.go- Start executor for demoB in a new terminal
KUBECONFIG=$(kind get kubeconfig-path --name="demoB") ARMADA_APPLICATION_CLUSTERID=demoB ARMADA_METRICSPORT=9002 go run ./cmd/executor/main.go- Create queue & Submit job
go run ./cmd/armadactl/main.go create-queue test --priorityFactor 1
go run ./cmd/armadactl/main.go submit ./example/jobs.yaml
go run ./cmd/armadactl/main.go watch job-set-1For more details on submitting jobs to Armada, see here.
Once you submit jobs, you should be able to see pods appearing in your cluster(s), running what you submitted.
Note: Depending on your Docker setup you might need to load images for jobs you plan to run manually:
kind load docker-image busybox:latestFor unit tests run
make testsFor end to end tests run:
make tests-e2e
# optionally stop kubernetes cluster which was started by test
make e2e-stop-clusterThis project uses code generation. The below sections will discuss how to install and use the code generation tools.
We use protoc to generate the Go files used for our gRPC communication.
The github for this utility ca be found: https://github.com/protocolbuffers/protobuf
- Install
protoc(https://github.com/protocolbuffers/protobuf/releases/download/v3.8.0/protoc-3.8.0-linux-x86_64.zip) and make sure it is on$PATH. - Make sure Go is installed and
$GOPATH/binis in your$PATH
Install required proto libraries:
go get github.com/gogo/protobuf/proto
go get github.com/gogo/protobuf/protoc-gen-gogofaster
go get github.com/gogo/protobuf/gogoproto
go get google.golang.org/grpc
go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
go get github.com/golang/protobuf/protoc-gen-go
GO111MODULE=off go get k8s.io/api
GO111MODULE=off go get k8s.io/apimachinery
GO111MODULE=off go get github.com/gogo/protobuf/gogoproto
Now everything is installed, you can generate types based on the .proto files found in ./internal/armada/api.
There is a script that will regenerate all proto files, assuming the above setup is installed:
./scripts/proto.sh
Our command-line tools used the cobra framework (https://github.com/spf13/cobra).
You can use the cobra cli to add new commands, the below will describe how to add new commands for armadactl but it can be applied to any of our command line tools.
Get cobra cli tool:
go get -u github.com/spf13/cobra/cobra
Change to the directory of the command-line tool you are working on:
cd ./cmd/armadactl
Use cobra to add new command:
cobra add commandName
You should see a new file appear under ./cmd/armadactl/cmd with the name you specified in the command.