#37 Docker for Calypso

.github/workflows/calypso-build.yml

@@ -0,0 +1,58 @@
+#
+name: Create and publish Calypso docker image
+
+on:
+  push:
+    branches: ['Develop']
+    path:
+        - "Dockerfile"
+  workflow_dispatch:
+
+# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+      #
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/[email protected]
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
+      - name: Log in to the Container registry
+        uses: docker/[email protected]
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/[email protected]
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
+      # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
+      # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
+      - name: Build and push Docker image for Calypso
+        uses: docker/[email protected]
+        with:
+          context: ./
+          push: true
+          platforms: linux/arm64,linux/amd64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          # for caching
+          # cache-from: type=gha
+          # cache-to: type=gha,mode=max
+          # https://github.com/docker/build-push-action/issues/820
+          provenance: false

Dockerfile

@@ -0,0 +1,19 @@
+FROM rust AS builder
+
+WORKDIR /usr/src/calypso
+COPY . .
+
+RUN git submodule update --init
+RUN apt-get update && apt-get install -y libssl-dev build-essential cmake 
+RUN cargo install --path .
+
+FROM debian:bookworm-slim
+RUN apt update
+RUN apt install openssl -y
+
+COPY --from=builder /usr/local/cargo/bin/calypso /usr/local/bin/calypso
+COPY --from=builder /usr/local/cargo/bin/simulate /usr/local/bin/simulate
+
+CMD ["simulate"]
+
+# START WITH: sudo docker run -d --rm  --network host calypso

README.md

@@ -40,10 +40,16 @@ Now view calypso interpret the can message and broadcast it on `mqttui`
 
 
 ### Simulation Mode
+#### Run from build
 - Same setup as above, then use the entry point `simulate` instead of `main`
 - ```cargo run --bin simulate```
 - ```cargo run --bin simulate  -- -u localhost:1883```
 
+#### Run from Docker
+- ```docker pull ghcr.io/northeastern-electric-racing/calypso:Develop```
+- ```docker run -d --rm --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
+- ```docker run -d --rm -e CALYPSO_SIREN_HOST_URL=127.0.0.1:1883 --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
+
 
 
 ### Generate Proto