diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000000000000000000000000000000000000..18a0ad6a5526ad017c2f92cb2aa76251e57144cc
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+
+[{*.yaml, *.yml}]
+indent_size = 2
+
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab
diff --git a/ekms/.gitignore b/.gitignore
similarity index 84%
rename from ekms/.gitignore
rename to .gitignore
index 53ac7f5682104000265d132e5e3665281828cec8..136001a7e5d0b4218e56b22cf73a7c1f98d804bd 100644
--- a/ekms/.gitignore
+++ b/.gitignore
@@ -1,6 +1,9 @@
+artifacts/*
+
+build_env.env
+
# tooling
build-tools/
-artifacts/
# generated files
gostructs.go
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index ffc8e12b3181ed0d10e7ada9e58ee48d99257e66..c7b122572752ef38fea0fd92c05b064202189f9d 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -11,26 +11,24 @@ variables:
- name: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/docker:latest
alias: docker
variables:
- TAG: $CI_COMMIT_SHA
DOCKER_TLS_CERTDIR: "/certs"
+ GOLANG_VERSION: "1.21"
before_script:
- apk add git
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
- docker login -u $CI_DEPENDENCY_PROXY_USER -p $CI_DEPENDENCY_PROXY_PASSWORD $CI_DEPENDENCY_PROXY_SERVER
needs: []
-build-ekms-ubuntu:
+build-ekms:
script:
- - TAG=${CI_COMMIT_BRANCH//\//-}
- - IMAGE_NAME="$IMAGE_PATH/ubuntu"
- - docker buildx build -t "$IMAGE_NAME:$TAG" -f ekms/Dockerfile --target "ubuntu" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
- - docker push "$IMAGE_NAME:$TAG"
+ - IMAGE_NAME="$IMAGE_PATH/ekms"
+ - TAG=$CI_COMMIT_REF_SLUG
+ - docker buildx build --push -t "$IMAGE_NAME:$TAG" -f ekms/Dockerfile --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" --build-arg GITLAB_LOGIN=${GITLAB_LOGIN} --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} --build-arg GOLANG_VERSION=${GOLANG_VERSION} .
<<: *build
-build-ekms-debian:
+build-quantumlayer:
script:
- - TAG=${CI_COMMIT_BRANCH//\//-}
- - IMAGE_NAME="$IMAGE_PATH/debian"
- - docker buildx build -t "$IMAGE_NAME:$TAG" -f ekms/Dockerfile --target "debian" --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" .
- - docker push "$IMAGE_NAME:$TAG"
+ - IMAGE_NAME="$IMAGE_PATH/quantumlayer"
+ - TAG=$CI_COMMIT_REF_SLUG
+ - docker buildx build --push -t "$IMAGE_NAME:$TAG" -f quantumlayer/Dockerfile --build-arg "GITLAB_PROXY=${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/" --build-arg GITLAB_LOGIN=${GITLAB_LOGIN} --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} --build-arg GOLANG_VERSION=${GOLANG_VERSION} .
<<: *build
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..1e7b4b39c5c85a7f16bb91b6524a37b058ac4399
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,90 @@
+PROGNAME=ekms
+OUTPUT=${PROGNAME}_${CI_COMMIT_TAG}_${GOOS}_${GOARCH}
+
+MAKEFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
+MAKEFILE_DIR := $(dir $(MAKEFILE_PATH))
+TOOLS_DIR:= build-tools
+GOSDN_PRG := $(MAKEFILE_DIR)$(TOOLS_DIR)
+GOPATH := $(~/go)
+GOBIN := $(GOSDN_PRG)
+GOLANG_VERSION := 1.21
+
+GOCMD=go
+GOBUILD=$(GOCMD) build
+GOCLEAN=$(GOCMD) clean -cache -fuzzcache -testcache -modcache
+BUILD_ARTIFACTS_PATH=artifacts
+
+-include build_env.env
+
+all: build
+
+pre:
+ mkdir -p $(BUILD_ARTIFACTS_PATH)
+
+install-tools:
+ @echo Install development tooling
+ mkdir -p $(GOSDN_PRG)
+ export GOBIN=$(GOSDN_PRG) && go install github.com/openconfig/ygot/generator@v0.28.3 &&\
+ go install github.com/andresterba/go-ygot-generator-generator@v0.0.4
+ @echo Finished installing development tooling
+
+build-ekms: pre
+ CGO_ENABLED=0 $(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/ekms ./ekms/main.go
+
+build-quantumlayer: pre
+ $(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/quantumlayer ./quantumlayer/example/main.go
+
+quantumlayer-container:
+ docker buildx build --rm -t quantumlayer --load -f ./quantumlayer/Dockerfile --build-arg GITLAB_LOGIN=${GITLAB_LOGIN} --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} --build-arg GOLANG_VERSION=${GOLANG_VERSION} .
+
+ekms-build-debug: pre
+ $(GOBUILD) -gcflags="all=-N -l" -o $(BUILD_ARTIFACTS_PATH)/ekms ./ekms/main.go
+
+generate-yang-models: install-tools
+ cd ekms/model &&\
+ ../../$(TOOLS_DIR)/go-ygot-generator-generator config.yaml gostructs.go &&\
+ go generate
+
+ekms-container:
+ docker buildx build --rm -t ekms --load -f ./ekms/Dockerfile --build-arg GITLAB_LOGIN=${GITLAB_LOGIN} --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} --build-arg GOLANG_VERSION=${GOLANG_VERSION} .
+
+ekms-container-debug:
+ docker buildx build --rm -t ekms-debug --load -f ./ekms/Dockerfile.debug --build-arg GITLAB_LOGIN=${GITLAB_LOGIN} --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} --build-arg GOLANG_VERSION=${GOLANG_VERSION} .
+
+compose-up: ekms-container quantumlayer-container
+ docker-compose up -d
+
+compose-down:
+ docker-compose down
+
+self-certs:
+ mkdir -p ./artifacts/ssl/private
+ mkdir -p ./artifacts/ssl/certs
+ openssl req -x509 -nodes -days 365 -newkey rsa:4096 -keyout ./artifacts/ssl/private/gnmi-target-selfsigned.key -out ./artifacts/ssl/certs/gnmi-target-selfsigned.crt
+
+# other targets
+cross:
+ go build -o ${OUTPUT}
+ sha256sum ${OUTPUT} > ${OUTPUT}.sha256
+
+generate-etsi-rest: generate-etsi-rest-client generate-etsi-rest-server
+
+# Note 1: Make sure to install openapi-generator it is not installed automatically yet. https://github.com/OpenAPITools/openapi-generator#1---installation
+# Note 2: Some unwanted files get removed during the code generation. Maybe adjust the files to delete in the future, if necessary.
+generate-etsi-rest-client:
+ openapi-generator generate -i ekms/api/openapiv3/etsi14.yaml -g go -o ekms/api/go/rest/etsi/client --package-name etsi14 -v --git-host code.fbi.h-da.de --git-repo-id ekms/api/go/rest/etsi/client --git-user-id danet
+ rm ekms/api/go/rest/etsi/client/git_push.sh ekms/api/go/rest/etsi/client/go.mod api/go/rest/etsi/client/go.sum
+
+# Note 1: Make sure to install openapi-generator it is not installed automatically yet. https://github.com/OpenAPITools/openapi-generator#1---installation
+# Note 2: Some unwanted files get removed during the code generation. Maybe adjust the files to delete in the future, if necessary.
+generate-etsi-rest-server:
+ openapi-generator generate -i ekms/api/openapiv3/etsi14.yaml -g go-server -o ekms/api/go/rest/etsi/server --package-name etsi14 -v --git-host code.fbi.h-da.de --git-repo-id ekms/api/go/rest/etsi/server --git-user-id danet
+ rm ekms/api/go/rest/etsi/server/go.mod
+
+
+# Warning: Depending on your go and development configuration might also clean caches, modules and docker containers from your other projects.
+clean:
+ rm -rf $(BUILD_ARTIFACTS_PATH)
+ rm -rf $(TOOLS_DIR)
+ $(GOCLEAN)
+ docker system prune -af
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..3feabb825bd996d77cef8a46af51f649e4353289
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Project Name
+
+## Description
+
+This is a basic readme file for the project.
+
+
+## Usage
+
+See the makefile for options.
+To use private repos rename `build_env.env.example` to `build_env.env` and add valid credentials. If you have access, simply use your username and a GitLab access token.
+
+Use `make compose-up` and `make compose-down`.
+
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository.
+2. Create a new branch.
+3. Make your changes.
+4. Submit a pull request.
+
diff --git a/build_env.env.example b/build_env.env.example
new file mode 100644
index 0000000000000000000000000000000000000000..b1d6f33a7b90707e9188f90038d496b48c415ee8
--- /dev/null
+++ b/build_env.env.example
@@ -0,0 +1,2 @@
+GITLAB_LOGIN=
+GITLAB_TOKEN=
diff --git a/ekms/config/ekms/example01.yaml b/config/ekms/example01.yaml
similarity index 100%
rename from ekms/config/ekms/example01.yaml
rename to config/ekms/example01.yaml
diff --git a/ekms/config/ekms/example02.yaml b/config/ekms/example02.yaml
similarity index 100%
rename from ekms/config/ekms/example02.yaml
rename to config/ekms/example02.yaml
diff --git a/ekms/config/quantumlayer/example01.yaml b/config/quantumlayer/example01.yaml
similarity index 100%
rename from ekms/config/quantumlayer/example01.yaml
rename to config/quantumlayer/example01.yaml
diff --git a/ekms/config/quantumlayer/example02.yaml b/config/quantumlayer/example02.yaml
similarity index 100%
rename from ekms/config/quantumlayer/example02.yaml
rename to config/quantumlayer/example02.yaml
diff --git a/docker-compose.yml b/docker-compose.yml
index 631866ea13c5dae3ed4534067c09176aabccc7ae..cac5c6ccd87cd6c5f1e1e6af2b86cad8daa2c140 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -2,8 +2,7 @@ version: '3'
services:
ekms01:
- build:
- dockerfile: ekms/Dockerfile
+ image: ekms
command: ["start", "--log", "debug", "--kms_config", "/tmp/kms/config/ekms01.yaml", "--insecure"]
volumes:
- ./config/ekms/example01.yaml:/tmp/kms/config/ekms01.yaml
@@ -15,8 +14,7 @@ services:
ipv4_address: 172.100.20.10
ekms02:
- build:
- dockerfile: ekms/Dockerfile
+ image: ekms
command: ["start", "--log", "debug", "--kms_config", "/tmp/kms/config/ekms02.yaml", "--insecure"]
volumes:
- ./config/ekms/example02.yaml:/tmp/kms/config/ekms02.yaml
@@ -28,7 +26,7 @@ services:
ipv4_address: 172.100.20.11
qlayer01:
- image: quantumlayer:latest
+ image: quantumlayer
command: ["--config", "/tmp/quantumlayer/config/quantumlayer01.yaml"]
volumes:
- ./config/quantumlayer/example01.yaml:/tmp/quantumlayer/config/quantumlayer01.yaml
@@ -37,7 +35,7 @@ services:
ipv4_address: 172.100.20.12
qlayer02:
- image: quantumlayer:latest
+ image: quantumlayer
command: ["--config", "/tmp/quantumlayer/config/quantumlayer02.yaml"]
volumes:
- ./config/quantumlayer/example02.yaml:/tmp/quantumlayer/config/quantumlayer02.yaml
diff --git a/ekms/Dockerfile b/ekms/Dockerfile
index 7125dbfff61e444424eb3a2229f9b53fd861b514..cbc63238929fbc6f40c16f4ccf4d71f42ca22da6 100644
--- a/ekms/Dockerfile
+++ b/ekms/Dockerfile
@@ -1,35 +1,24 @@
ARG GOLANG_VERSION=1.21
ARG BUILDARGS
+ARG GITLAB_PROXY
-FROM golang:$GOLANG_VERSION-bookworm as builder
+FROM ${GITLAB_PROXY}golang:$GOLANG_VERSION-bookworm as builder
ARG GITLAB_LOGIN
ARG GITLAB_TOKEN
-WORKDIR /ekms/
-COPY . .
RUN echo "machine code.fbi.h-da.de login ${GITLAB_LOGIN} password ${GITLAB_TOKEN}" > ~/.netrc
+WORKDIR /app/
+COPY . .
RUN --mount=type=cache,target=/root/go/pkg/mod \
--mount=type=cache,target=/root/.cache/go-build \
- make build
-
-FROM ubuntu:22.04 as ubuntu
-RUN apt-get update && apt-get upgrade -y
-RUN apt-get install -y iproute2
-RUN apt-get install -y iputils-ping
-RUN apt-get install -y openssh-client openssh-server
-RUN apt-get install -y libssl-dev
-COPY --from=builder ekms/artifacts/ekms /usr/bin/ekms
-EXPOSE 7030
-EXPOSE 50900
-ENTRYPOINT ["/usr/bin/ekms"]
-CMD [ "start", "--log", "debug" ]
+ make build-ekms
-FROM debian:11 as debian
+FROM ${GITLAB_PROXY}debian:12-slim as debian
RUN apt-get update && apt-get upgrade -y
RUN apt-get install -y iproute2
RUN apt-get install -y iputils-ping
RUN apt-get install -y openssh-client openssh-server
RUN apt-get install -y libssl-dev
-COPY --from=builder ekms/artifacts/ekms /usr/bin/ekms
+COPY --from=builder app/artifacts/ekms /usr/bin/ekms
EXPOSE 7030
EXPOSE 50900
ENTRYPOINT ["/usr/bin/ekms"]
diff --git a/ekms/Dockerfile.debug b/ekms/Dockerfile.debug
index a7e445a77abd3130f60911c523965c4ba288b886..6995f52c96705ebcf6fe8857fb9a8f3fbd7c826b 100644
--- a/ekms/Dockerfile.debug
+++ b/ekms/Dockerfile.debug
@@ -1,13 +1,16 @@
-ARG GOLANG_VERSION=1.20.3
+ARG GOLANG_VERSION=1.21
ARG BUILDARGS
-FROM golang:$GOLANG_VERSION-buster as builder
-WORKDIR /ekms/
+FROM golang:$GOLANG_VERSION-bookworm as builder
+ARG GITLAB_LOGIN
+ARG GITLAB_TOKEN
+RUN echo "machine code.fbi.h-da.de login ${GITLAB_LOGIN} password ${GITLAB_TOKEN}" > ~/.netrc
+WORKDIR /app/
COPY . .
RUN --mount=type=cache,target=/root/go/pkg/mod \
--mount=type=cache,target=/root/.cache/go-build
RUN go install github.com/go-delve/delve/cmd/dlv@v1.20.2
-RUN make build-debug
+RUN make ekms-build-debug
FROM debian:11 as debian
EXPOSE 7030
@@ -18,5 +21,5 @@ RUN apt-get install -y iputils-ping
RUN apt-get install -y openssh-client openssh-server
RUN apt-get install -y libssl-dev
COPY --from=builder /go/bin/dlv /debug/
-COPY --from=builder /ekms/artifacts/ekms /debug/
+COPY --from=builder /app/artifacts/ekms /debug/
CMD [ "/debug/dlv", "--listen=:4000", "--headless=true", "--log=true", "--accept-multiclient", "--api-version=2", "exec", "/debug/ekms", "start" ]
diff --git a/ekms/Makefile b/ekms/Makefile
deleted file mode 100644
index 5d08164f71d6a0d968ff9631bf9b38fbcae3e09c..0000000000000000000000000000000000000000
--- a/ekms/Makefile
+++ /dev/null
@@ -1,67 +0,0 @@
-PROGNAME=ekms
-OUTPUT=${PROGNAME}_${CI_COMMIT_TAG}_${GOOS}_${GOARCH}
-
-MAKEFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
-MAKEFILE_DIR := $(dir $(MAKEFILE_PATH))
-TOOLS_DIR:= build-tools
-GOSDN_PRG := $(MAKEFILE_DIR)$(TOOLS_DIR)
-GOPATH := $(~/go)
-GOBIN := $(GOSDN_PRG)
-
-GOCMD=go
-GOBUILD=$(GOCMD) build
-GOCLEAN=$(GOCMD) clean
-BUILD_ARTIFACTS_PATH=artifacts
-
-all: build
-
-pre:
- mkdir -p $(BUILD_ARTIFACTS_PATH)
-
-install-tools:
- @echo Install development tooling
- mkdir -p $(GOSDN_PRG)
- export GOBIN=$(GOSDN_PRG) && go install github.com/openconfig/ygot/generator@v0.28.3 &&\
- go install github.com/andresterba/go-ygot-generator-generator@v0.0.4
- @echo Finished installing development tooling
-
-build: pre
- CGO_ENABLED=0 $(GOBUILD) -o $(BUILD_ARTIFACTS_PATH)/ekms ./main.go
-
-build-debug: pre
- $(GOBUILD) -gcflags="all=-N -l" -o $(BUILD_ARTIFACTS_PATH)/ekms ./main.go
-
-generate-yang-models: install-tools
- cd model &&\
- ../$(TOOLS_DIR)/go-ygot-generator-generator config.yaml gostructs.go &&\
- go generate
-
-container: build
- docker buildx build --rm -t ekms --load -f ./Dockerfile .
-
-container-debug:
- docker buildx build --rm -t ekms-debug --load -f ./Dockerfile.debug .
-
-self-certs:
- mkdir -p ./artifacts/ssl/private
- mkdir -p ./artifacts/ssl/certs
- openssl req -x509 -nodes -days 365 -newkey rsa:4096 -keyout ./artifacts/ssl/private/gnmi-target-selfsigned.key -out ./artifacts/ssl/certs/gnmi-target-selfsigned.crt
-
-# other targets
-cross:
- go build -o ${OUTPUT}
- sha256sum ${OUTPUT} >