New Tornjak version v1.2.2

.github/workflows/master-build.yaml

@@ -31,34 +31,20 @@ jobs:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      # Create sha tagged image for container-agent
-
-      # Deprecating the backend+spire image for now
-      # - name: Set backend-spire image name
-      #   run: echo "CONTAINER_BACKEND_WITH_SPIRE_TAG=ghcr.io/${{ github.repository_owner }}/tornjak-backend-spire-server:$GITHUB_SHA" >> $GITHUB_ENV
+
+      # set repo and GITHUB SHA 
       - name: Set github commit id
         run: echo "GITHUB_SHA=$GITHUB_SHA" >> $GITHUB_ENV
-      - name: Set backend image name
-        run: echo "CONTAINER_BACKEND_TAG=ghcr.io/${{ github.repository_owner }}/tornjak-backend:$GITHUB_SHA" >> $GITHUB_ENV
-      - name: Set frontend image name
-        run: echo "CONTAINER_FRONTEND_TAG=ghcr.io/${{ github.repository_owner }}/tornjak-frontend:$GITHUB_SHA" >> $GITHUB_ENV
-      - name: Set Tornjak image name
-        run: echo "CONTAINER_TAG=ghcr.io/${{ github.repository_owner }}/tornjak:$GITHUB_SHA" >> $GITHUB_ENV
-      - name: Set manager image name
-        run: echo "CONTAINER_MANAGER_TAG=ghcr.io/${{ github.repository_owner }}/tornjak-manager:$GITHUB_SHA" >> $GITHUB_ENV
+      - name: Set release repo
+        run: echo "REPO=ghcr.io/${{ github.repository_owner }}" >> $GITHUB_ENV
 
-      # create images
-      # - name: Build and push tornjak backend image
-      #   run: make container-tornjak-backend-spire-push
-      # Create tagged versioned images
-      # - name: Push artifacts for tornjak-backend-spire-multiversions
-      #   run: make release-tornjak-backend-spire-multiversions-ghcr
+      # build and push images tagged with GITHUB_SHA, version, and latest
       - name: Build and push tornjak backend image
-        run: make release-tornjak-backend-ghcr
+        run: make container-backend-push
       - name: Build and push tornjak frontend image
-        run: make release-tornjak-frontend-ghcr
-      - name: Build and push tornjak image
-        run: make release-tornjak-ghcr
+        run: make container-frontend-push
+      - name: Build and push tornjak image (frontend+backend)
+        run: make container-tornjak-push
       - name: Build and push tornjak manager image
-        run: make release-tornjak-manager-ghcr
+        run: make container-manager-push
       - run: echo "🍏 This job's status is ${{ job.status }}."

.gitignore

@@ -1,6 +1,9 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 .gitignore
 
+# do not ignore tornjak backend
+!tornjak-backend/
+
 # golang vendor
 vendor/
 
@@ -35,9 +38,9 @@ tornjak-manager
 # build artifacts
 bin/
 ui/
-ui-agent/
 node_modules/
-ui-manager/
+frontend-local-build/
 .idea/
 Makefile
 
+/agent

CONTRIBUTING.md

@@ -29,8 +29,8 @@ In order to build, we require the following installations:
 Building Tornjak manually can be done with the Makefile. Notable make targets follow:
 - `make bin/tornjak-backend`: makes the Go executable of the Tornjak backend
 - `make bin/tornjak-manager`: makes the Go executable of the Tornjak manager
-- `make ui-agent`: makes the optimized ReactJS app locally for the Tornjak frontend
-- `make container-tornjak-backend`: containerizes Go executable of the Tornjak backend
+- `make frontend-local-build`: makes the optimized ReactJS app locally for the Tornjak frontend. Uses environment variable configuration as in tornjak-frontend/.env
+- `make container-backend`: containerizes Go executable of the Tornjak backend
 - `make container-manager`:containerizes Go executable of the Tornjak manager
 - `make container-frontend`: containerizes React JS app for the Tornjak frontend
 - `make container-tornjak`: containerizes Tornjak backend with Tornjak frontend

Dockerfile.backend-container

@@ -11,9 +11,10 @@ COPY bin/tornjak-backend tornjak-backend
 
 # add a version link to the image description
 ARG version
