loopbackio / loopbackio/loopback-next

Dockerfile improvements

Aperta
#10,326 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Build developer-experience feature
Lingua principale
TypeScript
Stelle
5.1k
Fork
1.1k
Merge medio
2g 21h
PR unite (30g)
27

Descrizione

Describe the bug

Since the loopback scaffolding automatically generates a Dockerfile, I've noticed a lot of developers in our organisation assume that this Dockerfile is ready out-of-the-box for production deployments.

Is the generated Dockerfile meant for local developer use? In this case, I think it might be good to mention this somewhere (maybe in the Dockerfile itself) and that it needs some adjustments to be production ready.

Alternatively, I would suggest these changes:

  1. The Dockerfile uses npm install, which is great for local development, but I think it should be npm ci for deployments. npm ci --only=production would be even better, but that won't work without additional changes, because of my next point.
  2. The built Dockerfile includes devDependencies. If I build it as-is (e.g. docker build .), the image size is 393MB because it includes all of the original TypeScript, the transpiled JavaScript, dependencies, and devDependencies. Changing npm install to npm ci --only=production won't work in a single-stage build because those devDependencies are needed to transpile the TypeScript. By using a multi-stage build, this allows only including the needed files, which reduces the image size to 277MB, and should have a positive impact on storage, deployment times, application startup times, etc.
  3. The Dockerfile does the build at runtime, so every time the application is run, it calls npm start, which calls prestart, which calls rebuild, which calls build (and so on). The build should be done when the container is built, so when the container is run, all it has to do is run the code.

I'm not an expert, but here's a Dockerfile that uses a mutli-stage build to fix all of the above issues:

# Check out https://hub.docker.com/_/node to select a new base image
FROM docker.io/library/node:18-slim as builder

# Set to a non-root built-in user `node`
USER node

# Create app directory (with user `node`)
RUN mkdir -p /home/node/app

WORKDIR /home/node/app

# Install app dependencies
# A wildcard is used to ensure both package.json AND package-lock.json are copied
# where available (npm@5+)
COPY --chown=node package*.json ./

RUN npm ci

# Bundle app source code
COPY --chown=node . .

RUN npm run build


FROM docker.io/library/node:18-slim

USER node

RUN mkdir -p /home/node/app

WORKDIR /home/node/app

COPY --chown=node --from=builder /home/node/app/dist dist
COPY --chown=node --from=builder /home/node/app/package*.json ./

RUN npm ci --only=production

# Bind to all network interfaces so that it can be mapped to the host OS
ENV HOST=0.0.0.0 PORT=3000

EXPOSE ${PORT}
CMD [ "node", "." ]
Logs

No response

Additional information

No response

Reproduction
  1. Generate a new application
  2. CD to the directory
  3. Build the Dockerfile and observe the size
  4. Change npm install to npm ci --only=production in Dockerfile
  5. Build an image using the Dockerfile and observe that the build fails

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua il punto di ingresso dello scaffolding di LoopBack o il template che genera il Dockerfile, quindi riproduci la build dell’immagine generata descritta nell’issue. Esamina il comportamento proposto per l’ambiente locale rispetto alla produzione e convalida le dimensioni dell’immagine risultante e il percorso di avvio; il lavoro è completo quando le istruzioni di deployment previste o le modifiche al Dockerfile sono coperte dai test di scaffolding pertinenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
docker, node.js, typescript
Ambito
build-system, devops
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.