Fix: Improve Dockerfiles and containerlab creation (especially in build and startup time)

See merge request !341

Co-authored-by: Malte Bauch <malte.bauch@extern.h-da.de>

.gitlab/ci/.build-container.yml

@@ -9,14 +9,14 @@
 build-testing-image:
     script:
         - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-        - docker build -t "$GOSDN_TESTING_IMAGE" -f "${CI_PROJECT_DIR}/controller/Dockerfile" --target "installer" --build-arg "GOLANG_VERSION=$GOLANG_VERSION" --build-arg "BUILDARGS=$BUILDARGS" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
+        - docker buildx build -t "$GOSDN_TESTING_IMAGE" -f "${CI_PROJECT_DIR}/controller/controller.Dockerfile" --target "builder" --build-arg "GOLANG_VERSION=$GOLANG_VERSION" --build-arg "BUILDARGS=$BUILDARGS" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
         - docker push "$GOSDN_TESTING_IMAGE"
     <<: *build
 
 build-image:
     script:
         - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-        - docker build -t "$CI_REGISTRY_IMAGE:$TAG" -f "${CI_PROJECT_DIR}/controller/Dockerfile" --build-arg "GOLANG_VERSION=$GOLANG_VERSION" --build-arg "BUILDARGS=$BUILDARGS" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