+ARG github_sha
 LABEL org.opencontainers.image.description="Tornjak backend ($version): https://github.com/spiffe/tornjak/releases/tag/$version" \
       org.opencontainers.image.source="https://github.com/spiffe/tornjak" \
       org.opencontainers.image.documentation="https://github.com/spiffe/tornjak/tree/main/docs" 
 # create env. variables with the build details
 ENV VERSION=$version
-ENV GITHUB_SHA=$github_sha
+ENV GITHUB_SHA=$github_sha

Dockerfile.frontend-container

@@ -19,10 +19,9 @@ RUN npm install --location=global serve && \
 ENV PORT_FE=3000
 EXPOSE $PORT_FE
 
-ENTRYPOINT npx react-inject-env set && serve -s build -p $PORT_FE
-
 # add a version link to the image description
 ARG version
+ARG github_sha
 LABEL org.opencontainers.image.description="Tornjak frontend ($version): https://github.com/spiffe/tornjak/releases/tag/$version" \
       org.opencontainers.image.source="https://github.com/spiffe/tornjak" \
       org.opencontainers.image.documentation="https://github.com/spiffe/tornjak/tree/main/docs" 
@@ -32,4 +31,7 @@ ENV GITHUB_SHA=$github_sha
 
 RUN npm install --omit=dev \
     npm prune --production
-ENTRYPOINT npx react-inject-env set && serve -s build -p $PORT_FE
+
+# fix "access denied" error when running in restricted (read-only) env
+RUN ln -s /tmp/env.js build/env.js
+ENTRYPOINT npx react-inject-env set -n env.js && serve -s build -p $PORT_FE

Dockerfile.tornjak-container

@@ -20,6 +20,7 @@ EXPOSE $PORT_FE $PORT_BE
 
 # add a version link to the image description
 ARG version
+ARG github_sha
 LABEL org.opencontainers.image.description="Tornjak full ($version): https://github.com/spiffe/tornjak/releases/tag/$version" \
       org.opencontainers.image.source="https://github.com/spiffe/tornjak" \
       org.opencontainers.image.documentation="https://github.com/spiffe/tornjak/tree/main/docs" 
@@ -32,4 +33,4 @@ RUN mkdir -p /opt/spire
 COPY bin/tornjak-backend /opt/spire/tornjak-backend
 COPY sample-keys /opt/spire/sample-keys
 COPY run_tornjak.sh /opt/spire/run_tornjak.sh
-COPY --from=build /usr/src/app ./
+COPY --from=build /usr/src/app ./

Dockerfile.tornjak-manager

@@ -11,9 +11,10 @@ COPY bin/tornjak-manager tornjak-manager
 
 # add a version link to the image description
 ARG version
+ARG github_sha
 LABEL org.opencontainers.image.description="Tornjak manager ($version): https://github.com/spiffe/tornjak/releases/tag/$version" \
       org.opencontainers.image.source="https://github.com/spiffe/tornjak" \
       org.opencontainers.image.documentation="https://github.com/spiffe/tornjak/tree/main/docs" 
 # create env. variables with the build details
 ENV VERSION=$version
-ENV GITHUB_SHA=$github_sha
+ENV GITHUB_SHA=$github_sha

Makefile

@@ -1,146 +1,104 @@
-.PHONY: ui vendor build container-tornjak-backend-spire container-tornjak-backend-spire-push container-manager container-manager-push release-tornjak-backend-spire-multiversions push container-frontend container-frontend-push container-tornjak-backend container-tornjak-backend-push
+.PHONY: ui vendor build container-manager container-manager-push push container-frontend container-frontend-push container-backend container-backend-push
 
 VERSION=$(shell cat version.txt)
-GITHUB_SHA="$(shell git rev-parse HEAD 2>/dev/null)"
+GITHUB_SHA ?= "$(shell git rev-parse HEAD 2>/dev/null)"
 
-CONTAINER_TAG ?= tsidentity/tornjak:$(VERSION)
-CONTAINER_BACKEND_TAG ?= tsidentity/tornjak-backend:$(VERSION)
-CONTAINER_BACKEND_WITH_SPIRE_TAG ?= tsidentity/tornjak-backend-spire-server:latest
-CONTAINER_FRONTEND_TAG ?= tsidentity/tornjak-frontend:$(VERSION)
-CONTAINER_BACKEND_SPIRE_VERSION_IMAGEPATH ?= tsidentity/tornjak-backend-spire-server
+## REPO defines where to push images
+REPO ?= tsidentity
 
