go-duck-cli 1.2.2 → 1.2.25

package/README.md

@@ -13,6 +13,7 @@
 <p align="center">
   <a href="https://badge.fury.io/js/go-duck-cli"><img src="https://badge.fury.io/js/go-duck-cli.svg" alt="npm version"></a>
   <a href="https://opensource.org/licenses/ISC"><img src="https://img.shields.io/badge/License-ISC-blue.svg" alt="License: ISC"></a>
+  ![Version](https://img.shields.io/badge/version-1.2.25-blue)
 </p>
 
 ---
@@ -106,6 +107,15 @@ Ensure your development environment meets the following requirements:
 *   **Docker:** v20+
 *   **Composability:** v2+
 
+## Quick‑Start
+
+Follow these four steps to get a generated microservice running locally and in Kubernetes:
+
+1. **Create**: `go-duck create -o ./my-app -c config.yaml`
+2. **Enter**: `cd my-app`
+3. **Build & Push**: `./push.sh my-registry/my-app:1.0.0`
+4. **Deploy**: `kubectl apply -f devops/k8s/`
+
 ## 🚀 Scaffold & Run
 
 Follow these steps to create and run a new microservice with GO-DUCK:
@@ -116,6 +126,36 @@ go-duck create -o ./my-app -c config.yaml
 
 # 2. Enter the application directory
 cd my-app
+
+# 3. Build, tag, and push Docker image (updates app.yaml)
+./push.sh my-registry/my-app:1.0.0
+
+# 4. Deploy to Kubernetes
+kubectl apply -f devops/k8s/
+
+### 🚢 Deploy to Kubernetes & Push Images
+
+The generated project includes a **devops/k8s** directory with ready‑to‑apply Kubernetes manifests:
+
+- `mongo.yaml` – StatefulSet & Service for MongoDB.
+- `minio.yaml` – Deployment & Service for MinIO object storage.
+- `app.yaml` – Deployment for the generated Go microservice, referencing a placeholder image name (`<app‑name>:latest`). Replace the image with the tag you push.
+
+A helper script **push.sh** (located at the project root) automates the Docker build, tag, push, and then updates the `app.yaml` image field:
+
+```bash
+./push.sh my-registry/my-app:1.0.0
+```
+
+After pushing, deploy everything with:
+
+```bash
+kubectl apply -f devops/k8s/
+```
+
+> [!NOTE]
+> The K8s manifests use placeholder values (e.g., resource limits, storage class). Adjust them to match your cluster requirements before applying.
+
 ```
 
 ### 🏗️ Compiling Protobuf & gRPC Contracts

package/generators/ai_docs.js

@@ -126,7 +126,8 @@ export const generateAIDocs = async (config, entities, outputDir, enums, openEnt
     agentInstructions += `### High-Velocity Commands:\n`;
     agentInstructions += `- **Build Project**: \`go build ./...\`\n`;
     agentInstructions += `- **Protobuf Compilation**: \`./generate.sh\` (or \`.\\generate.bat\` on Windows)\n`;
-    agentInstructions += `- **Local Dependencies & Dev Boot**: \`docker-compose up -d && go run main.go\`\n\n`;
+    agentInstructions += `- **Local Dependencies & Dev Boot**: \`docker-compose up -d && go run main.go\`\n`;
+    agentInstructions += `- **Docker Build & Push**: \`./push.sh\` (Builds and pushes the Docker image to registry)\n\n`;
     agentInstructions += `### GDL Evolution & Schema Deletions:\n`;
     agentInstructions += `- **Snapshot Merging (Multi-File GDL)**: The generator implements stateful snapshot merging. Running \`import-gdl\` on a single GDL file will NOT wipe out other entities; previous snapshots are retrieved from the \`.go-duck/\` state folder and merged automatically.\n`;
     agentInstructions += `- **Altering/Dropping Fields**: To add, drop, or edit fields within an entity, update the fields inline in the GDL entity block. Running \`import-gdl\` generates targeted Goose SQL column-level migrations.\n`;

package/generators/devops.js

@@ -400,6 +400,502 @@ jobs:
         ]
     }, null, 4);
 
