From 2d1191c51154b8c8ebb10f3f289bc9b81ef783e2 Mon Sep 17 00:00:00 2001 From: Moriz Wahl Date: Mon, 4 Dec 2023 16:00:14 +0100 Subject: [PATCH] add Dockerfiles, produciton not working (tsc not found) --- Dockerfile | 97 +++++++++++++++++++++++++++++++++++++ docker-compose.override.yml | 24 +++++++++ docker-compose.yml | 33 +++++++++++++ 3 files changed, 154 insertions(+) create mode 100644 Dockerfile create mode 100644 docker-compose.override.yml create mode 100644 docker-compose.yml diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ae98ece --- /dev/null +++ b/Dockerfile @@ -0,0 +1,97 @@ +FROM node:21-alpine3.17 as base + +# ENVs (available in production aswell, can be overwritten by commandline or env file) +## DOCKER_WORKDIR would be a classical ARG, but that is not multi layer persistent - shame +ENV DOCKER_WORKDIR="/server" +## We Cannot do `$(date -u +'%Y-%m-%dT%H:%M:%SZ')` here so we use unix timestamp=0 +ENV BUILD_DATE="1970-01-01T00:00:00.00Z" +## We cannot do $(npm run version).${BUILD_NUMBER} here so we default to 0.0.0.0 +ENV BUILD_VERSION="0.0.0.0" +## We cannot do `$(git rev-parse --short HEAD)` here so we default to 0000000 +ENV BUILD_COMMIT="0000000" +## SET NODE_ENV +ENV NODE_ENV="production" +## App relevant Envs +ENV PORT="4000" + +# Labels +LABEL org.label-schema.build-date="${BUILD_DATE}" +LABEL org.label-schema.name="it4c:backend" +LABEL org.label-schema.description="IT4C Backend Boilerplate" +LABEL org.label-schema.usage="https://github.com/IT4Change/boilerplate-backend/blob/master/README.md" +LABEL org.label-schema.url="https://github.com/IT4Change/boilerplate-backend" +LABEL org.label-schema.vcs-url="https://github.com/IT4Change/boilerplate-backend/tree/master/" +LABEL org.label-schema.vcs-ref="${BUILD_COMMIT}" +LABEL org.label-schema.vendor="IT4C" +LABEL org.label-schema.version="${BUILD_VERSION}" +LABEL org.label-schema.schema-version="1.0" +LABEL maintainer="info@it4c.dev" + +# Install Additional Software +## install: node-gyp dependencies +# RUN apk --no-cache add g++ make python3 + +# Settings +## Expose Container Port +EXPOSE ${PORT} + +## Workdir +RUN mkdir -p ${DOCKER_WORKDIR} +WORKDIR ${DOCKER_WORKDIR} + +################################################################################## +# DEVELOPMENT (Connected to the local environment, to reload on demand) ########## +################################################################################## +FROM base as development + +# We don't need to copy or build anything since we gonna bind to the +# local filesystem which will need a rebuild anyway + +# Run command +# (for development we need to execute npm install since the +# node_modules are on another volume and need updating) +CMD /bin/sh -c "npm install && npm run dev" + +################################################################################## +# DOCUMENTATION ################################################################## +################################################################################## +FROM base as documentation + +# We don't need to copy or build anything since we gonna bind to the +# local filesystem which will need a rebuild anyway + +# Run command +# (for development we need to execute npm install since the +# node_modules are on another volume and need updating) +# CMD /bin/sh -c "npm install && npm run docs:dev" + +################################################################################## +# BUILD (Does contain all files and is therefore bloated) ######################## +################################################################################## +FROM base as build + +# Copy everything +COPY . . +# npm install +RUN npm install --frozen-lockfile --non-interactive +# npm build +RUN npm run build + +################################################################################## +# PRODUCTION (Does contain only "binary"- and static-files to reduce image size) # +################################################################################## +FROM base as production + +# Copy "binary"-files from build image +COPY --from=build ${DOCKER_WORKDIR}/build ./build +# We also copy the node_modules express and serve-static for the run script +COPY --from=build ${DOCKER_WORKDIR}/node_modules ./node_modules +# Copy package.json & tsconfig.json +COPY --from=build ${DOCKER_WORKDIR}/package.json ./package.json +COPY --from=build ${DOCKER_WORKDIR}/package-lock.json ./package-lock.json +COPY --from=build ${DOCKER_WORKDIR}/tsconfig.json ./tsconfig.json +# Install production packages +RUN npm install --omit=dev --frozen-lockfile --non-interactive + +# Run command +CMD /bin/sh -c "npm run start" \ No newline at end of file diff --git a/docker-compose.override.yml b/docker-compose.override.yml new file mode 100644 index 0000000..e133bbe --- /dev/null +++ b/docker-compose.override.yml @@ -0,0 +1,24 @@ +version: '3.4' +services: + # ###################################################### + # BACKEND ############################################## + # ###################################################### + backend: + # name the image so that it cannot be found in a DockerHub repository, otherwise it will not be built locally from the 'dockerfile' but pulled from there + image: it4c/backend:local-development + build: + target: development + environment: + - NODE_ENV="development" + # - DEBUG=true + volumes: + # This makes sure the docker container has its own node modules. + # Therefore it is possible to have a different node version on the host machine + - backend_node_modules:/server/node_modules + # bind the local folder to the docker to allow live reload + - ./:/server + + +volumes: + backend_node_modules: + documentation_node_modules: \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..81543aa --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,33 @@ +# This file defines the production settings. It is overwritten by docker-compose.override.yml, +# which defines the development settings. The override.yml is loaded by default. Therefore it +# is required to explicitly define if you want an production build: +# > docker-compose -f docker-compose.yml up +version: '3.4' +services: + backend: + # name the image so that it cannot be found in a DockerHub repository, otherwise it will not be built locally from the 'dockerfile' but pulled from there + image: it4c/backend:local-production + build: + context: . + target: production + networks: + - external-net + - internal-net + ports: + - 4000:4000 + environment: + # Envs used in Dockerfile + # - DOCKER_WORKDIR="/server" + # - PORT=4000 + # - BUILD_DATE="1970-01-01T00:00:00.00Z" + # - BUILD_VERSION="0.0.0.0" + # - BUILD_COMMIT="0000000" + - NODE_ENV="production" + # env_file: + # - ./.env + # - ./backend/.env + +networks: + external-net: + internal-net: + internal: true \ No newline at end of file