feat(examples): add Docker health check to all Docker examples

Author: dxoo

examples/with-docker-compose/next-app/prod-without-multistage.Dockerfile

@@ -2,6 +2,9 @@
 
 FROM node:20-alpine
 
+# Install curl for health check
+RUN apk add --no-cache curl
+
 WORKDIR /app
 
 # Install dependencies based on the preferred package manager
@@ -41,6 +44,10 @@ RUN \
   else npm run build; \
   fi
 
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 # Start Next.js based on the preferred package manager
 CMD \
   if [ -f yarn.lock ]; then yarn start; \

examples/with-docker-compose/next-app/prod.Dockerfile

@@ -2,6 +2,9 @@
 
 FROM node:20-alpine AS base
 
+# Install curl for health check
+RUN apk add --no-cache curl
+
 # Step 1. Rebuild the source code only when needed
 FROM base AS builder
 
@@ -72,4 +75,8 @@ ENV NEXT_PUBLIC_ENV_VARIABLE=${NEXT_PUBLIC_ENV_VARIABLE}
 
 # Note: Don't expose ports here, Compose will handle that for us
 
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 CMD ["node", "server.js"]

examples/with-docker-compose/next-app/src/pages/api/health.js

@@ -0,0 +1,6 @@
+// Health check endpoint for container orchestration (Docker, Kubernetes, etc.)
+// https://nextjs.org/docs/api-routes/introduction
+
+export default function health(req, res) {
+  res.status(200).json({ status: "ok" });
+}

examples/with-docker-multi-env/docker/development/Dockerfile

@@ -5,7 +5,8 @@ FROM node:20-alpine AS base
 # 1. Install dependencies only when needed
 FROM base AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
-RUN apk add --no-cache libc6-compat
+# curl is required for the health check in the runner stage.
+RUN apk add --no-cache libc6-compat curl
 
 WORKDIR /app
 
@@ -50,4 +51,8 @@ EXPOSE 3000
 
 ENV PORT=3000
 
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 CMD HOSTNAME="0.0.0.0" node server.js

examples/with-docker-multi-env/docker/production/Dockerfile

@@ -5,7 +5,8 @@ FROM node:20-alpine AS base
 # 1. Install dependencies only when needed
 FROM base AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
-RUN apk add --no-cache libc6-compat
+# curl is required for the health check in the runner stage.
+RUN apk add --no-cache libc6-compat curl
 
 WORKDIR /app
 
@@ -51,4 +52,8 @@ EXPOSE 3000
 
 ENV PORT=3000
 
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 CMD HOSTNAME="0.0.0.0" node server.js

examples/with-docker-multi-env/docker/staging/Dockerfile

@@ -5,7 +5,8 @@ FROM node:20-alpine AS base
 # 1. Install dependencies only when needed
 FROM base AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
-RUN apk add --no-cache libc6-compat
+# curl is required for the health check in the runner stage.
+RUN apk add --no-cache libc6-compat curl
 
 WORKDIR /app
 
@@ -51,4 +52,8 @@ EXPOSE 3000
 
 ENV PORT=3000
 
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 CMD HOSTNAME="0.0.0.0" node server.js

examples/with-docker-multi-env/pages/api/health.js

@@ -0,0 +1,6 @@
+// Health check endpoint for container orchestration (Docker, Kubernetes, etc.)
+// https://nextjs.org/docs/api-routes/introduction
+
+export default function health(req, res) {
+  res.status(200).json({ status: "ok" });
+}

examples/with-docker/Dockerfile

@@ -5,7 +5,8 @@ FROM node:20-alpine AS base
 # Install dependencies only when needed
 FROM base AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
-RUN apk add --no-cache libc6-compat
+# curl is required for the health check in the runner stage.
+RUN apk add --no-cache libc6-compat curl
 WORKDIR /app
 
 # Install dependencies based on the preferred package manager
@@ -63,4 +64,9 @@ ENV PORT=3000
 # server.js is created by next build from the standalone output
 # https://nextjs.org/docs/pages/api-reference/config/next-config-js/output
 ENV HOSTNAME="0.0.0.0"
+
+# Health check for container orchestration (Docker, Kubernetes, etc.)
+HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
+  CMD curl -f http://localhost:3000/api/health || exit 1
+
 CMD ["node", "server.js"]

examples/with-docker/pages/api/health.js

@@ -0,0 +1,6 @@
+// Health check endpoint for container orchestration (Docker, Kubernetes, etc.)
+// https://nextjs.org/docs/api-routes/introduction
+
+export default function health(req, res) {
+  res.status(200).json({ status: "ok" });
+}