dockerfile

Author: alexanderkirtzel

packages/cli/src/commands/bundle/index.ts

@@ -5,6 +5,7 @@
  */
 
 import path from 'path';
+import fs from 'fs-extra';
 import {
   createCommandLogger,
   createTimer,
@@ -33,6 +34,7 @@ export interface BundleCommandOptions {
   verbose?: boolean;
   dryRun?: boolean;
   silent?: boolean;
+  dockerfile?: boolean;
 }
 
 export async function bundleCommand(
@@ -118,6 +120,15 @@ export async function bundleCommand(
         if (!options.json && !options.all && options.stats && stats) {
           displayStats(stats, logger);
         }
+
+        // Generate Dockerfile if requested
+        if (options.dockerfile && !options.all) {
+          const dockerfilePath = path.join(
+            path.dirname(buildOptions.output),
+            'Dockerfile',
+          );
+          await generateDockerfile(dockerfilePath, buildOptions.output, logger);
+        }
       } catch (error) {
         const errorMessage = getErrorMessage(error);
         results.push({
@@ -264,3 +275,38 @@ export async function bundle(
     options.stats ?? false,
   );
 }
+
+/**
+ * Generate a Dockerfile for the bundled flow.
+ *
+ * Creates a minimal Dockerfile that:
+ * - Uses walkeros/flow:latest as base image
+ * - Copies the bundled flow to /app/flow.mjs
+ * - Sets required environment variables
+ * - Exposes port 8080
+ *
+ * @param dockerfilePath - Path to write the Dockerfile
+ * @param bundleOutput - Path to the bundled flow file
+ * @param logger - Logger instance for output
+ */
+async function generateDockerfile(
+  dockerfilePath: string,
+  bundleOutput: string,
+  logger: ReturnType<typeof createCommandLogger>,
+): Promise<void> {
+  const bundleFilename = path.basename(bundleOutput);
+
+  const dockerfile = `# Generated by walkeros CLI
+FROM walkeros/flow:latest
+
+COPY ${bundleFilename} /app/flow.mjs
+
+ENV MODE=collect
+ENV FLOW=/app/flow.mjs
+
+EXPOSE 8080
+`;
+
+  await fs.writeFile(dockerfilePath, dockerfile);
+  logger.log(`Dockerfile: ${dockerfilePath}`);
+}

packages/cli/src/index.ts

@@ -67,6 +67,7 @@ program
   .option('-v, --verbose', 'verbose output')
   .option('--dry-run', 'preview command without executing')
   .option('--silent', 'suppress output')
+  .option('--dockerfile', 'generate Dockerfile alongside bundle')
   .action(async (file, options) => {
     await bundleCommand({
       config: file || 'bundle.config.json',
@@ -78,6 +79,7 @@ program
       verbose: options.verbose,
       dryRun: options.dryRun,
       silent: options.silent,
+      dockerfile: options.dockerfile,
     });
   });
 

packages/server/sources/aws/README.md

@@ -99,7 +99,7 @@ fn.addFunctionUrl({
 
 ```yaml
 # serverless.yml
-service: walkeros-collector
+service: walkeros-flow
 
 provider:
   name: aws

packages/server/sources/aws/examples/serverless.yml

@@ -1,4 +1,4 @@
-service: walkeros-collector
+service: walkeros-flow
 
 provider:
   name: aws

packages/server/sources/express/README.md

@@ -432,80 +432,21 @@ This design enables:
 
 ## Deployment
 
-### Docker
+Use the [walkerOS Docker image](https://hub.docker.com/r/walkeros/flow) for
+deployment:
 
-```dockerfile
-FROM node:18-alpine
-
-WORKDIR /app
-
-COPY package*.json ./
-RUN npm install
-
-COPY . .
-
-ENV PORT=8080
-EXPOSE 8080
+```bash
+# Bundle your flow with a Dockerfile
+walkeros bundle flow.json --dockerfile
 
-CMD ["node", "server.js"]
+# Build and run
+cd dist
+docker build -t my-flow .
+docker run -p 8080:8080 my-flow
 ```
 
-**server.js:**
-
-```javascript
-import { startFlow } from '@walkeros/collector';
-import { sourceExpress } from '@walkeros/server-source-express';
-
-await startFlow({
-  sources: {
-    express: {
-      code: sourceExpress,
-      config: {
-        settings: {
-          port: process.env.PORT || 8080,
-        },
-      },
-    },
-  },
-  // Your destinations...
-});
-```
-
-### Kubernetes
-
-```yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: walkeros-collector
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: walkeros-collector
-  template:
-    metadata:
-      labels:
-        app: walkeros-collector
-    spec:
-      containers:
-        - name: collector
-          image: your-registry/walkeros-collector:latest
-          ports:
-            - containerPort: 8080
-          livenessProbe:
-            httpGet:
-              path: /health
-              port: 8080
-            initialDelaySeconds: 10
-            periodSeconds: 5
-          readinessProbe:
-            httpGet:
-              path: /ready
-              port: 8080
-            initialDelaySeconds: 5
-            periodSeconds: 3
-```
+See the [Docker documentation](https://www.walkeros.io/docs/apps/docker) for
+Cloud Run, Kubernetes, and other deployment options.
 
 ## Testing
 

website/docs/apps/cli.mdx

@@ -300,6 +300,7 @@ The bundle is now ready to deploy!
 |--------|-------------|
 | `-f, --flow <name>` | Build specific flow (for multi-flow configs) |
 | `--all` | Build all flows |
+| `--dockerfile` | Generate Dockerfile alongside bundle |
 | `-s, --stats` | Show bundle statistics |
 | `--json` | Output statistics as JSON (for CI/CD) |
 | `--no-cache` | Skip package cache, download fresh |

website/docs/apps/docker.mdx

@@ -137,7 +137,7 @@ This creates `dist/flow.mjs`.
   -v $(pwd)/dist/flow.mjs:/app/flow.mjs \\
   -e MODE=collect \\
   -e FLOW=/app/flow.mjs \\
-  --name walkeros-collector \\
+  --name walkeros-flow \\
   walkeros/flow:latest`}
   language="bash"
 />
@@ -154,61 +154,42 @@ This creates `dist/flow.mjs`.
 **4. View logs**
 
 <CodeSnippet
-  code={`docker logs -f walkeros-collector`}
+  code={`docker logs -f walkeros-flow`}
   language="bash"
 />
 
 ### Workflow 2: Custom Docker Image (Production)
 
 Build a custom Docker image with your bundle baked in.
 
-**1. Build with CLI**
+**1. Build with CLI and generate Dockerfile**
 
 <CodeSnippet
-  code={`walkeros bundle production.json -e production --output flow.mjs`}
+  code={`walkeros bundle production.json --dockerfile`}
   language="bash"
 />
 
-**2. Create Dockerfile**
-
-<CodeSnippet
-  code={`FROM walkeros/flow:latest
-
-# Copy pre-built bundle
-COPY flow.mjs /app/flow.mjs
-
-# Configure runtime
-ENV MODE=collect
-ENV FLOW=/app/flow.mjs
-ENV PORT=8080
-
-# Expose port
-EXPOSE 8080
-
-# Health check
-HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \\
-  CMD node -e "require('http').get('http://localhost:8080/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1))"`}
-  language="dockerfile"
-/>
+This creates `dist/bundle.mjs` and `dist/Dockerfile`.
 
-**3. Build image**
+**2. Build image**
 
 <CodeSnippet
-  code={`docker build -t my-analytics-collector:v1.0.0 .`}
+  code={`cd dist
+docker build -t my-analytics:v1.0.0 .`}
   language="bash"
 />
 
-**4. Run it**
+**3. Run it**
 
 <CodeSnippet
-  code={`docker run -d -p 8080:8080 my-analytics-collector:v1.0.0`}
+  code={`docker run -d -p 8080:8080 my-analytics:v1.0.0`}
   language="bash"
 />
 
-**5. Push to registry**
+**4. Push to registry**
 
 <CodeSnippet
-  code={`docker tag my-analytics-collector:v1.0.0 gcr.io/my-project/analytics:v1.0.0
+  code={`docker tag my-analytics:v1.0.0 gcr.io/my-project/analytics:v1.0.0
 docker push gcr.io/my-project/analytics:v1.0.0`}
   language="bash"
 />
@@ -598,16 +579,16 @@ Deploy to any Kubernetes cluster:
   code={`apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: walkeros-collector
+  name: walkeros-flow
 spec:
   replicas: 3
   selector:
     matchLabels:
-      app: walkeros-collector
+      app: walkeros-flow
   template:
     metadata:
       labels:
-        app: walkeros-collector
+        app: walkeros-flow
     spec:
       containers:
       - name: collector
@@ -638,10 +619,10 @@ spec:
 apiVersion: v1
 kind: Service
 metadata:
-  name: walkeros-collector
+  name: walkeros-flow
 spec:
   selector:
-    app: walkeros-collector
+    app: walkeros-flow
   ports:
   - protocol: TCP
     port: 80
@@ -654,7 +635,7 @@ Apply:
 
 <CodeSnippet
   code={`kubectl apply -f deployment.yaml
-kubectl get services walkeros-collector`}
+kubectl get services walkeros-flow`}
   language="bash"
 />
 
@@ -691,13 +672,13 @@ Use this for:
 
 <CodeSnippet
   code={`# Follow logs
-docker logs -f walkeros-collector
+docker logs -f walkeros-flow
 
 # Last 100 lines
-docker logs --tail 100 walkeros-collector
+docker logs --tail 100 walkeros-flow
 
 # With timestamps
-docker logs -t walkeros-collector`}
+docker logs -t walkeros-flow`}
   language="bash"
 />
 
@@ -788,10 +769,10 @@ The container is designed for horizontal scaling:
 
 <CodeSnippet
   code={`# Docker Swarm
-docker service scale walkeros-collector=5
+docker service scale walkeros-flow=5
 
 # Kubernetes
-kubectl scale deployment walkeros-collector --replicas=5
+kubectl scale deployment walkeros-flow --replicas=5
 
 # Cloud Run (auto-scaling)
 gcloud run services update $SERVICE_NAME --max-instances=100`}
@@ -804,7 +785,7 @@ gcloud run services update $SERVICE_NAME --max-instances=100`}
 
 <CodeSnippet
   code={`# Check logs
-docker logs walkeros-collector
+docker logs walkeros-flow
 
 # Common issues:
 # - FLOW path doesn't exist
@@ -828,7 +809,7 @@ curl -X POST http://localhost:8080/collect \\
   -d '{"name":"test event","data":{}}'
 
 # Check logs for errors
-docker logs walkeros-collector`}
+docker logs walkeros-flow`}
   language="bash"
 />