+    const pushScript = `#!/usr/bin/env bash
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# --- CONFIGURATION ---
+# Edit these variables to hardcode your values, or leave them to fallback to environment variables.
+DOCKER_USER="\${DOCKER_USER:-your-dockerhub-username}"
+IMAGE_NAME="\${IMAGE_NAME:-${appName}}"
+VERSION="\${VERSION:-1.0.0}"
+# ---------------------
+
+# Build the full image tag
+TAG="\${DOCKER_USER}/\${IMAGE_NAME}:\${VERSION}"
+
+echo "========================================="
+echo "Building Docker image: \$TAG"
+echo "========================================="
+docker build -f devops/Dockerfile -t "\$TAG" .
+
+echo "========================================="
+echo "Pushing Docker image: \$TAG"
+echo "========================================="
+docker push "\$TAG"
+
+echo "========================================="
+echo "Successfully built and published \$TAG"
+echo "========================================="
+`;
+
+    const k8sAppYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ${appName}
+  labels:
+    app: ${appName}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: ${appName}
+  template:
+    metadata:
+      labels:
+        app: ${appName}
+    spec:
+      containers:
+        - name: ${appName}
+          image: ${appName}:latest
+          env:
+            - name: GO_PROFILE
+              value: prod
+            - name: GO_DUCK_SERVER_REST_PORT
+              value: "${appPort}"
+            - name: GO_DUCK_DATASOURCE_HOST
+              value: postgres
+            - name: GO_DUCK_DATASOURCE_USERNAME
+              value: "${config.datasource?.username || 'postgres'}"
+            - name: GO_DUCK_DATASOURCE_PASSWORD
+              value: "${config.datasource?.password || 'password'}"
+            - name: GO_DUCK_DATASOURCE_DATABASE
+              value: "${config.datasource?.database || 'go_duck_master'}"
+            - name: GO_DUCK_DATASOURCE_PORT
+              value: "5432"
+            - name: GO_DUCK_CACHE_REDIS_HOST
+              value: redis:6379
+            - name: GO_DUCK_MESSAGING_MQTT_BROKER
+              value: tcp://mosquitto:1883
+            - name: GO_DUCK_MESSAGING_NATS_URL
+              value: nats://nats:4222
+            - name: GO_DUCK_TELEMETRY_OTEL_ENDPOINT
+              value: otel-collector:4317
+            - name: GO_DUCK_ELASTICSEARCH_ADDRESSES
+              value: http://elasticsearch:9200
+            - name: GO_DUCK_SECURITY_KEYCLOAK_HOST
+              value: http://keycloak:8080
+          ports:
+            - name: http
+              containerPort: ${appPort}
+            - name: grpc
+              containerPort: 9000
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: ${appName}
+spec:
+  ports:
+    - name: http
+      port: ${appPort}
+      targetPort: http
+    - name: grpc
+      port: 9000
+      targetPort: grpc
+  selector:
+    app: ${appName}
+`;
+
+    const k8sPostgresYaml = `apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: postgres-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: postgres
+  labels:
+    app: postgres
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: postgres
+  template:
+    metadata:
+      labels:
+        app: postgres
+    spec:
+      containers:
+        - name: postgres
+          image: postgres:15.6-alpine
+          env:
+            - name: POSTGRES_USER
+              value: "${config.datasource?.username || 'postgres'}"
+            - name: POSTGRES_PASSWORD
+              value: "${config.datasource?.password || 'password'}"
+            - name: POSTGRES_DB
+              value: "${config.datasource?.database || 'go_duck_master'}"
+          ports:
+            - containerPort: 5432
+          volumeMounts:
+            - name: postgres-storage
+              mountPath: /var/lib/postgresql/data
+      volumes:
+        - name: postgres-storage
+          persistentVolumeClaim:
+            claimName: postgres-pvc
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: postgres
+spec:
+  ports:
+    - port: 5432
+  selector:
+    app: postgres
+`;
+
+    const k8sRedisYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: redis
+  labels:
+    app: redis
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: redis
+  template:
+    metadata:
+      labels:
+        app: redis
+    spec:
+      containers:
+        - name: redis
+          image: redis:7.2.4-alpine
+          ports:
+            - containerPort: 6379
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: redis
+spec:
+  ports:
+    - port: 6379
+  selector:
+    app: redis
+`;
+
+    const k8sNatsYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nats
+  labels:
+    app: nats
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: nats
+  template:
+    metadata:
+      labels:
+        app: nats
+    spec:
+      containers:
+        - name: nats
+          image: nats:2.10.12-alpine
+          ports:
+            - containerPort: 4222
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: nats
+spec:
+  ports:
+    - port: 4222
+  selector:
+    app: nats
+`;
+
+    const k8sMosquittoYaml = `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: mosquitto-config
+data:
+  mosquitto.conf: |
+    listener 1883
+    listener 9001
+    protocol websockets
+    allow_anonymous true
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: mosquitto
+  labels:
+    app: mosquitto
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: mosquitto
+  template:
+    metadata:
+      labels:
+        app: mosquitto
+    spec:
+      containers:
+        - name: mosquitto
+          image: eclipse-mosquitto:2.0.18
+          ports:
+            - containerPort: 1883
+            - containerPort: 9001
+          volumeMounts:
+            - name: config-volume
+              mountPath: /mosquitto/config/mosquitto.conf
+              subPath: mosquitto.conf
+      volumes:
+        - name: config-volume
+          configMap:
+            name: mosquitto-config
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: mosquitto
+spec:
+  ports:
+    - name: mqtt
+      port: 1883
+    - name: ws
+      port: 9001
+  selector:
+    app: mosquitto
+`;
+
+    const k8sElasticsearchYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: elasticsearch
+  labels:
+    app: elasticsearch
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: elasticsearch
+  template:
+    metadata:
+      labels:
+        app: elasticsearch
+    spec:
+      containers:
+        - name: elasticsearch
+          image: docker.elastic.co/elasticsearch/elasticsearch:8.12.2
+          env:
+            - name: discovery.type
+              value: single-node
+            - name: xpack.security.enabled
+              value: "false"
+            - name: ES_JAVA_OPTS
+              value: "-Xms512m -Xmx512m"
+          ports:
+            - containerPort: 9200
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: elasticsearch
+spec:
+  ports:
+    - port: 9200
+  selector:
+    app: elasticsearch
+`;
+
+    const k8sJaegerYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: jaeger
+  labels:
+    app: jaeger
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: jaeger
+  template:
+    metadata:
+      labels:
+        app: jaeger
+    spec:
+      containers:
+        - name: jaeger
+          image: jaegertracing/all-in-one:1.55
+          ports:
+            - containerPort: 16686
+            - containerPort: 4317
+          env:
+            - name: COLLECTOR_OTLP_ENABLED
+              value: "true"
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: jaeger
+spec:
+  ports:
+    - name: ui
+      port: 16686
+    - name: otlp-grpc
+      port: 4317
+  selector:
+    app: jaeger
+`;
+
+    const k8sOtelCollectorYaml = `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: otel-collector-config
+data:
+  otel-collector.yaml: |
+    receivers:
+      otlp:
+        protocols:
+          grpc:
+          http:
+    processors:
+      batch:
+      resourcedetection:
+        detectors: [env, system]
+    exporters:
+      logging:
+        loglevel: debug
+      otlp:
+        endpoint: "jaeger:4317"
+        tls:
+          insecure: true
+    service:
+      pipelines:
+        traces:
+          receivers: [otlp]
+          processors: [batch, resourcedetection]
+          exporters: [logging, otlp]
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: otel-collector
+  labels:
+    app: otel-collector
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: otel-collector
+  template:
+    metadata:
+      labels:
+        app: otel-collector
+    spec:
+      containers:
+        - name: otel-collector
+          image: otel/opentelemetry-collector-contrib:0.96.0
+          command:
+            - --config=/etc/otel-collector-config.yaml
+          ports:
+            - containerPort: 4317
+            - containerPort: 4318
+          volumeMounts:
+            - name: config-volume
+              mountPath: /etc/otel-collector-config.yaml
+              subPath: otel-collector.yaml
+      volumes:
+        - name: config-volume
+          configMap:
+            name: otel-collector-config
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: otel-collector
+spec:
+  ports:
+    - name: otlp-grpc
+      port: 4317
+    - name: otlp-http
+      port: 4318
+  selector:
+    app: otel-collector
+`;
+
+    const k8sKeycloakYaml = `apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: keycloak-realm-config
+data:
+  realm.json: |
+${realmJson.split('\n').map(l => '    ' + l).join('\n')}
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: keycloak
+  labels:
+    app: keycloak
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: keycloak
+  template:
+    metadata:
+      labels:
+        app: keycloak
+    spec:
+      containers:
+        - name: keycloak
+          image: quay.io/keycloak/keycloak:26.2.3
+          args: ["start-dev", "--import-realm"]
+          env:
+            - name: KEYCLOAK_ADMIN
+              value: admin
+            - name: KEYCLOAK_ADMIN_PASSWORD
+              value: admin
+            - name: KC_DB
+              value: postgres
+            - name: KC_DB_URL
+              value: jdbc:postgresql://postgres:5432/keycloak
+            - name: KC_DB_USERNAME
+              value: "${config.datasource?.username || 'postgres'}"
+            - name: KC_DB_PASSWORD
+              value: "${config.datasource?.password || 'password'}"
+          ports:
+            - containerPort: 8080
+          volumeMounts:
+            - name: realm-volume
+              mountPath: /opt/keycloak/data/import/realm.json
+              subPath: realm.json
+      volumes:
+        - name: realm-volume
+          configMap:
+            name: keycloak-realm-config
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: keycloak
+spec:
+  ports:
+    - port: 8080
+  selector:
+    app: keycloak
+`;
+
     const realmConfigDir = path.join(devopsDir, 'keycloak', 'realm-config');
     await fs.ensureDir(realmConfigDir);
     await fs.writeFile(path.join(realmConfigDir, `${realmName}-realm.json`), realmJson);
@@ -413,8 +909,102 @@ jobs:
     await fs.writeFile(path.join(devopsDir, 'app.yml'), appYaml);
     await fs.writeFile(path.join(devopsDir, 'docker-compose.yml'), dockerCompose);
     await fs.writeFile(path.join(k8sDir, 'mosquitto.conf'), mosquittoConf);
+    
+    // Write Kubernetes manifest assets
+    await fs.writeFile(path.join(k8sDir, 'app.yaml'), k8sAppYaml);
+    await fs.writeFile(path.join(k8sDir, 'postgres.yaml'), k8sPostgresYaml);
+    await fs.writeFile(path.join(k8sDir, 'redis.yaml'), k8sRedisYaml);
+    await fs.writeFile(path.join(k8sDir, 'nats.yaml'), k8sNatsYaml);
+    await fs.writeFile(path.join(k8sDir, 'mosquitto.yaml'), k8sMosquittoYaml);
+    await fs.writeFile(path.join(k8sDir, 'elasticsearch.yaml'), k8sElasticsearchYaml);
+    await fs.writeFile(path.join(k8sDir, 'jaeger.yaml'), k8sJaegerYaml);
+    await fs.writeFile(path.join(k8sDir, 'otel-collector-k8s.yaml'), k8sOtelCollectorYaml);
+    await fs.writeFile(path.join(k8sDir, 'keycloak.yaml'), k8sKeycloakYaml);
+
+    // Additional optional services manifests
+    const k8sMongoYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: mongodb
+  labels:
+    app: mongodb
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: mongodb
+  template:
+    metadata:
+      labels:
+        app: mongodb
+    spec:
+      containers:
+        - name: mongodb
+          image: mongo:7.0.5
+          ports:
+            - containerPort: 27017
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: mongodb
+spec:
+  ports:
+    - port: 27017
+  selector:
+    app: mongodb`;
+    const k8sMinioYaml = `apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: minio
+  labels:
+    app: minio
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: minio
+  template:
+    metadata:
+      labels:
+        app: minio
+    spec:
+      containers:
+        - name: minio
+          image: minio/minio:RELEASE.2024-05-10T19-05-27Z
+          args:
+            - server
+            - /data
+          env:
+            - name: MINIO_ROOT_USER
+              value: "minioadmin"
+            - name: MINIO_ROOT_PASSWORD
+              value: "minioadmin"
+          ports:
+            - containerPort: 9000
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: minio
+spec:
+  ports:
+    - port: 9000
+  selector:
+    app: minio`;
+    await fs.writeFile(path.join(k8sDir, 'mongodb.yaml'), k8sMongoYaml);
+    await fs.writeFile(path.join(k8sDir, 'minio.yaml'), k8sMinioYaml);
+
     await fs.writeFile(path.join(githubDir, 'ci.yml'), ciWorkflow);
     await fs.writeFile(path.join(githubDir, 'cd.yml'), cdWorkflow);
 
-    console.log(chalk.gray('  Generated devops/Dockerfile, devops/services.yml, devops/app.yml, devops/docker-compose.yml & GitHub Actions CI/CD'));
+    const pushScriptPath = path.join(projectRootDir, 'push.sh');
+    await fs.writeFile(pushScriptPath, pushScript);
+    try {
+        await fs.chmod(pushScriptPath, 0o755);
+    } catch (e) {
+        // Safe fallback for OS environments where chmod is not supported
+    }
+
+    console.log(chalk.gray('  Generated devops/Dockerfile, devops/services.yml, devops/app.yml, devops/docker-compose.yml, push.sh, Kubernetes manifests & GitHub Actions CI/CD'));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "go-duck-cli",
-  "version": "1.2.2",
+  "version": "1.2.25",
   "description": "The Ultimate Evolutionary Go Microservice Scaffolder.",
   "main": "index.js",
   "type": "module",