LCORE-302: User Data Collection

.github/workflows/build_and_push_dev.yaml

@@ -0,0 +1,61 @@
+name: Build image, main branch push quay.io
+
+on:
+  push:
+    branches: [ main ]
+
+env:
+  IMAGE_NAME: lightspeed-stack
+  IMAGE_NAMESPACE: lightspeed-core
+  IMAGE_REGISTRY: quay.io
+  LATEST_TAG: dev-latest
+  CONTAINER_FILE: Containerfile
+
+jobs:
+  build-and-push-dev:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      # Required for image pushing to a registry
+      packages: write
+    steps:
+      - name: Install buildah
+        run: |
+          sudo apt update
+          # qemu is required for arm64 builds
+          sudo apt install -y buildah qemu-user-static
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Create dev image tag
+        run: |
+          echo "DEV_TAG=dev-$(date +%Y%m%d)-$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+          echo "dev image tag: ${{ env.DEV_TAG }}"
+      - name: Build image with Buildah
+        id: build_image
+        uses: redhat-actions/buildah-build@v2
+        with:
+          image: ${{ env.IMAGE_NAME }}
+          tags: |
+            ${{ env.DEV_TAG }}
+            ${{ env.LATEST_TAG }}
+          containerfiles: |
+            ${{ env.CONTAINER_FILE }}
+          archs: amd64, arm64
+          oci: true
+      - name: Check images
+        run: |
+          buildah images | grep '${{ env.IMAGE_NAME }}'
+          echo '${{ steps.build_image.outputs.image }}'
+          echo '${{ steps.build_image.outputs.tags }}'
+      - name: Check manifest
+        run: |
+          set -x
+          buildah manifest inspect ${{ steps.build_image.outputs.image }}:${{ env.LATEST_TAG }}
+      - name: Push image to Quay.io
+        uses: redhat-actions/push-to-registry@v2
+        with:
+          image: ${{ steps.build_image.outputs.image }}
+          tags: ${{ steps.build_image.outputs.tags }}
+          registry: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAMESPACE }}
+          username: ${{ secrets.QUAY_REGISTRY_USERNAME }}
+          password: ${{ secrets.QUAY_REGISTRY_PASSWORD }}

.github/workflows/build_and_push_release.yaml

@@ -24,7 +24,8 @@ jobs:
       - name: Install buildah
         run: |
           sudo apt update
-          sudo apt install -y buildah
+          # qemu is required for arm64 builds
+          sudo apt install -y buildah qemu-user-static
       - name: Checkout code
         uses: actions/checkout@v4
       - name: Build image with Buildah
@@ -37,7 +38,17 @@ jobs:
             ${{ env.LATEST_TAG }}
           containerfiles: |
             ${{ env.CONTAINER_FILE }}
+          archs: amd64, arm64
           oci: true
+      - name: Check images
+        run: |
+          buildah images | grep '${{ env.IMAGE_NAME }}'
+          echo '${{ steps.build_image.outputs.image }}'
+          echo '${{ steps.build_image.outputs.tags }}'
+      - name: Check manifest
+        run: |
+          set -x
+          buildah manifest inspect ${{ steps.build_image.outputs.image }}:${{ env.LATEST_TAG }}
       - name: Push image to Quay.io
         uses: redhat-actions/push-to-registry@v2
         with:

.github/workflows/build_pr.yaml

@@ -0,0 +1,46 @@
+name: Check image building
+
+on:
+  - pull_request
+
+env:
+  IMAGE_NAME: lightspeed-stack
+  IMAGE_NAMESPACE: lightspeed-core
+  LATEST_TAG: dev-latest
+  CONTAINER_FILE: Containerfile
+
+jobs:
+  build-pr:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      # Required for image pushing to a registry
+      packages: write
+    steps:
+      - name: Install qemu and buildah
+        run: |
+          sudo apt update
+          # qemu is required for arm64 builds
+          sudo apt install -y buildah qemu-user-static
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Build image with Buildah
+        id: build_image
+        uses: redhat-actions/buildah-build@v2
+        with:
+          image: ${{ env.IMAGE_NAME }}
+          tags: |
+            ${{ env.LATEST_TAG }}
+          containerfiles: |
+            ${{ env.CONTAINER_FILE }}
+          archs: amd64, arm64
+          oci: true
+      - name: Check images
+        run: |
+          buildah images | grep '${{ env.IMAGE_NAME }}'
+          echo '${{ steps.build_image.outputs.image }}'
+          echo '${{ steps.build_image.outputs.tags }}'
+      - name: Check manifest
+        run: |
+          set -x
+          buildah manifest inspect ${{ steps.build_image.outputs.image }}:${{ env.LATEST_TAG }}

Containerfile

@@ -51,7 +51,7 @@ ENV PATH="/app-root/.venv/bin:$PATH"
 
 # Run the application
 EXPOSE 8080
-CMD ["python3.12", "src/lightspeed_stack.py"]
+ENTRYPOINT ["python3.12", "src/lightspeed_stack.py"]
 
 LABEL vendor="Red Hat, Inc."
 

Makefile

@@ -1,10 +1,16 @@
 ARTIFACT_DIR := $(if $(ARTIFACT_DIR),$(ARTIFACT_DIR),tests/test_results)
 PATH_TO_PLANTUML := ~/bin
 
+# Python registry to where the package should be uploaded
+PYTHON_REGISTRY = pypi
+
 
 run: ## Run the service locally
 	uv run src/lightspeed_stack.py
 
+run-data-collector: ## Run the data collector service locally
+	uv run src/lightspeed_stack.py --data-collector
+
 test-unit: ## Run the unit tests
 	@echo "Running unit tests..."
 	@echo "Reports will be written to ${ARTIFACT_DIR}"
@@ -60,19 +66,26 @@ pyright:
 	uv run pyright src
 
 docstyle:
-	uv run pydocstyle -v .
+	uv run pydocstyle -v src
 
 ruff:
 	uv run ruff check . --per-file-ignores=tests/*:S101 --per-file-ignores=scripts/*:S101
 
-verify:
+verify: ## Run all linters
 	$(MAKE) black
 	$(MAKE) pylint
 	$(MAKE) pyright
 	$(MAKE) ruff
 	$(MAKE) docstyle
 	$(MAKE) check-types
 
+distribution-archives: ## Generate distribution archives to be uploaded into Python registry
+	rm -rf dist
+	pdm run python -m build
+
+upload-distribution-archives: ## Upload distribution archives into Python registry
+	pdm run python -m twine upload --repository ${PYTHON_REGISTRY} dist/*
+
 help: ## Show this help screen
 	@echo 'Usage: make <OPTIONS> ... <TARGETS>'
 	@echo ''