-CONTAINER_TORNJAK_GHCR_IMAGEPATH ?= ghcr.io/spiffe/tornjak
-CONTAINER_BACKEND_SPIRE_VERSION_GHCR_IMAGEPATH ?= ghcr.io/spiffe/tornjak-backend-spire-server
-CONTAINER_BACKEND_GHCR_IMAGEPATH ?= ghcr.io/spiffe/tornjak-backend
-CONTAINER_FRONTEND_GHCR_IMAGEPATH ?= ghcr.io/spiffe/tornjak-frontend
-CONTAINER_MANAGER_GHCR_IMAGEPATH ?= ghcr.io/spiffe/tornjak-manager
+## when containers are built, they are tagged to these container repos
+CONTAINER_TORNJAK_TAG ?= $(REPO)/tornjak
+CONTAINER_BACKEND_TAG ?= $(REPO)/tornjak-backend
+CONTAINER_FRONTEND_TAG ?= $(REPO)/tornjak-frontend
+CONTAINER_MANAGER_TAG ?= $(REPO)/tornjak-manager
+
+## `make release-*` pushes to DEV tag as well as below corresponding RELEASE tag
+## used by Github
 
-CONTAINER_MANAGER_TAG ?= tsidentity/tornjak-manager:$(VERSION)
 GO_FILES := $(shell find . -type f -name '*.go' -not -name '*_test.go' -not -path './vendor/*')
 
-all: bin/tornjak-backend bin/tornjak-manager ui-manager container-manager container-frontend container-tornjak-backend
+all: bin/tornjak-backend bin/tornjak-manager container-manager container-frontend container-backend container-tornjak
+
+#### BEGIN LOCAL EXECUTABLE BUILDS ####
 
+# build binaries for Tornjak backend (bin/tornjak-backend)
 bin/tornjak-backend: $(GO_FILES) vendor
 	# Build hack because of flake of imported go module
 	docker run --rm -v "${PWD}":/usr/src/myapp -w /usr/src/myapp -e GOOS=linux -e GOARCH=amd64 golang:1.16 /bin/sh -c "go build --tags 'sqlite_json' tornjak-backend/cmd/agent/agent.go; go build --tags 'sqlite_json' -mod=vendor -ldflags '-s -w -linkmode external -extldflags "-static"' -o bin/tornjak-backend tornjak-backend/cmd/agent/agent.go"
 
-
+# build binary for Tornjak manager backend (bin/tornjak-manager)
 bin/tornjak-manager: $(GO_FILES) vendor
 	# Build hack because of flake of imported go module
 	docker run --rm -v "${PWD}":/usr/src/myapp -w /usr/src/myapp -e GOOS=linux -e GOARCH=amd64 golang:1.16 /bin/sh -c "go build --tags 'sqlite_json' -o tornjak-manager tornjak-backend/cmd/manager/manager.go; go build --tags 'sqlite_json' -mod=vendor -ldflags '-s -w -linkmode external -extldflags "-static"' -o bin/tornjak-manager tornjak-backend/cmd/manager/manager.go"
 
-
-ui-agent:
+# build Tornjak frontend binaries
+frontend-local-build:
 	npm install --prefix tornjak-frontend
 	rm -rf tornjak-frontend/build
 	npm run build --prefix tornjak-frontend
-	rm -rf ui-agent
-	cp -r tornjak-frontend/build ui-agent
-
-
-ui-manager:
-	npm install --prefix tornjak-frontend
-	rm -rf tornjak-frontend/build
-	REACT_APP_TORNJAK_MANAGER=true npm run build --prefix tornjak-frontend
-	rm -rf ui-manager
-	cp -r tornjak-frontend/build ui-manager
-
+	rm -rf frontend-local-build
+	cp -r tornjak-frontend/build frontend-local-build
 
 vendor:
 	go mod tidy
 	go mod vendor
 
+#### END LOCAL EXECUTABLE BUILDS ####
 
