From aa6c24541ff79d784d4e2810a5daf3d12c454a2d Mon Sep 17 00:00:00 2001 From: Zach Garcia Date: Mon, 16 Sep 2024 09:56:36 -0400 Subject: [PATCH] Dockerize Fill Station Binary --- .bazelversion | 1 + .github/workflows/bazel.yml | 29 -------- .../workflows/fill_station_build_and_push.yml | 69 +++++++++++++++++++ .github/workflows/fill_station_test.yml | 32 +++++++++ ...d.yml => ground_server_build_and_push.yml} | 2 +- .gitignore | 2 +- README.md | 24 ++++++- fill/Dockerfile | 29 ++++++++ 8 files changed, 155 insertions(+), 33 deletions(-) create mode 100644 .bazelversion delete mode 100644 .github/workflows/bazel.yml create mode 100644 .github/workflows/fill_station_build_and_push.yml create mode 100644 .github/workflows/fill_station_test.yml rename .github/workflows/{build.yml => ground_server_build_and_push.yml} (98%) create mode 100644 fill/Dockerfile diff --git a/.bazelversion b/.bazelversion new file mode 100644 index 0000000..34a8f74 --- /dev/null +++ b/.bazelversion @@ -0,0 +1 @@ +7.3.1 \ No newline at end of file diff --git a/.github/workflows/bazel.yml b/.github/workflows/bazel.yml deleted file mode 100644 index 67706f3..0000000 --- a/.github/workflows/bazel.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Bazel - -on: [push, pull_request] - -jobs: - setup-bazel: - runs-on: ubuntu-22.04 - steps: - - name: Run setup-bazel - uses: bazel-contrib/setup-bazel@0.8.5 - with: - # Avoid downloading Bazel every time. - bazelisk-cache: true - # Store build cache per workflow. - disk-cache: ${{ github.workflow }} - # Share repository cache between workflows. - repository-cache: true - - # Checks-out your repository under $GITHUB_WORKSPACE, which is the CWD for - # the rest of the steps - - uses: actions/checkout@v2 - - # build - - name: Build the code - run: bazel build //... - - # test - - name: Test the code - run: bazel test //... diff --git a/.github/workflows/fill_station_build_and_push.yml b/.github/workflows/fill_station_build_and_push.yml new file mode 100644 index 0000000..edd8883 --- /dev/null +++ b/.github/workflows/fill_station_build_and_push.yml @@ -0,0 +1,69 @@ +name: Create and publish the Fill Station Docker image + +# Configures this workflow to run every time a change is pushed to the branch called `main` or a pull request to `main` is created +on: + push: + branches: ['main'] + pull_request: + branches: ['main'] + +# 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_owner }}/fill-station + +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 + attestations: write + id-token: write + + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, which is the CWD for + # the rest of the steps + - 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/login-action@v3 + 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/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=raw,value=latest,enable={{is_default_branch}} + type=ref,event=branch + type=ref,event=pr + + # 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 Fill Station Docker image + id: push + uses: docker/build-push-action@v5 + with: + context: . + file: fill/Dockerfile + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + + # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." + - name: Generate artifact attestation + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}} + subject-digest: ${{ steps.push.outputs.digest }} + push-to-registry: true \ No newline at end of file diff --git a/.github/workflows/fill_station_test.yml b/.github/workflows/fill_station_test.yml new file mode 100644 index 0000000..c999faf --- /dev/null +++ b/.github/workflows/fill_station_test.yml @@ -0,0 +1,32 @@ +name: Build and Test the Fill Station Code with Bazel + +# Configures this workflow to run every time a change is pushed to the branch called `main` or a pull request to `main` is created +on: + push: + branches: ['main'] + pull_request: + branches: ['main'] + +# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. +jobs: + build-and-test: + runs-on: ubuntu-latest + + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, which is the CWD for + # the rest of the steps + - name: Checkout code + uses: actions/checkout@v4 + + - uses: bazel-contrib/setup-bazel@0.8.5 + with: + # Avoid downloading Bazel every time. + bazelisk-cache: true + # Store build cache per workflow. + disk-cache: ${{ github.workflow }} + # Share repository cache between workflows. + repository-cache: true + + # test + - name: Build and Test with Bazel + run: bazel test //fill:all diff --git a/.github/workflows/build.yml b/.github/workflows/ground_server_build_and_push.yml similarity index 98% rename from .github/workflows/build.yml rename to .github/workflows/ground_server_build_and_push.yml index e6a1690..9ad7e4e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/ground_server_build_and_push.yml @@ -1,4 +1,4 @@ -name: Create and publish the Ground Station Docker image +name: Create and publish the Ground Server Docker image # Configures this workflow to run every time a change is pushed to the branch called `main` or a pull request to `main` is created on: diff --git a/.gitignore b/.gitignore index a3f0a16..687c23a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ - +# New change # Bazel files bazel-* bazel_format_virtual_environment/ diff --git a/README.md b/README.md index 99a4f09..5e7c7c5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Ground-Software Ground Support Equipment Software for the Cornell Rocketry Team including fill station and ground server -## Ground Server +## Ground Server Docker Image First, install Docker for your specific computer. Then, to start the ground server run: ```shell @@ -9,6 +9,26 @@ docker pull ghcr.io/cornellrocketryteam/ground-server docker run -it -d -p 80:80 ghcr.io/cornellrocketryteam/ground-server ``` +If you want to build the docker image locally, navigate to the root directory then build: +```shell +cd Ground-Software/ground-server +docker build -t ground-server . +``` + +## Fill Station Docker Image + +First, install Docker for your specific computer. Then, to start the ground server run: +```shell +docker pull ghcr.io/cornellrocketryteam/fill-station +docker run -it -d --network="host" ghcr.io/cornellrocketryteam/fill-station +``` + +If you want to build the docker image locally, navigate to the root directory then build: +```shell +cd Ground-Software +docker build -t fill-station -f ./fill/Dockerfile . +``` + ## Fix and Format Bazel files Buildifier will fix a lot and format all bazel files by running @@ -20,7 +40,7 @@ FOR x86 LINUX OR WSL (NOT RASPBERRY PI) ```sudo apt install bazel``` -2. Check version (tested with version 7.1.1): +2. Check version (tested with version 7.3.1): ```bazel --version``` diff --git a/fill/Dockerfile b/fill/Dockerfile new file mode 100644 index 0000000..2e7daea --- /dev/null +++ b/fill/Dockerfile @@ -0,0 +1,29 @@ +# Stage 1: Build +FROM golang AS build + +# Install Bazelisk +RUN go install github.com/bazelbuild/bazelisk@latest + +# Set the working directory +WORKDIR /app + +# Copy the source code +COPY . . + +# Build the project using Bazelisk (via Bazel) +RUN bazelisk build //fill:all + +# Stage 2: Create lightweight runtime image +FROM ubuntu + +# Set the working directory +WORKDIR /app + +# Copy the build output from the GitHub Workflow to Alpine +COPY --from=build /app/bazel-bin/fill/fill_station ./fill_station + +# Expose the gRPC Server Port +EXPOSE 50051 + +# Run the binary +CMD [ "/app/fill_station" ]