+        - docker buildx build -t "$CI_REGISTRY_IMAGE:$TAG" -f "${CI_PROJECT_DIR}/controller/controller.Dockerfile" --build-arg "GOLANG_VERSION=$GOLANG_VERSION" --build-arg "BUILDARGS=$BUILDARGS" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
         - docker push "$CI_REGISTRY_IMAGE:$TAG"
         # replace all slashes in the tag with hyphen, because slashes are not allowed in tags
         - NEWTAG=${CI_COMMIT_BRANCH//\//-}

Makefile

@@ -52,32 +52,49 @@ generate-csbi-yang-models: install-tools
 	../../$(TOOLS_DIR)/go-ygot-generator-generator config.yaml gostructs.go &&\
 	go generate
 
-build: pre
-	$(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/gosdn ./controller/cmd/gosdn
+build: pre build-gosdn build-gosdnc build-orchestrator
+
+build-gosdn: pre
+	$(GOBUILD) -trimpath -o $(BUILD_ARTIFACTS_PATH)/gosdn ./controller/cmd/gosdn
+
+build-gosdnc: pre
 	CGO_ENABLED=0 $(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/gosdnc ./cli/
+
+build-orchestrator: pre
 	CGO_ENABLED=0 $(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/orchestrator ./csbi/cmd/csbi/
 
-start: build
-	./$(BUILD_ARTIFACTS_PATH)/gosdn -l debug --config ./controller/configs/gosdn.toml
+containerize-all: containerize-gosdn containerize-gosdnc containerize-orchestrator containerize-target
+
+containerize-gosdn:
+	docker buildx build --rm -t gosdn -f controller/controller.Dockerfile .
+
+containerize-gosdnc:
+	docker buildx build --rm -t gosdnc -f cli/cli.Dockerfile .
 
-container: build
-	docker build -t gosdn -f controller/Dockerfile .
-	docker build -t gosdnc -f cli/Dockerfile .
-	docker build -t orchestrator -f csbi/Dockerfile .
-	docker build -t gnmi-target -f csbi/gnmi-target/Dockerfile .
+containerize-orchestrator:
+	docker buildx build --rm -t orchestrator -f csbi/csbi.Dockerfile .
 
-containerlab-start: container
+containerize-target:
+	docker buildx build --rm -t gnmi-target -f csbi/gnmi-target/gnmitarget.Dockerfile .
+
+containerlab-start: containerize-all
 	sudo containerlab deploy --topo gosdn.clab.yaml
+
 containerlab-stop:
 	sudo containerlab destroy --topo gosdn.clab.yaml
+
 containerlab-graph:
 	sudo containerlab graph --topo gosdn.clab.yaml
 
 shell-gosdn:
 	docker exec -it clab-gosdn_csbi_arista_base-gosdn bash
+
 shell-orchestrator:
 	docker exec -it clab-gosdn_csbi_arista_base-orchestrator bash
 
+start: build-gosdn
+	./$(BUILD_ARTIFACTS_PATH)/gosdn -l debug --config ./controller/configs/gosdn.toml
+
 clean:
 	$(GOCLEAN)
 	rm -rf $(BUILD_ARTIFACTS_PATH)

cli/Dockerfile

-ARG GOLANG_VERSION=1.18
-ARG BUILDARGS
-ARG $GITLAB_PROXY
-
-FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-buster AS installer
-
-WORKDIR /gosdn/
-COPY go.* ./
-RUN go mod download
-
-FROM installer as builder
-COPY . .
-RUN make build
-
-
-FROM scratch as gosdnc
-
-COPY --from=builder  /gosdn/artifacts/gosdnc /
-
-ENTRYPOINT ["/gosdnc"]

cli/cli.Dockerfile

+ARG GOLANG_VERSION=1.18
+ARG BUILDARGS
+ARG $GITLAB_PROXY
+
+FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-alpine AS builder
+WORKDIR /gosdn/
+RUN apk add build-base
+COPY . .
+RUN --mount=type=cache,target=/root/go/pkg/mod \
+    --mount=type=cache,target=/root/.cache/go-build \
+    make build-gosdnc
+
+FROM scratch as gosdnc
+
+COPY --from=builder /gosdn/artifacts/gosdnc /
+
+ENTRYPOINT ["./gosdnc"]

cli/cli.Dockerfile.dockerignore

+.git
+.gitlab
+build
+documentation
+mocks
+test
+clab-gosdn_csbi_arista_base
+.cobra.yaml
+*.dockerignore
+.gitlab-ci.yaml
+ARCHITECTURE.md
+CONTRIBUTING.md
+README.md
+artifacts
+build-tools
+models
+csbi

controller/Dockerfile

-ARG GOLANG_VERSION=1.18
-ARG BUILDARGS
-ARG $GITLAB_PROXY
-
-FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-buster AS installer
-
-WORKDIR /gosdn/
-COPY go.* ./
-RUN go mod download
-
-FROM installer as builder
-COPY . .
-RUN make build
-
-FROM builder as gosdn
-COPY controller/configs/development-gosdn.toml.example /gosdn/configs/development-gosdn.toml
-COPY controller/configs/containerlab-gosdn.toml.example /gosdn/configs/containerlab-gosdn.toml
-ENTRYPOINT ["/gosdn/artifacts/gosdn"]

controller/Makefile

@@ -36,16 +36,16 @@ start-insecure: clean build
 	ENVIRONMENT=development ./$(BINARY_NAME) -l debug -s insecure
 
 unit-test: install-tools
-	ENVIRONMENT=testing ./$(TOOLS_DIR)/gotestsum --junitfile report.xml --format testname -- -short -race $$( go list ./... | grep -v /forks/ | grep -v /mocks ) -v -coverprofile=coverage.out
+	ENVIRONMENT=testing ./$(TOOLS_DIR)/gotestsum --junitfile report.xml --format testname -- -short -race $$( go list ./... | grep -v /forks/ | grep -v /mocks ) -v -trimpath -coverprofile=coverage.out
 
 controller-test: install-tools
 	ENVIRONMENT=testing ./$(TOOLS_DIR)/gotestsum --junitfile report.xml --format testname -- -race -v -run TestRun
 
 ci-unit-test: ci-install-tools
-	ENVIRONMENT=testing gotestsum --junitfile report.xml --format testname -- -short -race $$( go list ./... | grep -v /forks/ | grep -v /mocks ) -v -coverprofile=coverage.out -covermode atomic -timeout 30m
+	ENVIRONMENT=testing gotestsum --junitfile report.xml --format testname -- -short -race $$( go list ./... | grep -v /forks/ | grep -v /mocks ) -v -trimpath -coverprofile=coverage.out -covermode atomic -timeout 30m
 
 ci-controller-test: ci-install-tools
-	ENVIRONMENT=testing gotestsum --junitfile report.xml --format testname -- -race -v -run TestRun -coverprofile=coverage.out
+	ENVIRONMENT=testing gotestsum --junitfile report.xml --format testname -- -race -v -run TestRun -trimpath -coverprofile=coverage.out
 
 integration-test-nucleus:
 	ENVIRONMENT=testing  &&\

controller/controller.Dockerfile

+ARG GOLANG_VERSION=1.18
+ARG BUILDARGS
+ARG $GITLAB_PROXY
+
+FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-alpine as builder
+WORKDIR /gosdn/
+RUN apk add --no-cache build-base
+RUN apk add --no-cache bash
+COPY . .
+RUN --mount=type=cache,target=/root/go/pkg/mod \
+    --mount=type=cache,target=/root/.cache/go-build \
+    make build-gosdn
+
+# NOTE: We probably want to make this smaller
+FROM builder as gosdn
+COPY controller/configs/development-gosdn.toml.example ./configs/development-gosdn.toml
+COPY controller/configs/containerlab-gosdn.toml.example ./configs/containerlab-gosdn.toml
+ENTRYPOINT ["./artifacts/gosdn"]

controller/controller.Dockerfile.dockerignore

+.git
+.gitlab
+build
+documentation
+mocks
+test
+clab-gosdn_csbi_arista_base
+.cobra.yaml
+.dockeringore
+.gitlab-ci.yaml
+ARCHITECTURE.md
+CONTRIBUTING.md
+README.md
+artifacts
+build-tools
+models/YangModels
+models/arista

controller/nucleus/plugin.go

@@ -27,6 +27,7 @@ func BuildPlugin(path string, sourceFileNames []string, args ...string) error {
 		"go",
 		"build",
 		"-buildmode=plugin",
+		"-trimpath",
 		"-o",
 		pPath,
 	}

csbi/Dockerfile → csbi/csbi.Dockerfile

@@ -2,17 +2,19 @@ ARG GOLANG_VERSION=1.18
 ARG BUILDARGS
 ARG $GITLAB_PROXY
 
-FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-buster AS installer
-
+FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-alpine AS builder
 WORKDIR /gosdn/
+RUN apk add build-base
+COPY ./models ./models
+COPY ./forks ./forks
+COPY ./Makefile .
+COPY ./api ./api
+COPY ./controller ./controller
+COPY ./csbi ./csbi
 COPY go.* ./
-RUN go mod download
-
-FROM installer as builder
-
-COPY . .
-
-RUN make build
+RUN --mount=type=cache,target=/root/go/pkg/mod \
+    --mount=type=cache,target=/root/.cache/go-build \
+    make build-orchestrator
 
 FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-alpine
 RUN apk add --no-cache git make build-base

csbi/csbi.Dockerfile.dockerignore

+.git
+.gitlab
+build
+documentation
+mocks
+test
+clab-gosdn_csbi_arista_base
+.cobra.yaml
+.dockeringore
+.gitlab-ci.yaml
+ARCHITECTURE.md
+CONTRIBUTING.md
+README.md
+artifacts
+build-tools
+models/YangModels/vendor
+models/YangModels/experimental

csbi/gnmi-target/gnmitarget.Dockerfile.dockerignore

+.git
+.gitlab
+build
+documentation
+mocks
+test
+clab-gosdn_csbi_arista_base
+.cobra.yaml
+*.dockerignore
+.gitlab-ci.yaml
+ARCHITECTURE.md
+CONTRIBUTING.md
+README.md
+artifacts
+build-tools
+models
+cli
+controller
+api
+scripts
+forks