improved Dockerfile using multistage to reduce image size #5187

barakbd · 2018-11-20T20:22:42Z

This is an improved Dockerfile which reduces the final image size.
I suggest to leave the comments and links in for future reference and clarity.
I do not see in the travis.yaml that it is being built and pushed to Dockerhub.

codecov · 2018-11-20T20:33:24Z

Codecov Report

Merging #5187 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5187      +/-   ##
==========================================
- Coverage   93.91%   93.87%   -0.04%     
==========================================
  Files         123      123              
  Lines        8939     8950      +11     
==========================================
+ Hits         8395     8402       +7     
- Misses        544      548       +4

Impacted Files	Coverage Δ
src/Routers/PushRouter.js	`92.85% <0%> (-3.58%)`	⬇️
src/Adapters/Storage/Mongo/MongoStorageAdapter.js	`91.48% <0%> (-0.73%)`	⬇️
...dapters/Storage/Postgres/PostgresStorageAdapter.js	`97.11% <0%> (-0.06%)`	⬇️
src/RestWrite.js	`93.24% <0%> (+0.18%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8c419ec...a21c2ec. Read the comment docs.

flovilmart · 2018-11-27T02:06:12Z

The build is automated in dockerhub so there is no need to use travis to push.

Thanks for the PR. While this seems as always over complicated, this doesn't really solve either the onboarding situation with docker as well as installing 3rd party packages, passing a custom config etc..

barakbd · 2018-11-27T19:09:55Z

This is a great improvement to reduce the image size. Multistage Docker builds are standard for some time now (and not over complicated)
As for tutorials on how to get a Dockerized Parse Server running, there are multiple examples on the web already. Here are a few:

There are even Helm Charts ready to install:

The purpose of this repo should be to optimize the docker image which everyone is pulling.

barakbd · 2018-12-11T06:10:01Z

@flovilmart - what else is needed for this PR to merge?
It is not blocking anything. Who is an approving reviewer?

flovilmart · 2018-12-11T17:46:04Z

I am, I need to have a look.

barakbd · 2018-12-11T17:59:52Z

https://semaphoreci.com/blog/2018/03/14/docker-image-size.html

flovilmart · 2018-12-14T15:47:09Z

Dockerfile

+# RUN ls -al
+
+# capture git_commit in label
+ARG GIT_COMMIT


is this argument passed by anyone?

https://medium.com/microscaling-systems/labelling-automated-builds-on-docker-hub-f3d073fb8e1

I just learned about dockerhub build hooks - https://docs.docker.com/docker-hub/builds/advanced/

I will add a hook to set the arg during build

flovilmart · 2018-12-14T15:47:46Z

Dockerfile

+# list all dir/files  - for debugging purposes
+# RUN ls -al
+
+#  ---- UNIT TESTS AND FLOW LINT in stage 3------


why keep that if it is not run? We should probably either remove or run the tests

It seems that the tests depend on a db, so we cannot run them inside Dockerfile.
Also, the tests are already setup to run in Travis CI.
I am just leaving the comments here for future reference, in case someone wants to change this.

So please remove it!

flovilmart · 2018-12-14T15:48:28Z

Dockerfile

+RUN npm install 
+# copy all context into WORKDIR (/parse-server) excluding items in .dockerignore
+COPY . .
+# Need to run build explicitly as npm will not auto run scripts as ROOT


why run as ROOT then? If there's no need, please run unpriviledged

flovilmart · 2018-12-14T15:49:24Z

Dockerfile

+# base image for release stage with only prod dependencies
+FROM base AS dependencies
+# set npm configs 
+RUN npm set progress=false && npm config set depth 0


what is the purpose of set depth 0?

There is no affected command: https://docs.npmjs.com/misc/config#depth

flovilmart · 2018-12-14T15:49:54Z

Dockerfile

+# ------- Stage 1 - Base ---------
+FROM node:carbon-alpine as base
+# apk - https://www.cyberciti.biz/faq/10-alpine-linux-apk-command-examples/
+# RUN apk update && apk upgrade && \


why keep those??

flovilmart · 2018-12-14T15:50:15Z

Dockerfile

@@ -1,21 +1,86 @@
-FROM node:carbon
+# https://blog.hasura.io/an-exhaustive-guide-to-writing-dockerfiles-for-node-js-web-apps-bbee6bd2f3c4


no need to copy paste the sources of the code you're writing. please remove

flovilmart · 2018-12-14T15:50:31Z

Dockerfile


-RUN mkdir -p /parse-server/config
-VOLUME /parse-server/config
+# ------- Stage 1 - Base ---------


please remove useless comments

flovilmart · 2018-12-14T15:51:53Z

Dockerfile

+
+
+# ------- Stage 4 - Release ---------
+FROM dependencies AS release


all in all each layer uses the previous one completely, what's the point then?

update repo

flovilmart · 2018-12-17T23:03:19Z

@barakbd what size are you at currently? I have a very simple Dockerfile that ends up with a 160Mb size:

FROM node:carbon-alpine as build 

RUN apk update; \
  apk add git;
RUN npm install -g npm@latest;
WORKDIR /tmp

COPY package*.json ./
RUN npm ci

COPY . .
RUN npm run build

FROM node:carbon-alpine as release

WORKDIR /parse-server

COPY package.json .
RUN npm install --production 

COPY bin bin
COPY public_html public_html
COPY views views
COPY --from=build /tmp/lib lib

ENV PORT=1337

USER node

EXPOSE $PORT

ENTRYPOINT ["node", "./bin/parse-server"]

barakbd · 2018-12-17T23:55:24Z

I get almost same size (176mb).
Does the image work?
Do npm prepare && postinstall scripts run automatically? I think I had to run them explicitly since npm won't run auto scripts in root user:
https://docs.npmjs.com/misc/scripts#user
npm/npm#17346

This looks fine. The only improvement my file has is shorter build time, since it only installs each npm package once, but I doubt that's a big concern.

I am still testing building with labels that contain the git commit. Dockerhub build environment has a few variables, one of which is SOURCE_COMMIT. Feel free to use your Dockerfile, and I will make another pull request regarding the build hook.

flovilmart · 2018-12-17T23:59:08Z

Not sure there’s a real need for the source commit as it is recommended not to use ‘latest’ in any case.

Yes the image ‘works’. Try it out. I may have missed the VOLUMES directive.

The npm install is quite fast, and it’s always built by docker hub itself, so speed is not that important

barakbd · 2018-12-18T01:16:16Z

It is not recommended to use latest for tags, not for labels.
Since you can move tags between git commits, you may build a new docker image with the same tag (assuming you're docker tag is based on your git tag), but the source code is different. The most direct way to connect docker image and source code is label it with the commit hash.

flovilmart · 2018-12-18T01:20:27Z

in any case, closing in favor of #5248

flovilmart · 2018-12-18T01:22:16Z

It is not recommended to use latest for tags, not for labels.

What do you mean?

Since you can move tags between git commits, you may build a new docker image with the same tag (assuming you're docker tag is based on your git tag), but the source code is different.

Yes and the respository will equally point to different source code. BUT you need to force push to git as well as the docker repository, so ¯_(ツ)_/¯

The most direct way to connect docker image and source code is label it with the commit hash.

Which is not provided by default by docker hub as an environment variable, so I guess this is not 'that' important.

improved Dockerfile using multistage to reduce image size

c15f07b

Merge branch 'master' into dockerfile

6546645

Merge branch 'master' into dockerfile

78699b3

barakbd added 2 commits November 28, 2018 09:03

Merge branch 'master' into dockerfile

18b23c8

Merge branch 'master' into dockerfile

a166e93

marksharaabi approved these changes Dec 7, 2018

View reviewed changes

marksharaabi previously approved these changes Dec 7, 2018

View reviewed changes

flovilmart reviewed Dec 14, 2018

View reviewed changes

flovilmart suggested changes Dec 14, 2018

View reviewed changes

barakbd and others added 3 commits December 14, 2018 14:59

Merge pull request #1 from parse-community/master

ef4f055

update repo

Merge pull request #2 from barakbd/master

036a141

update repo

testing dockerhub hooks

10a03c8

barakbd dismissed marksharaabi’s stale review via 10a03c8 December 17, 2018 20:09

change echo

a21c2ec

flovilmart closed this Dec 18, 2018

snyk-bot mentioned this pull request May 21, 2023

refactor: Upgrade @graphql-tools/schema from 9.0.4 to 9.0.19 #8543

Closed

kiarza2543 mentioned this pull request Dec 12, 2023

[Snyk] Upgrade @graphql-tools/schema from 9.0.4 to 9.0.19 kiarza2543/parse-server#1

Open

		@@ -1,21 +1,86 @@
		FROM node:carbon
		# https://blog.hasura.io/an-exhaustive-guide-to-writing-dockerfiles-for-node-js-web-apps-bbee6bd2f3c4



		# ------- Stage 4 - Release ---------
		FROM dependencies AS release

Uh oh!

improved Dockerfile using multistage to reduce image size #5187

improved Dockerfile using multistage to reduce image size #5187

Uh oh!

Conversation

barakbd commented Nov 20, 2018

Uh oh!

codecov bot commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

flovilmart commented Nov 27, 2018

Uh oh!

barakbd commented Nov 27, 2018

Uh oh!

barakbd commented Dec 11, 2018

Uh oh!

flovilmart commented Dec 11, 2018

Uh oh!

barakbd commented Dec 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flovilmart commented Dec 17, 2018

Uh oh!

barakbd commented Dec 17, 2018

Uh oh!

flovilmart commented Dec 17, 2018

Uh oh!

barakbd commented Dec 18, 2018

Uh oh!

flovilmart commented Dec 18, 2018

Uh oh!

flovilmart commented Dec 18, 2018

Uh oh!

Uh oh!

codecov bot commented Nov 20, 2018 •

edited

Loading