deployment-devops

Deployment & DevOps Guidelines

Kaneo supports multiple deployment methods: Docker Compose for development/testing and Kubernetes for production. This document outlines deployment patterns and best practices.

Docker Compose

Configuration

The main Docker Compose configuration is in compose.yml at the project root.

Service Structure

services:
  postgres:
    image: postgres:16-alpine
    env_file:
      - .env
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
      interval: 10s
      timeout: 5s
      retries: 5

  api:
    image: ghcr.io/usekaneo/api:latest
    ports:
      - "1337:1337"
    env_file:
      - .env
    depends_on:
      postgres:
        condition: service_healthy
    restart: unless-stopped

  web:
    image: ghcr.io/usekaneo/web:latest
    ports:
      - "5173:5173"
    env_file:
      - .env
    depends_on:
      - api
    restart: unless-stopped

Best Practices

1. Health Checks: Always include health checks for databases
2. Dependencies: Use depends_on with condition: service_healthy for databases
3. Volumes: Use named volumes for persistent data
4. Restart Policy: Use unless-stopped for production-like behavior
5. Environment Variables: Use .env file, never hardcode secrets

# Good: Proper health check and dependency
services:
  api:
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
      interval: 10s
      timeout: 5s
      retries: 5

Kubernetes (Helm Charts)

Chart Structure

Helm charts are located in charts/kaneo/:

charts/kaneo/
├── Chart.yaml              # Chart metadata
├── values.yaml             # Default values
├── README.md               # Chart documentation
└── templates/
    ├── deployment.yaml     # API and Web deployments
    ├── services.yaml       # Service definitions
    ├── ingress.yaml        # Ingress configuration
    ├── postgresql-deployment.yaml  # PostgreSQL deployment
    ├── pvc.yaml            # Persistent volume claims
    ├── hpa.yaml            # Horizontal Pod Autoscaler
    └── serviceaccount.yaml # Service accounts