Documentation, GZip compression & Debian docker image

.dockerignore

@@ -1,2 +1,6 @@
 management_os/build/linux
+control_server/disks
+control_server/disks
+control_server/old_disks
+baas.qcow2
 .git/

.github/workflows/ci.yml

@@ -7,18 +7,20 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: 1.16
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Build
-        run: go test ./...
+        run: |
+               sudo cp management_os/config/config.toml /etc/baas.toml
+               sudo /opt/hostedtoolcache/go/1.16.10/x64/bin/go test ./...
   lint:
     runs-on: ubuntu-latest
     steps:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: 1.16
       - name: Checkout code
         uses: actions/checkout@v2
         with:

.gitignore

@@ -262,6 +262,8 @@ Sessionx.vim
 # Temporary
 .netrwhist
 *~
+#*
+
 # Auto-generated tag files
 tags
 # Persistent undo
@@ -273,4 +275,7 @@ tags
 
 # for jonathan because I need to run a dhcp server to test things and I put files for that here
 dhcp
+*,iso
 
+# Don't upload the database
+store.db

AUTHORS

@@ -0,0 +1,7 @@
+# This is the list of baas-project/baas's authors for copyright purposes.
+# This does not necessarily list everyone who has contributed code, since
+# in some cases,
+# their employer may be the copyright holder. To see the full list of
+# contributors, see the revision history in source control.
+
+u5surf <u5.horie@gmail.com>

Makefile

@@ -4,7 +4,7 @@ mkfile_dir := $(shell dirname $(mkfile_path))
 # Change this to your own local ip address for testing,
 # or to the ip address of the control server when ~~testing~~ running in production.
 # This will be put in the hosts file.
