@kognitivedev/deployer-docker 0.2.2

package/README.md

@@ -0,0 +1,42 @@
+# @kognitivedev/deployer-docker
+
+> Generate Docker deployment files for Kognitive projects.
+
+## Usage
+
+```typescript
+import { generateDockerFiles } from "@kognitivedev/deployer-docker";
+
+generateDockerFiles("./", {
+  backendPort: 3001,
+  dashboardPort: 3002,
+  includeRedis: true,
+  includeQdrant: true,
+});
+```
+
+Generates: `Dockerfile`, `docker-compose.prod.yml`, `.dockerignore`, `.env.example`
+
+The Dockerfile includes a non-root user, health check against `/api/runtime/info`, and optimized layer caching.
+
+## CI/CD with GitHub Actions
+
+```typescript
+import { generateGitHubActionsDocker } from "@kognitivedev/deployer-docker";
+
+generateGitHubActionsDocker("./", {
+  registry: "ghcr.io",        // or "docker.io"
+  imageName: "my-app",
+  triggerBranch: "main",
+});
+// Generates: .github/workflows/docker-deploy.yml
+```
+
+## Deployment Script
+
+```typescript
+import { generateDeployScript } from "@kognitivedev/deployer-docker";
+
+generateDeployScript("./");
+// Generates: deploy.sh (docker compose up + health check + rollback on failure)
+```

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Generate Docker deployment files for a Kognitive project.
+ */
+export declare function generateDockerFiles(projectDir: string, options?: {
+    backendPort?: number;
+    dashboardPort?: number;
+    includeRedis?: boolean;
+    includeQdrant?: boolean;
+}): void;
+/**
+ * Generate GitHub Actions workflow for Docker-based deployment.
+ */
+export declare function generateGitHubActionsDocker(projectDir: string, options?: {
+    registry?: string;
+    imageName?: string;
+    triggerBranch?: string;
+}): void;
+/**
+ * Generate a deployment script with health checking and rollback.
+ */
+export declare function generateDeployScript(projectDir: string): void;
+/**
+ * Generate .env.example template content.
+ */
+export declare function generateEnvTemplate(): string;

package/dist/index.js

