Reorganizing Project Layout

.github/workflows/main.yml

@@ -6,9 +6,9 @@ name: CI
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -27,17 +27,17 @@ jobs:
         uses: actions/setup-go@v2.1.3
         with:
           # The Go version to download (if necessary) and use. Supports semver spec and ranges.
-          go-version: 1.16.5
+          go-version: 1.17.5
       - name: build Docker images
         run: make builddockerlocal
       - name: GameServer API service unit tests
-        run: cd tools/gameserverapi && GIN_MODE=release go test
+        run: cd cmd/gameserverapi && GIN_MODE=release go test
       - name: initcontainer unit tests
-        run: cd initcontainer && go test
+        run: cd cmd/initcontainer && go test
       - name: nodeagent unit tests
-        run: cd nodeagent && go test
+        run: cd cmd/nodeagent && go test
       - name: operator unit tests
-        run: IMAGE_NAME_SAMPLE=thundernetes-netcore-sample IMAGE_NAME_INIT_CONTAINER=thundernetes-initcontainer TAG=$(git rev-list HEAD --max-count=1 --abbrev-commit) make -C operator test
+        run: IMAGE_NAME_SAMPLE=thundernetes-netcore-sample IMAGE_NAME_INIT_CONTAINER=thundernetes-initcontainer TAG=$(git rev-list HEAD --max-count=1 --abbrev-commit) make -C pkg/operator test
       - name: install kind binaries
         run: make installkind
       - name: create kind cluster

.github/workflows/publish.yml

@@ -27,4 +27,4 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: build and push Docker images
-        run: export $(grep -v '^#' .versions | xargs -d '\n') && make build push
+        run: export $(grep -v '^#' .versions | xargs -d '\n') && make push

.gitignore