-# Containerized components
-container-tornjak-backend: bin/tornjak-backend
-	docker build --no-cache -f Dockerfile.backend-container --build-arg version=$(VERSION) \
-	--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_BACKEND_TAG} .
-
-container-tornjak-backend-push: container-tornjak-backend
-	docker push ${CONTAINER_BACKEND_TAG}
 
-container-tornjak-backend-spire: bin/tornjak-backend
-	docker build --no-cache -f Dockerfile.add-backend --build-arg version=$(VERSION) \
-	--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_BACKEND_WITH_SPIRE_TAG} .
+#### BEGIN LOCAL CONTAINER IMAGE BUILD ####
+## container-* creates an image for the component
 
-container-tornjak-backend-spire-push: container-tornjak-backend-spire
-	docker push ${CONTAINER_BACKEND_WITH_SPIRE_TAG}
+container-backend: bin/tornjak-backend
+	docker build --no-cache -f Dockerfile.backend-container --build-arg version=$(VERSION) \
+		--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_BACKEND_TAG}:$(VERSION) .
 
-container-manager: bin/tornjak-manager #ui-manager
+container-manager: bin/tornjak-manager
 	docker build --no-cache -f Dockerfile.tornjak-manager --build-arg version=$(VERSION) \
-	--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_MANAGER_TAG} .
+		--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_MANAGER_TAG}:$(VERSION) .
 
-container-manager-push: container-manager
-	 docker push ${CONTAINER_MANAGER_TAG}
-
-container-frontend: #ui-agent 
+container-frontend: 
 	docker build --no-cache -f Dockerfile.frontend-container --build-arg version=$(VERSION) \
-	--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_FRONTEND_TAG} .
+		--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_FRONTEND_TAG}:$(VERSION) .
 
 compose-frontend: 
 	docker-compose -f docker-compose-frontend.yml up --build --force-recreate -d
-	docker tag tornjak-public_tornjak-frontend:latest ${CONTAINER_FRONTEND_TAG}
-
-container-frontend-push: container-frontend
-	docker push ${CONTAINER_FRONTEND_TAG}
+	docker tag tornjak-public_tornjak-frontend:latest ${CONTAINER_FRONTEND_TAG}:$(VERSION)
 
-# WARNING: EXPERIMENTAL feature to merge frontend and backend in one container
-container-tornjak: bin/tornjak-backend #ui-agent
+container-tornjak: bin/tornjak-backend
 	docker build --no-cache -f Dockerfile.tornjak-container --build-arg version=$(VERSION) \
-	--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_TAG} .
+		--build-arg github_sha=$(GITHUB_SHA) -t ${CONTAINER_TORNJAK_TAG}:$(VERSION) .
+
+#### END LOCAL CONTAINER IMAGE BUILD ####
+
+#### BEGIN PUSH ONTAINER IMAGE ####
+## container-*-push creates an image for the component and pushes to repo
+
+container-backend-push: container-backend
+	docker push ${CONTAINER_BACKEND_TAG}:$(VERSION)
+	docker tag ${CONTAINER_BACKEND_TAG}:$(VERSION) ${CONTAINER_BACKEND_TAG}:$(GITHUB_SHA)
+	docker push ${CONTAINER_BACKEND_TAG}:$(GITHUB_SHA)
+
+container-manager-push: container-manager
+	docker push ${CONTAINER_MANAGER_TAG}:$(VERSION)
+	docker tag ${CONTAINER_MANAGER_TAG}:$(VERSION) ${CONTAINER_MANAGER_TAG}:$(GITHUB_SHA)
+	docker push ${CONTAINER_MANAGER_TAG}:$(GITHUB_SHA)
+
+container-frontend-push: container-frontend
+	docker push ${CONTAINER_FRONTEND_TAG}:$(VERSION)
+	docker tag ${CONTAINER_FRONTEND_TAG}:$(VERSION) ${CONTAINER_FRONTEND_TAG}:$(GITHUB_SHA)
+	docker push ${CONTAINER_FRONTEND_TAG}:$(GITHUB_SHA)
 
 container-tornjak-push: container-tornjak
