Updates after testing local Docker image build

Author: zhuber21

.github/workflows/main.yml

@@ -0,0 +1,70 @@
+name: Docker Image Generation
+
+on:
+  # Triggers the workflow on push or pull request events for specific branches
+  push:
+    branches: [ dockerize ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+        # Fetch all history for all tags and branches
+        with:
+          fetch-depth: 0
+
+      - name: checkout rfsoc-streamer
+        uses: actions/checkout@v3
+        with:
+          repository: ccatobs/rfsoc-streamer
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Set up Docker Buildx
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      # Add Docker layer caching
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          builder: ${{ steps.buildx.outputs.name }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
+
+      # Temp fix for cache size growth
+      - name: Move cache
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+

CMakeLists.txt

@@ -58,7 +58,7 @@ include_directories(${SPT3G_DIR}/core/src)
 include_directories(${SO3G_DIR}/include)
 include_directories(/usr/include/python3.10)
 include_directories(${PROJECT_SOURCE_DIR}/include/)  # rfsoc-streamer/include
-include_directories(/usr/local/lib/python3.10/dist-packages/numpy/core/include/)
+include_directories(/opt/venv/lib/python3.10/site-packages/numpy/core/include)
 
 # Create rfsoc python library
 set(SRC_FILES ${PROJECT_SOURCE_DIR}/src/RfsocBuilder.cxx ${PROJECT_SOURCE_DIR}/src/RfsocTransmitter.cxx ${PROJECT_SOURCE_DIR}/src/python.cpp)

Dockerfile

@@ -10,23 +10,33 @@ RUN apt-get update && apt-get install -y gcc \
 # Workaround for build issue with so3g needing specifically the 'python' executable
 RUN ln -s /usr/bin/python3.10 /usr/bin/python
 
+# Create streamer user and group
+RUN groupadd -g 9003 streamer && \
+    useradd -m -l -u 9003 -g 9003 streamer
+
+# Setting up virtual environment
+RUN python3 -m venv /opt/venv/
+ENV PATH="/opt/venv/bin:$PATH"
+RUN python3 -m pip install -U pip
+
 # Guaranteeing that there will be a common build directory for socs/spt3g
 WORKDIR /usr/local/so3g
 WORKDIR /usr/local/src
 
-ENV SO3G_DIR /usr/local/src/so3g
-ENV SPT3G_DIR /usr/local/src/spt3g_software
-ENV SPT3G_SOFTWARE_PATH /usr/local/src/spt3g_software
-ENV RFSOC_DIR /usr/local/src/rfsoc-streamer
-ENV LD_LIBRARY_PATH /usr/local/so3g/lib:/usr/local/so3g/so3g
-ENV STREAM_CONFIG_DIR /config
-ENV SPT3G_SOFTWARE_BUILD_PATH ${SPT3G_DIR}/build
-ENV SO3G_BUILD_PATH /usr/local/so3g/lib
+ENV SO3G_DIR=/usr/local/src/so3g
+ENV SPT3G_DIR=/usr/local/src/spt3g_software
+ENV SPT3G_SOFTWARE_PATH=/usr/local/src/spt3g_software
+ENV RFSOC_DIR=/usr/local/src/rfsoc-streamer
+ENV LD_LIBRARY_PATH=/usr/local/so3g/lib:/usr/local/so3g/so3g
+ENV STREAM_CONFIG_DIR=/config
+ENV SPT3G_SOFTWARE_BUILD_PATH=${SPT3G_DIR}/build
+ENV SO3G_BUILD_PATH=/usr/local/so3g/lib
 
 # Clone all repos
 RUN git clone https://github.com/CMB-S4/spt3g_software.git
 RUN git clone https://github.com/simonsobs/so3g.git
-RUN git clone https://github.com/ccatobs/rfsoc-streamer.git
+#RUN git clone https://github.com/ccatobs/rfsoc-streamer.git
+COPY . /usr/local/src/rfsoc-streamer
 
 # Install spt3g
 WORKDIR /usr/local/src/spt3g_software/build
@@ -47,7 +57,7 @@ RUN make install
 
 # Install so3g
 WORKDIR /usr/local/src/so3g
-RUN pip3 install -r requirements.txt
+RUN pip install -r requirements.txt
 WORKDIR /usr/local/src/so3g/build
 
 # Seems to have a bug with finding cmake here...hash -r fixes it
@@ -65,13 +75,14 @@ RUN make install
 
 # Install rfsoc-streamer
 WORKDIR /usr/local/src/rfsoc-streamer
-RUN CMAKE .
-RUN MAKE
+RUN cmake .
+RUN make
 
-export PYTHONPATH="${RFSOC_DIR}/lib:${RFSOC_DIR}/python:$SPT3G_SOFTWARE_BUILD_PATH:$SO3G_BUILD_PATH:$PYTHONPATH"
-export PATH="/usr/local/so3g/bin:${PATH}"
+# There is no PYTHONPATH to start, so no need to append it to the end here
+ENV PYTHONPATH="${RFSOC_DIR}/lib:${RFSOC_DIR}/python:$SPT3G_SOFTWARE_BUILD_PATH:$SO3G_BUILD_PATH"
+ENV PATH="/usr/local/so3g/bin:${PATH}"
 
-RUN pip3 install dumb-init
+RUN pip install dumb-init
 
 # The command to run stream.py will be in the docker-compose.yml file
 # for more granular user control

test/stream_config.yaml

@@ -1,5 +1,5 @@
-g3_dir: /home/streamer/data/g3/ # path to top level detector file directory
-file_rotation_time: 600 #60*10  # time before rotating files in seconds
+g3_dir: /data/g3/ # path to top level detector file directory
+file_rotation_time: 60 #60*10  # time before rotating files in seconds
 
 # Board and drone specific settings for all active RFSoCs
 # stream IDs must have format rfsoc##_drone# - this is parsed to use in filenames