@@ -0,0 +1,262 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDockerFiles = generateDockerFiles;
+exports.generateGitHubActionsDocker = generateGitHubActionsDocker;
+exports.generateDeployScript = generateDeployScript;
+exports.generateEnvTemplate = generateEnvTemplate;
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * Generate Docker deployment files for a Kognitive project.
+ */
+function generateDockerFiles(projectDir, options) {
+    var _a, _b;
+    const backendPort = (_a = options === null || options === void 0 ? void 0 : options.backendPort) !== null && _a !== void 0 ? _a : 3001;
+    const dashboardPort = (_b = options === null || options === void 0 ? void 0 : options.dashboardPort) !== null && _b !== void 0 ? _b : 3002;
+    // Dockerfile — improved multi-stage with non-root user and health check
+    const dockerfile = `FROM oven/bun:1.2 AS base
+WORKDIR /app
+
+# Install dependencies first for better layer caching
+COPY package.json bun.lock* ./
+RUN bun install --frozen-lockfile
+
+# Copy source and build
+COPY . .
+RUN bun run build
+
+# Production
+FROM oven/bun:1.2-slim
+WORKDIR /app
+
+# Create non-root user
+RUN addgroup --system --gid 1001 kognitive && \\
+    adduser --system --uid 1001 kognitive
+
+COPY --from=base --chown=kognitive:kognitive /app ./
+
+USER kognitive
+
+EXPOSE ${backendPort} ${dashboardPort}
+
+HEALTHCHECK --interval=30s --timeout=10s --retries=3 \\
+  CMD curl -f http://localhost:${backendPort}/api/runtime/info || exit 1
+
+CMD ["bun", "run", "start"]
+`;
+    // docker-compose.yml
+    const services = [
+        `  app:
+    build: .
+    ports:
+      - "\${BACKEND_PORT:-${backendPort}}:${backendPort}"
+      - "\${DASHBOARD_PORT:-${dashboardPort}}:${dashboardPort}"
+    env_file:
+      - .env
+    environment:
+      - DATABASE_URL=postgres://postgres:\${POSTGRES_PASSWORD:-password}@db:5432/kognitive
+      - NODE_ENV=production
+    depends_on:
+      db:
+        condition: service_healthy
+    restart: unless-stopped`,
+        `  db:
+    image: pgvector/pgvector:pg16
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: \${POSTGRES_PASSWORD:-password}
+      POSTGRES_DB: kognitive
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped`,
+    ];
+    if (options === null || options === void 0 ? void 0 : options.includeRedis) {
+        services.push(`  redis:
+    image: redis:7-alpine
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped`);
+    }
+    if (options === null || options === void 0 ? void 0 : options.includeQdrant) {
+        services.push(`  qdrant:
+    image: qdrant/qdrant:latest
+    ports:
+      - "6333:6333"
+    volumes:
+      - qdrant_data:/qdrant/storage
+    restart: unless-stopped`);
+    }
+    const volumes = ["  postgres_data:"];
+    if (options === null || options === void 0 ? void 0 : options.includeRedis)
+        volumes.push("  redis_data:");
+    if (options === null || options === void 0 ? void 0 : options.includeQdrant)
+        volumes.push("  qdrant_data:");
+    const compose = `version: '3.8'
+
+services:
+${services.join("\n\n")}
+
+volumes:
+${volumes.join("\n")}
+`;
+    (0, fs_1.writeFileSync)((0, path_1.join)(projectDir, "Dockerfile"), dockerfile);
+    (0, fs_1.writeFileSync)((0, path_1.join)(projectDir, "docker-compose.prod.yml"), compose);
+    (0, fs_1.writeFileSync)((0, path_1.join)(projectDir, ".dockerignore"), "node_modules\n.next\ndist\n.env\n.env.*\n.git\n*.log\n");
+    // Generate .env.example
+    (0, fs_1.writeFileSync)((0, path_1.join)(projectDir, ".env.example"), generateEnvTemplate());
+    console.log("  Generated Docker deployment files:");
+    console.log("    Dockerfile");
+    console.log("    docker-compose.prod.yml");
+    console.log("    .dockerignore");
+    console.log("    .env.example");
+}
+/**
+ * Generate GitHub Actions workflow for Docker-based deployment.
+ */
+function generateGitHubActionsDocker(projectDir, options) {
+    var _a, _b, _c;
+    const registry = (_a = options === null || options === void 0 ? void 0 : options.registry) !== null && _a !== void 0 ? _a : "ghcr.io";
+    const imageName = (_b = options === null || options === void 0 ? void 0 : options.imageName) !== null && _b !== void 0 ? _b : "kognitive-app";
+    const branch = (_c = options === null || options === void 0 ? void 0 : options.triggerBranch) !== null && _c !== void 0 ? _c : "main";
+    const workflow = `name: Build and Deploy (Docker)
+
+on:
+  push:
+    branches: [${branch}]
+
+env:
+  REGISTRY: ${registry}
+  IMAGE_NAME: \${{ github.repository }}/${imageName}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: \${{ env.REGISTRY }}
+          username: \${{ github.actor }}
+          password: \${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            \${{ env.REGISTRY }}/\${{ env.IMAGE_NAME }}:latest
+            \${{ env.REGISTRY }}/\${{ env.IMAGE_NAME }}:\${{ github.sha }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/${branch}'
+
+    steps:
+      - name: Deploy to server
+        run: |
+          echo "Add your deployment commands here."
+          echo "Options:"
+          echo "  - SSH into server and run docker compose pull && docker compose up -d"
+          echo "  - Use a webhook to trigger deployment"
+          echo "  - Use a deployment service like Watchtower"
+`;
+    const dir = (0, path_1.join)(projectDir, ".github", "workflows");
+    if (!(0, fs_1.existsSync)(dir))
+        (0, fs_1.mkdirSync)(dir, { recursive: true });
+    (0, fs_1.writeFileSync)((0, path_1.join)(dir, "docker-deploy.yml"), workflow);
+    console.log("  Generated GitHub Actions workflow:");
+    console.log("    .github/workflows/docker-deploy.yml");
+}
+/**
+ * Generate a deployment script with health checking and rollback.
+ */
+function generateDeployScript(projectDir) {
+    const script = `#!/bin/bash
+set -euo pipefail
+
+echo "=== Kognitive Deployment ==="
+
+# Pull latest images
+echo "Pulling latest images..."
+docker compose -f docker-compose.prod.yml pull
+
+# Store current image for rollback
+PREV_IMAGE=$(docker compose -f docker-compose.prod.yml images app -q 2>/dev/null || echo "")
+
+# Start services
+echo "Starting services..."
+docker compose -f docker-compose.prod.yml up -d
+
+# Health check
+echo "Waiting for health check..."
+MAX_RETRIES=30
+RETRY=0
+while [ $RETRY -lt $MAX_RETRIES ]; do
+    if curl -sf http://localhost:3001/api/runtime/info > /dev/null 2>&1; then
+        echo "Health check passed!"
+        exit 0
+    fi
+    RETRY=$((RETRY + 1))
+    echo "  Attempt $RETRY/$MAX_RETRIES..."
+    sleep 2
+done
+
+# Health check failed — rollback
+echo "Health check failed! Rolling back..."
+if [ -n "$PREV_IMAGE" ]; then
+    docker compose -f docker-compose.prod.yml down
+    echo "Rollback: restart with previous image"
+    docker compose -f docker-compose.prod.yml up -d
+fi
+exit 1
+`;
+    (0, fs_1.writeFileSync)((0, path_1.join)(projectDir, "deploy.sh"), script, { mode: 0o755 });
+    console.log("  Generated deployment script:");
+    console.log("    deploy.sh");
+}
+/**
+ * Generate .env.example template content.
+ */
+function generateEnvTemplate() {
+    return `# ── Required ──
+DATABASE_URL=postgres://postgres:password@localhost:5432/kognitive
+RUNTIME_API_KEY=your-runtime-api-key
+
+# ── Authentication (Clerk) ──
+NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
+CLERK_SECRET_KEY=
+
+# ── Optional ──
+# REDIS_URL=redis://localhost:6379
+# QDRANT_URL=http://localhost:6333
+
+# ── AI Providers ──
+# OPENAI_API_KEY=
+# ANTHROPIC_API_KEY=
+# OPENROUTER_API_KEY=
+
+# ── Deployment ──
+# NODE_ENV=production
+# POSTGRES_PASSWORD=change-me-in-production
+`;
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@kognitivedev/deployer-docker",
+  "version": "0.2.2",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "@types/node": "^20.0.0"
+  },
+  "description": "Docker deployment file generator for Kognitive",
+  "keywords": [
+    "kognitive",
+    "docker",
+    "deployment"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kognitivedev/kognitive",
+    "directory": "packages/deployer-docker"
+  },
+  "homepage": "https://kognitive.dev"
+}

