Add podman support

.github/workflows/ci.yaml

@@ -15,24 +15,24 @@ jobs:
           EOF
 
       - name: Check out repository code
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       - name: Install Golang
-        uses: actions/setup-go@v4.0.1
+        uses: actions/setup-go@v5.0.0
         with:
           go-version-file: go.mod
           check-latest: true
           cache: true
 
-      - uses: actions/setup-node@v3.7.0
+      - uses: actions/setup-node@v4.0.0
         with:
           node-version: '18'
 
       - name: Download modules
         run: go mod download
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3.6.0
+        uses: golangci/golangci-lint-action@v3.7.0
         with:
           version: v1.53
           args: --timeout 7m

.github/workflows/master-build.yaml

@@ -3,7 +3,7 @@ on:
   push:
     branches:
     - main
-    - v1.4
+    - v1.5
 jobs:
   tornjak-build:
     runs-on: ubuntu-latest
@@ -19,10 +19,10 @@ jobs:
           EOF
 
       - name: Check out repository code
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       - name: Install Golang
-        uses: actions/setup-go@v4.0.1
+        uses: actions/setup-go@v5.0.0
         with:
           go-version-file: go.mod
           check-latest: true
@@ -31,21 +31,21 @@ jobs:
       - name: Download modules
         run: go mod download
 
-      - uses: actions/setup-node@v3.7.0
+      - uses: actions/setup-node@v4.0.0
         with:
           node-version: '18'
 
       - name: Download modules
         run: go mod download
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3.6.0
+        uses: golangci/golangci-lint-action@v3.7.0
         with:
           version: v1.53
           args: --timeout 7m
 
       - name: Log in to GHCR.io
-        uses: docker/login-action@v2.2.0
+        uses: docker/login-action@v3.0.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
@@ -59,17 +59,19 @@ jobs:
         run: echo "REPO=ghcr.io/${{ github.repository_owner }}" >> $GITHUB_ENV
 
       # build and push images tagged with GITHUB_SHA, version, and latest
-      - name: Build and push tornjak backend image
-        run: make release-tornjak-backend
+      - name: Build and push tornjak images
+        run: make release-images
 
-      - name: Build and push tornjak frontend image
-        run: make release-tornjak-frontend
+      # build and push UBI images
+      - name: Add ubi prefix
+        run: echo "IMAGE_TAG_PREFIX=ubi-" >> $GITHUB_ENV
+      - name: Set frontend Dockerfile
+        run: echo "DOCKERFILE_FRONTEND=frontend/Dockerfile.frontend-container.ubi" >> $GITHUB_ENV
+      - name: Set backend Dockerfile
+        run: echo "DOCKERFILE_BACKEND=Dockerfile.backend-container.ubi" >> $GITHUB_ENV
 
-      - name: Build and push tornjak image (frontend+backend)
-        run: make release-tornjak
-
-      - name: Build and push tornjak manager image
-        run: make release-tornjak-manager
+      - name: Build and push UBI images
+        run: make release-images
 
       - name: Print job result
         run: |

.gitignore

@@ -8,15 +8,15 @@
 vendor
 
 # dependencies
-tornjak-frontend/node_modules
-tornjak-frontend/.pnp
-tornjak-frontend/.pnp.js
+frontend/node_modules
+frontend/.pnp
+frontend/.pnp.js
 
 # testing
-tornjak-frontend/coverage
+frontend/coverage
 
 # production
-tornjak-frontend/build
+frontend/build
 
 # misc
 .DS_Store

CONTRIBUTING.md

@@ -20,32 +20,49 @@ Otherwise, you can follow instructions below to build Tornjak images.
 ## Build Requirements
 
 In order to build, we require the following installations:
