Kuberboat

How to build

First, you should have Golang 1.18 installed. On MacOS, just run

brew install go@1.18

To generate the proto, you should install protobuf compiler and its Golang plugin. On MacOS, run

brew install protobuf@3.19
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

and set your PATH as

export PATH="$PATH:$(go env GOPATH)/bin"

Now you are ready for building Kuberboat. Simply run

make

and you will see the executable under out/bin.

How to run

Prometheus

You should install Prometheus on the master node (where API server is located). Please ensure that prometheus is placed under your system binary directory (/usr/local/bin on Linux). Simply check this by running

prometheus --version

Then, run

./scripts/prometheus/start_prom.sh

This script will start Prometheus based on the requirement of the project.

Kuberboat

make start
make stop
make restart # equal to stop and start

It will start a tmux session with five windows:

1. shell
2. log of kubelet
3. log of apiserver
4. log of prometheus
5. log of etcd container and register your local node to the apiserver.

If you want to start each components seperately, read as follows.

API Server

To start the API server, just run

./out/bin/apiserver

Kubelet

To start Kubelet, just run

./out/bin/kubelet

We recommend that you run Kubelet as a superuser (i.e. root or sudo). Otherwise, you might find some errors after start.

Kubectl

You may use the help flag to get the usage.

kubectl apply -h
kubectl get -h
kubectl describe -h
kubectl delete -h