@@ -18,4 +18,7 @@
 
 /**/GameLogs/*
 
-installfilesdev
+installfilesdev
+
+
+.uptodate

.versions

@@ -1,6 +1,2 @@
 #!/bin/bash
-export OPERATOR_TAG=0.1.0
-export NODE_AGENT_TAG=0.1.0
-export INIT_CONTAINER_TAG=0.1.0
-export NETCORE_SAMPLE_TAG=0.1.0
-export OPENARENA_SAMPLE_TAG=0.1.0
+export IMAGE_TAG=0.1.0

Makefile

@@ -1,16 +1,13 @@
-NS ?= ghcr.io/playfab
+
+NS ?= ghcr.io/playfab/
 
 export IMAGE_NAME_OPERATOR=thundernetes-operator
 export IMAGE_NAME_NODE_AGENT=thundernetes-nodeagent
 export IMAGE_NAME_INIT_CONTAINER=thundernetes-initcontainer
-export IMAGE_NAME_NETCORE_SAMPLE=thundernetes-netcore-sample
-export IMAGE_NAME_OPENARENA_SAMPLE=thundernetes-openarena-sample
+export IMAGE_NAME_NETCORE_SAMPLE=thundernetes-netcore
+export IMAGE_NAME_OPENARENA_SAMPLE=thundernetes-openarena
 
-export OPERATOR_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
-export NODE_AGENT_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
-export INIT_CONTAINER_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
-export NETCORE_SAMPLE_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
-export OPENARENA_SAMPLE_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
+export IMAGE_TAG?=$(shell git rev-list HEAD --max-count=1 --abbrev-commit)
 
 # local e2e with kind
 export KIND_CLUSTER_NAME=kind
@@ -20,67 +17,90 @@ export KIND_CLUSTER_NAME=kind
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
-build:
-	docker build -f ./operator/Dockerfile -t $(NS)/$(IMAGE_NAME_OPERATOR):$(OPERATOR_TAG) ./operator
-	docker build -f ./nodeagent/Dockerfile -t $(NS)/$(IMAGE_NAME_NODE_AGENT):$(NODE_AGENT_TAG) ./nodeagent
-	docker build -f ./initcontainer/Dockerfile -t $(NS)/$(IMAGE_NAME_INIT_CONTAINER):$(INIT_CONTAINER_TAG) ./initcontainer
-	docker build -f ./samples/netcore/Dockerfile -t $(NS)/$(IMAGE_NAME_NETCORE_SAMPLE):$(NETCORE_SAMPLE_TAG) ./samples/netcore
-	docker build -f ./samples/openarena/Dockerfile -t $(NS)/$(IMAGE_NAME_OPENARENA_SAMPLE):$(OPENARENA_SAMPLE_TAG) ./samples/openarena
+# Support gsed on OSX (installed via brew), falling back to sed. On Linux
+# systems gsed won't be installed, so will use sed as expected.
+SED ?= $(shell which gsed 2>/dev/null || which sed)
+
+GIT_REVISION := $(shell git rev-parse --short HEAD)
+UPTODATE := .uptodate
+# Automated DockerFile building
+# By convention, every directory with a Dockerfile in it will build an image called ghcr.io/playfab/<directory name>
+# An .uptodate file will be created in the directory to indicate that the Dockerfile has been built.
+%/$(UPTODATE): %/Dockerfile
+	@echo
+	docker build --build-arg=revision=$(GIT_REVISION) -t $(NS)thundernetes-$(shell basename $(@D)) -t $(NS)thundernetes-$(shell basename $(@D)):$(IMAGE_TAG) -f $(@D)/Dockerfile .
+	@echo
+	touch $@
+
+# We don't want find to scan inside a bunch of directories, to speed up Dockerfile detection.
+DONT_FIND := -name vendor -prune -o -name .git -prune -o -name .cache -prune -o -name .pkg -prune -o -name packaging -prune -o -name build-env -prune -o
+
+# Get a list of directories containing Dockerfiles
+DOCKERFILES := $(shell find . $(DONT_FIND) -type f -name 'Dockerfile' -print)
+UPTODATE_FILES := $(patsubst %/Dockerfile,%/$(UPTODATE),$(DOCKERFILES))
+DOCKER_IMAGE_DIRS := $(patsubst %/Dockerfile,%,$(DOCKERFILES))
+IMAGE_NAMES := $(foreach dir,$(DOCKER_IMAGE_DIRS),$(patsubst %,$(NS)thundernetes-%,$(shell basename $(dir))))
+images:
+	$(info $(IMAGE_NAMES))
+	@echo > /dev/null
+
+buildimage: #creates a docker image as a build environment for thundernetes
+	docker build -t thundernetes-src:$(GIT_REVISION) -f build-env/Dockerfile .
+
+build: buildimage $(UPTODATE_FILES)
 
-push:
-	docker push $(NS)/$(IMAGE_NAME_OPERATOR):$(OPERATOR_TAG)
-	docker push $(NS)/$(IMAGE_NAME_NODE_AGENT):$(NODE_AGENT_TAG)
-	docker push $(NS)/$(IMAGE_NAME_INIT_CONTAINER):$(INIT_CONTAINER_TAG)
-	docker push $(NS)/$(IMAGE_NAME_NETCORE_SAMPLE):$(NETCORE_SAMPLE_TAG)
-	docker push $(NS)/$(IMAGE_NAME_OPENARENA_SAMPLE):$(OPENARENA_SAMPLE_TAG)
-
-builddockerlocal:
-	docker build -f operator/Dockerfile -t $(IMAGE_NAME_OPERATOR):$(OPERATOR_TAG) ./operator
-	docker build -f nodeagent/Dockerfile -t $(IMAGE_NAME_NODE_AGENT):$(NODE_AGENT_TAG) ./nodeagent
-	docker build -f initcontainer/Dockerfile -t $(IMAGE_NAME_INIT_CONTAINER):$(INIT_CONTAINER_TAG) ./initcontainer	
-	docker build -f samples/netcore/Dockerfile -t $(IMAGE_NAME_NETCORE_SAMPLE):$(NETCORE_SAMPLE_TAG) ./samples/netcore	
-	docker build -f samples/openarena/Dockerfile -t $(IMAGE_NAME_OPENARENA_SAMPLE):$(OPENARENA_SAMPLE_TAG) ./samples/openarena	
+push: build
+	for image in $(IMAGE_NAMES); do \
+		docker push $$image:$(IMAGE_TAG); \
+	done
+
+builddockerlocal: build 
+	for image in $(IMAGE_NAMES); do \
+		localname=`echo $$image| $(SED) -e 's:$(NS)::g'`; \
+		docker tag $$image:$(IMAGE_TAG) $$localname:$(IMAGE_TAG); \
+	done
 
 installkind:
 	curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64
 	chmod +x ./kind
-	mkdir -p ./operator/testbin/bin
-	mv ./kind ./operator/testbin/bin/kind
+	mkdir -p ./pkg/operator/testbin/bin
+	mv ./kind ./pkg/operator/testbin/bin/kind
 
 createkindcluster: 
-	./operator/testbin/bin/kind create cluster --config ./e2e/kind-config.yaml
+	./pkg/operator/testbin/bin/kind create cluster --config ./e2e/kind-config.yaml
 
 deletekindcluster:
-	./operator/testbin/bin/kind delete cluster 
+	./pkg/operator/testbin/bin/kind delete cluster 
 
 e2elocal: 
 	kubectl config use-context kind-$(KIND_CLUSTER_NAME)
 	chmod +x ./e2e/run.sh
-	./e2e/run.sh config-$(KIND_CLUSTER_NAME) local
+	IMAGE_TAG=${IMAGE_TAG} ./e2e/run.sh config-$(KIND_CLUSTER_NAME) local
 
 createcrds:
-	make -C operator install
+	make -C pkg/operator install
 cleancrds:
-	make -C operator uninstall
+	make -C pkg/operator uninstall
 
 cleanall:
-	kubectl delete gsb --all && make -C operator undeploy
+	kubectl delete gsb --all && make -C pkg/operator undeploy
 
 create-install-files:
 	. .versions && \
-	IMG=$(NS)/$(IMAGE_NAME_OPERATOR):$${OPERATOR_TAG} \
-	IMAGE_NAME_INIT_CONTAINER=$(NS)/$(IMAGE_NAME_INIT_CONTAINER) \
-	IMAGE_NAME_NODE_AGENT=$(NS)/$(IMAGE_NAME_NODE_AGENT) \
-	INIT_CONTAINER_TAG=$${INIT_CONTAINER_TAG} \
-	NODE_AGENT_TAG=$${NODE_AGENT_TAG} \
-	make -C operator create-install-files
+	IMG=$(NS)$(IMAGE_NAME_OPERATOR):$${IMAGE_TAG} \
+	IMAGE_NAME_INIT_CONTAINER=$(NS)$(IMAGE_NAME_INIT_CONTAINER) \
+	IMAGE_NAME_NODE_AGENT=$(NS)$(IMAGE_NAME_NODE_AGENT) \
+	make -C pkg/operator create-install-files
 
 create-install-files-dev:
 	mkdir -p ./installfilesdev && \
-	INSTALL_FILES_FOLDER=installfilesdev \
-	IMG=$(NS)/$(IMAGE_NAME_OPERATOR):$${OPERATOR_TAG} \
-	IMAGE_NAME_INIT_CONTAINER=$(NS)/$(IMAGE_NAME_INIT_CONTAINER) \
-	IMAGE_NAME_NODE_AGENT=$(NS)/$(IMAGE_NAME_NODE_AGENT) \
-	INIT_CONTAINER_TAG=$${INIT_CONTAINER_TAG} \
-	NODE_AGENT_TAG=$${NODE_AGENT_TAG} \
-	make -C operator create-install-files
+	INSTALL_FILES_FOLDER=../../installfilesdev \
+	IMG=$(NS)$(IMAGE_NAME_OPERATOR):${IMAGE_TAG} \
+	IMAGE_NAME_INIT_CONTAINER=$(NS)$(IMAGE_NAME_INIT_CONTAINER) \
+	IMAGE_NAME_NODE_AGENT=$(NS)$(IMAGE_NAME_NODE_AGENT) \
+	make -C pkg/operator create-install-files
+
+clean:
+	docker rmi $(IMAGE_NAMES) >/dev/null 2>&1 || true
+	rm -rf -- $(UPTODATE_FILES) $(EXES) .cache dist
+	go clean ./...

build-env/Dockerfile

@@ -0,0 +1,14 @@
+# build stage
+FROM golang:1.17 as builder
+
+WORKDIR /workspace
+# Copy the Go Module code
+COPY go.mod ./go.mod
+COPY go.sum ./go.sum
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+RUN go mod download
+COPY cmd/ ./cmd
+COPY e2e/ ./e2e
+COPY pkg/ ./pkg
+

e2e/cmd/main.go → cmd/e2e/main.go

@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	mpsv1alpha1 "github.com/playfab/thundernetes/operator/api/v1alpha1"
+	mpsv1alpha1 "github.com/playfab/thundernetes/pkg/operator/api/v1alpha1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"

e2e/cmd/utilities.go → cmd/e2e/utilities.go

@@ -14,7 +14,7 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
-	mpsv1alpha1 "github.com/playfab/thundernetes/operator/api/v1alpha1"
+	mpsv1alpha1 "github.com/playfab/thundernetes/pkg/operator/api/v1alpha1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes"

tools/gameserverapi/Dockerfile → cmd/gameserverapi/Dockerfile

@@ -1,19 +1,9 @@
 # build stage
-FROM golang:1.16 as builder
-
-WORKDIR /workspace
-# Copy the Go Modules manifests
-COPY go.mod ./
-COPY go.sum ./
-# cache deps before building and copying source so that we don't need to re-download as much
-# and so that source changes don't invalidate our downloaded layer
-RUN go mod download
-
-# Copy the go source
-COPY *.go ./
+ARG revision
+FROM thundernetes-src:$revision as builder
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o thundernetes-gameserver-api-service 
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o thundernetes-gameserver-api-service ./cmd/gameserverapi
 
 # Use distroless as minimal base image to package the binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

tools/gameserverapi/main.go → cmd/gameserverapi/main.go

@@ -7,7 +7,7 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
-	mpsv1alpha1 "github.com/playfab/thundernetes/operator/api/v1alpha1"
+	mpsv1alpha1 "github.com/playfab/thundernetes/pkg/operator/api/v1alpha1"
 	log "github.com/sirupsen/logrus"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"

tools/gameserverapi/main_test.go → cmd/gameserverapi/main_test.go

@@ -10,7 +10,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	mpsv1alpha1 "github.com/playfab/thundernetes/operator/api/v1alpha1"
+	mpsv1alpha1 "github.com/playfab/thundernetes/pkg/operator/api/v1alpha1"
 	"k8s.io/client-go/kubernetes/scheme"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"

cmd/initcontainer/Dockerfile

@@ -0,0 +1,12 @@
+# build stage
+# build stage
+ARG revision
+FROM thundernetes-src:$revision as builder
+
+RUN go build -o initcontainer ./cmd/initcontainer/
+
+# final stage
+FROM alpine:3.12
+WORKDIR /app
+COPY --from=builder /workspace/initcontainer /app/
+ENTRYPOINT ./initcontainer

nodeagent/Dockerfile → cmd/nodeagent/Dockerfile

@@ -1,19 +1,9 @@
 # build stage
-FROM golang:1.16 as builder
-
-WORKDIR /workspace
-# Copy the Go Modules manifests
-COPY go.mod ./
-COPY go.sum ./
-# cache deps before building and copying source so that we don't need to re-download as much
-# and so that source changes don't invalidate our downloaded layer
-RUN go mod download
-
-# Copy the go source
-COPY *.go ./
+ARG revision
+FROM thundernetes-src:$revision as builder
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o thundernetes-nodeagent 
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o thundernetes-nodeagent ./cmd/nodeagent
 
 # Use distroless as minimal base image to package the binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

docs/development.md

@@ -3,6 +3,7 @@
 ## Release new thundernetes version
 
 - Make sure you update `.version` file on the root of this repository with the new version
+- Run `make clean` to ensure any cached artifacts of old builds are deleted.
 - Run `make create-install-files`
 - Push and merge
 - Run the GitHub Actions workflow [here](https://github.com/PlayFab/thundernetes/actions/workflows/publish.yml)
@@ -68,7 +69,7 @@ for i in {1..50}; do SESSION_ID=$(uuidgen); curl --key ~/private.pem --cert ~/pu
 ## Run end to end tests locally
 
 ```bash
-make deletekindcluster && make builddockerlocal && make createkindcluster && make e2elocal
+make clean deletekindcluster builddockerlocal createkindcluster e2elocal
 ```
 
 ## Run controller locally
@@ -88,7 +89,7 @@ IMG=ghcr.io/playfab/thundernetes-operator:${TAG} \
   IMAGE_NAME_INIT_CONTAINER=ghcr.io/playfab/thundernetes-initcontainer \
   IMAGE_NAME_SIDECAR=ghcr.io/playfab/thundernetes-sidecar-netcore \
   API_SERVICE_SECURITY=none \
-   make -C operator install deploy
+   make -C pkg/operator install deploy
 ```
 
 Note that this will install thundernetes without any security for the allocation API service. If you want to enable security for the allocation API service, you can should provide a certificate and key for the allocation API service.
@@ -115,13 +116,13 @@ IMG=ghcr.io/playfab/thundernetes-operator:${TAG} \
   IMAGE_NAME_INIT_CONTAINER=docker.io/dgkanatsios/thundernetes-initcontainer \
   IMAGE_NAME_SIDECAR=docker.io/dgkanatsios/thundernetes-sidecar-netcore \
   API_SERVICE_SECURITY=usetls \
-   make -C operator install deploy
+   make -C pkg/operator install deploy
 ```
 
 As soon as this is done, you can run `kubectl -n thundernetes-system get pods` to verify that the operator pod is running. To run a demo gameserver, you can use the command:
 
 ```bash
-kubectl apply -f operator/config/samples/netcore.yaml
+kubectl apply -f pkg/operator/config/samples/netcore.yaml
 ```
 
 This will create a GameServerBuild with 2 standingBy and 4 maximum gameservers.
@@ -225,7 +226,7 @@ gameserverbuild-sample-gqhrm   Healthy   StandingBy   52.183.88.255   80:10319
 Project was bootstrapped using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) using the following commands:
 
 ```bash
-kubebuilder init --domain playfab.com --repo github.com/playfab/thundernetes/operator
+kubebuilder init --domain playfab.com --repo github.com/playfab/thundernetes/pkg/operator
 kubebuilder create api --group mps --version v1alpha1 --kind GameServer
 kubebuilder create api --group mps --version v1alpha1 --plural gameserverbuilds --kind GameServerBuild 
 kubebuilder create api --group mps --version v1alpha1 --plural gameserverdetails --kind GameServerDetail 
@@ -261,7 +262,7 @@ To test your changes to thundernetes to a Kubernetes cluster, you can use the fo
 
 - The Makefile on the root of the project contains a variable `NS` that points to the container registry that you use during development. So you'd need to either set the variable in your environment (`export NS=<your-container-registry>`) or set it before calling `make` (like `NS=<your-container-registry> make build push`).
 - Login to your container registry (`docker login`)
-- Run `make build push` to build the container images and push them to your container registry
+- Run `make clean build push` to build the container images and push them to your container registry
 - Run `create-install-files-dev` to create the install files for the cluster
 - Checkout the `installfilesdev` folder for the generated install files. This file is included in .gitignore so it will never be committed.
 - Test your changes as required.