-- [Docker](https://docs.docker.com/engine/install/) for the backend build
+
+- [docker](https://docs.docker.com/engine/install/) or [podman](https://podman.io/) for the backend build
 - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for the frontend build if running locally
 - [Golang](https://go.dev/doc/install) is required if you would like to run the Go backends locally
 
 ## Building Executables and Images
 
+When using `podman` please extend the default resources in order to successfully build 
+Tornjak images.
+
+```console
+podman machine init
+podman machine set --cpus 4 --memory 4096
+podman machine start
+```
+
 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 frontend-local-build`: makes the optimized ReactJS app locally for the Tornjak frontend. Uses environment variable configuration as in tornjak-frontend/.env
-- `make image-tornjak-backend`: containerizes Go executable of the Tornjak backend
-- `make image-tornjak-manager`:containerizes Go executable of the Tornjak manager
-- `make image-tornjak-frontend`: containerizes React JS app for the Tornjak frontend
-- `make image-tornjak`: containerizes Tornjak backend with Tornjak frontend
+- `make image-tornjak-backend`: builds image for the Tornjak backend
+- `make image-tornjak-manager`: builds image for the Tornjak manager
+- `make image-tornjak-frontend`: builds image for the Tornjak frontend
+- `make images`: builds all the above images
+- `make compose-frontend`: runs the Tornjak frontend using Docker or Podman compose
+- `make release-tornjak-backend`: publish the Tornjak backend image
+- `make release-tornjak-frontend`: publish the Tornjak frontend image
+- `make release-tornjak-manager`: publish the Tornjak manager image
+- `make release-images`: publish all the above images
 
 For usage instructions of the containers, please see our [USAGE document](./USAGE.md) to get started.
 
 ## Development
 
-We welcome all development attempst and contributions from the community. The easiest place to start is by reviewing our code architecture diagrams available in our [api documentation](./docs/tornjak-ui-api-documentation.md#11-overview).
+We welcome all development attempts and contributions from the community. The easiest place to start is by reviewing our code architecture diagrams available in our [api documentation](./docs/tornjak-ui-api-documentation.md#11-overview).
 
 ## Local testing
 
 We highly recommend starting with our [quickstart tutorial](docs/quickstart/README.md), using official images and preset configs before development. This tutorial creates a local instance of SPIRE on Minikube, adds Tornjak server, and runs a UI. 
 
 Additionally, one may test out several other features including the following:
+
 - [Running the Frontend Locally](#running-the-frontend-locally)
 - [Running the Backend Locally](#running-the-backend-locally)
 - [Running the Tornjak Manager Locally](#running-the-tornjak-manager)
@@ -79,15 +96,15 @@ Note, the above command will print out usage documentation for the server. Pleas
 
 You may run the uncontainerized Tornjak manager by locally running the following:
 
-```
+```console
 go run tornjak-backend/cmd/manager/manager.go
 ```
 
 which starts listening on port 50000.
 
 To start the manager UI, run:
 
-```
+```console
 REACT_APP_API_SERVER_URI=http://localhost:50000/
 REACT_APP_TORNJAK_MANAGER=true npm start
 ```

Dockerfile.backend-container

@@ -5,15 +5,32 @@ WORKDIR /opt/spire
 ENTRYPOINT ["/opt/spire/run_backend.sh"]
 
 # Add init
-COPY run_backend.sh run_backend.sh
+COPY scripts/run_backend.sh run_backend.sh
 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" \
+LABEL org.opencontainers.image.description="Tornjak backend ($version) Alpine based image: 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" 
+      org.opencontainers.image.documentation="https://github.com/spiffe/tornjak/tree/main/docs"
+
+# Additional labels
+LABEL architecture="amd64" \
+      build-date="" \
+      description="Tornjak Backend" \ 
+      io.k8s.description="Tornjak Backend" \
+      io.k8s.display-name="tornjak-backend" \
+      maintainer="" \
+      name="spiffe/tornjak-backend" \
+      release="$version" \
+      summary="Tornjak backend image" \
+      url="" \
+      vcs-ref="" \
+      vcs-type="" \
+      vendor="" \
+      version="$version"
+
 # create env. variables with the build details
 ENV VERSION=$version
 ENV GITHUB_SHA=$github_sha

Dockerfile.backend-container.ubi

@@ -0,0 +1,35 @@
+FROM registry.access.redhat.com/ubi8-micro:latest
+RUN mkdir -p /opt/spire
+
+WORKDIR /opt/spire
+ENTRYPOINT ["/opt/spire/run_backend.sh"]
+
+# Add init
+COPY scripts/run_backend.sh run_backend.sh
+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) UBI based image: 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"
+# replace UBI labels
+LABEL architecture="amd64" \
+      build-date="" \
+      description="Tornjak Backend" \ 
+      io.k8s.description="Tornjak Backend" \
+      io.k8s.display-name="tornjak-backend" \
+      maintainer="" \
+      name="spiffe/tornjak-backend" \
+      release="$version" \
+      summary="Tornjak backend UBI image" \
+      url="" \
+      vcs-ref="" \
+      vcs-type="" \
+      vendor="" \
+      version="$version"
+
+# create env. variables with the build details
+ENV VERSION=$version
+ENV GITHUB_SHA=$github_sha