package/src/index.ts

@@ -0,0 +1,277 @@
+import { writeFileSync, mkdirSync, existsSync } from "fs";
+import { join } from "path";
+
+/**
+ * Generate Docker deployment files for a Kognitive project.
+ */
+export function generateDockerFiles(projectDir: string, options?: {
+    backendPort?: number;
+    dashboardPort?: number;
+    includeRedis?: boolean;
+    includeQdrant?: boolean;
+}) {
+    const backendPort = options?.backendPort ?? 3001;
+    const dashboardPort = options?.dashboardPort ?? 3002;
+
+    // Dockerfile — improved multi-stage with non-root user and health check
+    const dockerfile = `FROM oven/bun:1.2 AS base
+WORKDIR /app
+
+# Install dependencies first for better layer caching
+COPY package.json bun.lock* ./
+RUN bun install --frozen-lockfile
+
+# Copy source and build
+COPY . .
+RUN bun run build
+
+# Production
+FROM oven/bun:1.2-slim
+WORKDIR /app
+
+# Create non-root user
+RUN addgroup --system --gid 1001 kognitive && \\
+    adduser --system --uid 1001 kognitive
+
+COPY --from=base --chown=kognitive:kognitive /app ./
+
+USER kognitive
+
+EXPOSE ${backendPort} ${dashboardPort}
+
+HEALTHCHECK --interval=30s --timeout=10s --retries=3 \\
+  CMD curl -f http://localhost:${backendPort}/api/runtime/info || exit 1
+
+CMD ["bun", "run", "start"]
+`;
+
+    // docker-compose.yml
+    const services: string[] = [
+        `  app:
+    build: .
+    ports:
+      - "\${BACKEND_PORT:-${backendPort}}:${backendPort}"
+      - "\${DASHBOARD_PORT:-${dashboardPort}}:${dashboardPort}"
+    env_file:
+      - .env
+    environment:
+      - DATABASE_URL=postgres://postgres:\${POSTGRES_PASSWORD:-password}@db:5432/kognitive
+      - NODE_ENV=production
+    depends_on:
+      db:
+        condition: service_healthy
+    restart: unless-stopped`,
+        `  db:
+    image: pgvector/pgvector:pg16
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: \${POSTGRES_PASSWORD:-password}
+      POSTGRES_DB: kognitive
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped`,
+    ];
+
+    if (options?.includeRedis) {
+        services.push(`  redis:
+    image: redis:7-alpine
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped`);
+    }
+
+    if (options?.includeQdrant) {
+        services.push(`  qdrant:
+    image: qdrant/qdrant:latest
+    ports:
+      - "6333:6333"
+    volumes:
+      - qdrant_data:/qdrant/storage
+    restart: unless-stopped`);
+    }
+
+    const volumes = ["  postgres_data:"];
+    if (options?.includeRedis) volumes.push("  redis_data:");
+    if (options?.includeQdrant) volumes.push("  qdrant_data:");
+
+    const compose = `version: '3.8'
+
+services:
+${services.join("\n\n")}
+
+volumes:
+${volumes.join("\n")}
+`;
+
+    writeFileSync(join(projectDir, "Dockerfile"), dockerfile);
+    writeFileSync(join(projectDir, "docker-compose.prod.yml"), compose);
+    writeFileSync(join(projectDir, ".dockerignore"), "node_modules\n.next\ndist\n.env\n.env.*\n.git\n*.log\n");
+
+    // Generate .env.example
+    writeFileSync(join(projectDir, ".env.example"), generateEnvTemplate());
+
+    console.log("  Generated Docker deployment files:");
+    console.log("    Dockerfile");
+    console.log("    docker-compose.prod.yml");
+    console.log("    .dockerignore");
+    console.log("    .env.example");
+}
+
+/**
+ * Generate GitHub Actions workflow for Docker-based deployment.
+ */
+export function generateGitHubActionsDocker(projectDir: string, options?: {
+    registry?: string;
+    imageName?: string;
+    triggerBranch?: string;
+}) {
+    const registry = options?.registry ?? "ghcr.io";
+    const imageName = options?.imageName ?? "kognitive-app";
+    const branch = options?.triggerBranch ?? "main";
+
+    const workflow = `name: Build and Deploy (Docker)
+
+on:
+  push:
+    branches: [${branch}]
+
+env:
+  REGISTRY: ${registry}
+  IMAGE_NAME: \${{ github.repository }}/${imageName}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: \${{ env.REGISTRY }}
+          username: \${{ github.actor }}
+          password: \${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            \${{ env.REGISTRY }}/\${{ env.IMAGE_NAME }}:latest
+            \${{ env.REGISTRY }}/\${{ env.IMAGE_NAME }}:\${{ github.sha }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/${branch}'
+
+    steps:
+      - name: Deploy to server
+        run: |
+          echo "Add your deployment commands here."
+          echo "Options:"
+          echo "  - SSH into server and run docker compose pull && docker compose up -d"
+          echo "  - Use a webhook to trigger deployment"
+          echo "  - Use a deployment service like Watchtower"
+`;
+
+    const dir = join(projectDir, ".github", "workflows");
+    if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
+    writeFileSync(join(dir, "docker-deploy.yml"), workflow);
+
+    console.log("  Generated GitHub Actions workflow:");
+    console.log("    .github/workflows/docker-deploy.yml");
+}
+
+/**
+ * Generate a deployment script with health checking and rollback.
+ */
+export function generateDeployScript(projectDir: string) {
+    const script = `#!/bin/bash
+set -euo pipefail
+
+echo "=== Kognitive Deployment ==="
+
+# Pull latest images
+echo "Pulling latest images..."
+docker compose -f docker-compose.prod.yml pull
+
+# Store current image for rollback
+PREV_IMAGE=$(docker compose -f docker-compose.prod.yml images app -q 2>/dev/null || echo "")
+
+# Start services
+echo "Starting services..."
+docker compose -f docker-compose.prod.yml up -d
+
+# Health check
+echo "Waiting for health check..."
+MAX_RETRIES=30
+RETRY=0
+while [ $RETRY -lt $MAX_RETRIES ]; do
+    if curl -sf http://localhost:3001/api/runtime/info > /dev/null 2>&1; then
+        echo "Health check passed!"
+        exit 0
+    fi
+    RETRY=$((RETRY + 1))
+    echo "  Attempt $RETRY/$MAX_RETRIES..."
+    sleep 2
+done
+
+# Health check failed — rollback
+echo "Health check failed! Rolling back..."
+if [ -n "$PREV_IMAGE" ]; then
+    docker compose -f docker-compose.prod.yml down
+    echo "Rollback: restart with previous image"
+    docker compose -f docker-compose.prod.yml up -d
+fi
+exit 1
+`;
+
+    writeFileSync(join(projectDir, "deploy.sh"), script, { mode: 0o755 });
+    console.log("  Generated deployment script:");
+    console.log("    deploy.sh");
+}
+
+/**
+ * Generate .env.example template content.
+ */
+export function generateEnvTemplate(): string {
+    return `# ── Required ──
+DATABASE_URL=postgres://postgres:password@localhost:5432/kognitive
+RUNTIME_API_KEY=your-runtime-api-key
+
+# ── Authentication (Clerk) ──
+NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
+CLERK_SECRET_KEY=
+
+# ── Optional ──
+# REDIS_URL=redis://localhost:6379
+# QDRANT_URL=http://localhost:6333
+
+# ── AI Providers ──
+# OPENAI_API_KEY=
+# ANTHROPIC_API_KEY=
+# OPENROUTER_API_KEY=
+
+# ── Deployment ──
+# NODE_ENV=production
+# POSTGRES_PASSWORD=change-me-in-production
+`;
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": { "module": "commonjs", "rootDir": "src", "outDir": "dist", "declaration": true, "noEmit": false, "incremental": false },
+    "include": ["src"]
+}