diff --git a/.github/workflows/deploy_docker.yaml b/.github/workflows/deploy_docker.yaml new file mode 100644 index 0000000..a1e6dee --- /dev/null +++ b/.github/workflows/deploy_docker.yaml @@ -0,0 +1,49 @@ +# +name: Create and publish a Docker image + +# Configures this workflow to run every time a change is pushed to the branch called `release`. +on: + push: + 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 }} + +# 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: 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.2.0 + 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.5.1 + 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 + uses: docker/build-push-action@v4 + with: + context: deployment/Dockerfile + file: Dockerfile + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file diff --git a/deployment/Dockerfile b/deployment/Dockerfile new file mode 100644 index 0000000..5710a9e --- /dev/null +++ b/deployment/Dockerfile @@ -0,0 +1,20 @@ +FROM mambaorg/micromamba:latest + + +# prevent buffering of output which can cause missed logs +ENV PYTHONUNBUFFERED=1 + +COPY --chown=$MAMBA_USER:$MAMBA_USER . /home/mambauser/lw-reg + +WORKDIR /home/mambauser/lw-reg + +COPY --chown=$MAMBA_USER:$MAMBA_USER environment.yml /tmp/env.yaml + +RUN micromamba install -y -n base -f /tmp/env.yaml && \ + micromamba clean --all --yes + +ARG MAMBA_DOCKERFILE_ACTIVATE=1 + + +RUN pip install . +RUN lwreg greet \ No newline at end of file diff --git a/deployment/README.md b/deployment/README.md new file mode 100644 index 0000000..e0480b5 --- /dev/null +++ b/deployment/README.md @@ -0,0 +1,16 @@ +# Deployment + +The Dockerfile in this repository can be used to create a production-ready image of the application. +The image can be built using the following command: + +```bash +cd deployment +docker build -t . +``` +or a prebuilt one can be pulled from ghcr.io: + +```bash +docker pull ghcr.io/rinikerlab/lightweight-registration:main +``` + +