Merge pull request #4259 from backstage/contrib/dockerfile

Add Multi Stage Dockerfile with backend:bundle command

docs/getting-started/deployment-other.md

@@ -4,19 +4,79 @@ title: Other
 description: Documentation on different ways of Deployment
 ---
 
-## Deploying Locally
+## Docker
 
-### Try on Docker
+Here we have an example Dockerfile that you can use to build everything together
+in one container. This Dockerfile uses multi-stage builds, and a
+`backend:bundle` command from the CLI.
 
-Run the following commands if you have Docker environment
+It also provides caching on the `yarn install`'s so that you don't have to do it
+unless absolutely necessary.
 
-```bash
-$ yarn install
-$ yarn docker-build
-$ docker run --rm -it -p 7000:7000 -e NODE_ENV=development example-backend:latest
+> Note: This Dockerfile assumes that you're running SQLite, or your
+> configuration is setup to connect to an external PostgreSQL Database.
+
+```Dockerfile
+# Stage 1 - Create yarn install skeleton layer
+FROM node:14-buster AS packages
+
+WORKDIR /app
+COPY package.json yarn.lock ./
+
+COPY packages packages
+
+# Uncomment this line if you have a local plugins folder
+# COPY plugins plugins
+
+RUN find packages \! -name "package.json" -mindepth 2 -maxdepth 2 -print | xargs rm -rf
+
+# Stage 2 - Install dependencies and build packages
+FROM node:14-buster AS build
+
+WORKDIR /app
+COPY --from=packages /app .
+
+RUN yarn install --network-timeout 600000 && rm -rf "$(yarn cache dir)"
+
+COPY . .
+
+RUN yarn tsc
+RUN yarn --cwd packages/backend backstage-cli backend:bundle --build-dependencies
+
+# Stage 3 - Build the actual backend image and install production dependencies
+FROM node:14-buster
+
+WORKDIR /app
+
+# Copy from build stage
+COPY --from=build /app/yarn.lock /app/package.json /app/packages/backend/dist/skeleton.tar.gz ./
+RUN tar xzf skeleton.tar.gz && rm skeleton.tar.gz
+
+RUN yarn install --production --network-timeout 600000 && rm -rf "$(yarn cache dir)"
+
+COPY --from=build /app/packages/backend/dist/bundle.tar.gz .
+RUN tar xzf bundle.tar.gz && rm bundle.tar.gz
+
+COPY app-config.yaml app-config.production.yaml ./
+
+CMD ["node", "packages/backend", "--config", "app-config.yaml", "--config", "app-config.production.yaml"]
 ```
 
-Then open http://localhost:7000 on your browser.
+You can add the Dockerfile to the root of your project, and run the following to
+build the container under a specified tag.
+
+```sh
+$ docker build -t example-deployment .
+```
+
+To run the image locally you can run:
+
+```sh
+$ docker run -p -it 7000:7000 example-deployment
+```
+
+You should then start to get logs in your terminal, and then you can open your
+browser at `http://localhost:7000`
 
 ## Heroku