-	docker push ${CONTAINER_TAG}
-
-
-# releases for Github Container Registry
-release-tornjak-backend-ghcr: container-tornjak-backend
-	docker tag ${CONTAINER_BACKEND_TAG} ${CONTAINER_BACKEND_GHCR_IMAGEPATH}:latest
-	docker tag ${CONTAINER_BACKEND_TAG} ${CONTAINER_BACKEND_GHCR_IMAGEPATH}:$(VERSION)
-	docker push ${CONTAINER_BACKEND_TAG}
-	docker push ${CONTAINER_BACKEND_GHCR_IMAGEPATH}:latest
-	docker push ${CONTAINER_BACKEND_GHCR_IMAGEPATH}:${VERSION}
-
-release-tornjak-backend-spire-multiversions: bin/tornjak-backend
-	for i in $(shell cat SPIRE_BUILD_VERSIONS); do \
-		./build-and-push-versioned-container.sh $$i ${CONTAINER_BACKEND_SPIRE_VERSION_IMAGEPATH}; \
-	done
-
-release-tornjak-backend-spire-multiversions-ghcr: bin/tornjak-backend
-	for i in $(shell cat SPIRE_BUILD_VERSIONS); do \
-		./build-and-push-versioned-container.sh $$i ${CONTAINER_BACKEND_SPIRE_VERSION_GHCR_IMAGEPATH}; \
-	done
-
-release-tornjak-frontend-ghcr: container-frontend
-	docker tag ${CONTAINER_FRONTEND_TAG} ${CONTAINER_FRONTEND_GHCR_IMAGEPATH}:latest
-	docker tag ${CONTAINER_FRONTEND_TAG} ${CONTAINER_FRONTEND_GHCR_IMAGEPATH}:$(VERSION)
-	docker push ${CONTAINER_FRONTEND_TAG}
-	docker push ${CONTAINER_FRONTEND_GHCR_IMAGEPATH}:latest
-	docker push ${CONTAINER_FRONTEND_GHCR_IMAGEPATH}:$(VERSION)
-
-# PLACEHOLDER FOR TORNJAK IMAGE WITH BE AND FE
-release-tornjak-ghcr: container-tornjak
-	docker tag ${CONTAINER_TAG} ${CONTAINER_TORNJAK_GHCR_IMAGEPATH}:latest
-	docker tag ${CONTAINER_TAG} ${CONTAINER_TORNJAK_GHCR_IMAGEPATH}:$(VERSION)
-	docker push ${CONTAINER_TAG}
-	docker push ${CONTAINER_TORNJAK_GHCR_IMAGEPATH}:latest
-	docker push ${CONTAINER_TORNJAK_GHCR_IMAGEPATH}:$(VERSION)
-
-release-tornjak-manager-ghcr: container-manager
-	docker tag ${CONTAINER_MANAGER_TAG} ${CONTAINER_MANAGER_GHCR_IMAGEPATH}:latest
-	docker tag ${CONTAINER_MANAGER_TAG} ${CONTAINER_MANAGER_GHCR_IMAGEPATH}:$(VERSION)
-	docker push ${CONTAINER_MANAGER_TAG}
-	docker push ${CONTAINER_MANAGER_GHCR_IMAGEPATH}:latest
-	docker push ${CONTAINER_MANAGER_GHCR_IMAGEPATH}:$(VERSION)
+	docker push ${CONTAINER_TORNJAK_TAG}:$(VERSION)
+	docker tag ${CONTAINER_TORNJAK_TAG}:$(VERSION) ${CONTAINER_TORNJAK_TAG}:$(GITHUB_SHA)
+	docker push ${CONTAINER_TORNJAK_TAG}:$(GITHUB_SHA)
+
+dev-push: container-backend-push container-manager-push container-frontend-push container-tornjak-push
+#### END PUSH CONTAINER IMAGE ####
 
 clean:
 	rm -rf bin/
 	rm -rf tornjak-frontend/build
-	rm -rf ui-agent/
-	rm -rf ui-manager/
-
-push:
-	docker push ${CONTAINER_BACKEND_WITH_SPIRE_TAG}
-	docker push ${CONTAINER_MANAGER_TAG}
-	docker push ${CONTAINER_BACKEND_TAG}
-	docker push ${CONTAINER_FRONTEND_TAG}
+	rm -rf frontend-local-build/
+