-export CONTROL_SERVER_IP ?= 192.168.0.4
+export CONTROL_SERVER_IP ?= 192.168.2.76
 
 lint_fix:
 	goimports -local baas -w **/*.go
@@ -16,11 +16,10 @@ lint:
 
 management_os: management_initramfs management_kernel
 
-management_initramfs: control_server/static/initramfs
+management_initramfs:
 	@$(mkfile_dir)/management_os/build/build_management_initramfs.sh
 
-management_kernel: control_server/static/vmlinuz
-	@$(mkfile_dir)/management_os/build/build_management_kernel.sh
+management_initramfs: control_server/static/initramfs
 
 control_server_docker:
 	@docker-compose -f $(mkfile_dir)/docker-compose.yml up --build

README.md

@@ -1,20 +1,71 @@
 
 # BAAS
 
-Baremetal as a service, or abbreviated to BAAS is a project done for the TU Delft to facilitate operating systems 
+Baremetal As A Service, or abbreviated to BAAS is a project done for the TU Delft to facilitate operating systems
 research on high-powered machines, by scheduling the access researches have to these machines. This system makes sure
 each researcher can have full access to the machines in their timeslot, being able to load their own (custom) kernel and have
 access to all hardware. BAAS makes sure the system is reset a well-known state after every job, to make sure these custom kernels
 have not messed up the system enough to make further research on them impossible.
 
 Disclaimer: this system is custom-built for the needs of the TU Delft. It is open source, and written to be extensible,
-but it is unlikely that it will completely fit your needs without changes. We are open to pull requests, 
+but it is unlikely that it will completely fit your needs without changes. We are open to pull requests,
 but we might not implement suggestions ourselves which are outside the scope of the requirements for the TU Delft.
 
 # Documentation
 
 Some documentation about the systems, and building these systems is provided [here](https://baas-project.github.io/baas/)
 
+# Install
+
+## Required software
+- Go
+- cpio
+- goimports
+- libvirt
+- virt-manager/virt-viewer
+
+## Installation of the virtual machine
+This software works on a client a server-model, where there is a
+central control server which offers the management OS to one or multiple 
+clients. These are two entirely different systems and hence both
+testing as well as developing must be done on two separate machines.
+
+### Client machine
+Normally, you would use a virtual machine to create a client machine
+and run the server on your hardware. It is recommended to use libvirt
+for this, which is also what was used for initial development. You can
+set it up as follows:
+
+First start virt-manager, go to Edit->Connection Details and create a
+new network, select NAT, set the name as BAASNetwork and set "Forward
+To" as the network card you typically use (in my case wlan0). Press on
+finish.
+
+> :warning: If you have problems with connecting to the server, 
+>  double check if there is not a firewall running in the background. 
+Run the following command, after running it, you should be able to
+boot the virtual machine with the proper network settings.
+
+```sh
+virt-install --pxe --prompt --memory 2048 --name baas --disk size=30
+--boot uefi,network,hd --network network=BAASNetwork --os-variant generic
+```
+
+Finally generate the management operating system which is run on the 
+client machine. 
+
+```sh
+make management_initramfs
+```
+
+### Control server
+In `virt-manager` go to view and select Details, press on the light
+bulb and find the menu item called NIC. From there copy the MAC
+address and change the value in control_server/main.go to this IP
+address. You can then run `make control_server` to run the control
+server and reboot the virtual machine. If all is well, it should now
+boot into the management operating system.
+
 # License
 
-// TODO
+// TODO

control_server/.gitignore

@@ -0,0 +1 @@
+disks/

control_server/Dockerfile

@@ -12,10 +12,10 @@ RUN mkdir /static
 
 # Build project
 COPY . .
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-w -s" -o control_server_bin ./control_server
+RUN CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -ldflags="-w -s" -o control_server_bin ./control_server
 
 # Run stage
-FROM scratch
+FROM gcr.io/distroless/base
 WORKDIR /app
 
 COPY --from=build /build/control_server_bin /app/control_server_bin

control_server/api/api.go

@@ -0,0 +1,24 @@
+// Package api provides functions for handling http requests on the control server.
+// This is used to respond to requests from pixiecore, to serve files (kernel, initramfs, disk images)
+// and to communicate with machines running the management os.
+package api
+
+import (
+	"github.com/baas-project/baas/pkg/database"
+)
+
+// API is a struct on which functions are defined that respond to requests
+// from either the management OS, or the end user (through some kind of interface).
+// This struct holds state necessary for the request handlers.
+type API struct {
+	store    database.Store
+	diskpath string
+}
+
+// NewAPI creates a new API struct.
+func NewAPI(store database.Store, diskpath string) *API {
+	return &API{
+		store:    store,
+		diskpath: diskpath,
+	}
+}

control_server/httpserver/bootconfigroute.go → control_server/api/boot.go

@@ -1,15 +1,15 @@
-package httpserver
+package api
 
 import (
 	"encoding/json"
 	"net"
 	"net/http"
 
+	"github.com/baas-project/baas/pkg/model"
+
 	log "github.com/sirupsen/logrus"
 
 	"github.com/gorilla/mux"
-
-	"github.com/baas-project/baas/control_server/machines"
 )
 
 type bootConfigResponse struct {
@@ -26,9 +26,10 @@ type bootConfigResponse struct {
 	Cmdline string `json:"cmdline"`
 }
 
-func getBootConfig(arch machines.SystemArchitecture) *bootConfigResponse {
+func getBootConfig(arch model.SystemArchitecture) *bootConfigResponse {
 	switch arch {
-	case machines.X86_64:
+	case model.X86_64:
+		// TODO: refactor
 		return &bootConfigResponse{
 			Kernel: "http://localhost:4848/static/vmlinuz",
 			Initramfs: []string{
@@ -37,17 +38,18 @@ func getBootConfig(arch machines.SystemArchitecture) *bootConfigResponse {
 			Message: "Booting into X86 management kernel.",
 			Cmdline: "root=sr0",
 		}
-	case machines.Arm64:
+	case model.Arm64:
+		log.Warn("Received request to boot an ARM64 machine, which has not been implemented yet.")
 		fallthrough
-	case machines.Unknown:
+	case model.Unknown:
 		fallthrough
 	default:
 		return nil
 	}
 }
 
 // ServeBootConfigurations actually responds to requests from pixiecore.
-func (routes *Routes) ServeBootConfigurations(w http.ResponseWriter, r *http.Request) {
+func (api *API) ServeBootConfigurations(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	mac := vars["mac"]
 
@@ -60,7 +62,7 @@ func (routes *Routes) ServeBootConfigurations(w http.ResponseWriter, r *http.Req
 
 	log.Infof("Serving boot config for %v at ip: %v", mac, addr)
 
-	m, err := routes.machineStore.GetMachine(mac)
+	m, err := api.store.GetMachineByMac(mac)
 	if err != nil {
 		log.Errorf("Couldn't find machine in store: %v", err)
 		w.WriteHeader(http.StatusNotFound)