23b8523b36
This commit adds complete documentation and tooling for migrating from local development (Kind/Colima on macOS) to production deployment (MicroK8s on Ubuntu VPS at Clouding.io). Documentation added: - K8S-MIGRATION-GUIDE.md: Comprehensive step-by-step migration guide covering all phases from VPS setup to post-deployment operations - MIGRATION-CHECKLIST.md: Quick reference checklist for migration tasks - MIGRATION-SUMMARY.md: High-level overview and key changes summary Configuration updates: - Added storage-patch.yaml for MicroK8s storage class compatibility (changes from 'standard' to 'microk8s-hostpath') - Updated prod/kustomization.yaml to include storage patch Helper scripts: - deploy-production.sh: Interactive deployment script with validation - tag-and-push-images.sh: Automated image tagging and registry push - backup-databases.sh: Database backup script for production Key differences addressed: - Ingress: MicroK8s addon vs custom NGINX - Storage: MicroK8s hostpath vs Kind standard storage - Registry: Container registry configuration for production - SSL: Let's Encrypt production certificates - Domains: Real domain configuration vs localhost - Resources: Production-grade resource limits and scaling The migration guide covers: - VPS setup and MicroK8s installation - Configuration adaptations required - Container registry setup options - SSL certificate configuration - Monitoring and backup setup - Troubleshooting common issues - Security hardening checklist - Rollback procedures All existing Kubernetes manifests remain unchanged and compatible.
Bakery IA - Documentation Index
Welcome to the Bakery IA documentation! This guide will help you navigate through all aspects of the project, from getting started to advanced operations.
Quick Links
- New to the project? Start with Getting Started
- Need to understand the system? See Architecture Overview
- Looking for APIs? Check API Reference
- Deploying to production? Read Deployment Guide
- Having issues? Visit Troubleshooting
Documentation Structure
📚 01. Getting Started
Start here if you're new to the project.
- Quick Start Guide - Get up and running quickly
- Installation - Detailed installation instructions
- Development Setup - Configure your dev environment
🏗️ 02. Architecture
Understand the system design and components.
- System Overview - High-level architecture
- Microservices - Service architecture details
- Data Flow - How data moves through the system
- AI/ML Components - Machine learning architecture
⚡ 03. Features
Detailed documentation for each major feature.
AI & Analytics
- AI Insights Platform - ML-powered insights
- Dynamic Rules Engine - Pattern detection and rules
Tenant Management
- Deletion System - Complete tenant deletion
- Multi-Tenancy - Tenant isolation and management
- Roles & Permissions - RBAC system
Other Features
- Orchestration System - Workflow orchestration
- Sustainability Features - Environmental tracking
- Hyperlocal Calendar - Event management
💻 04. Development
Tools and workflows for developers.
- Development Workflow - Daily development practices
- Tilt vs Skaffold - Development tool comparison
- Testing Guide - Testing strategies and best practices
- Debugging - Troubleshooting during development
🚀 05. Deployment
Deploy and configure the system.
- Kubernetes Setup - K8s deployment guide
- Security Configuration - Security setup
- Database Setup - Database configuration
- Monitoring - Observability setup
🔒 06. Security
Security implementation and best practices.
- Security Overview - Security architecture
- Database Security - DB security configuration
- RBAC Implementation - Role-based access control
- TLS Configuration - Transport security
- Security Checklist - Pre-deployment checklist
⚖️ 07. Compliance
Data privacy and regulatory compliance.
- GDPR Implementation - GDPR compliance
- Data Privacy - Privacy controls
- Audit Logging - Audit trail system
📖 08. API Reference
API documentation and integration guides.
- API Overview - API introduction
- AI Insights API - AI endpoints
- Authentication - Auth mechanisms
- Tenant API - Tenant management endpoints
🔧 09. Operations
Production operations and maintenance.
- Operations Guide - Ops overview
- Monitoring & Observability - System monitoring
- Backup & Recovery - Data backup procedures
- Troubleshooting - Common issues and solutions
- Runbooks - Step-by-step operational procedures
📋 10. Reference
Additional reference materials.
- Changelog - Project history and milestones
- Service Tokens - Token configuration
- Glossary - Terms and definitions
- Smart Procurement - Procurement feature details
Additional Resources
- Main README: Project README - Project overview and quick start
- Archived Docs: Archive - Historical documentation and progress reports
Contributing to Documentation
When updating documentation:
- Keep content focused and concise
- Use clear headings and structure
- Include code examples where relevant
- Update this index when adding new documents
- Cross-link related documents
Documentation Standards
- Use Markdown format
- Include a clear title and introduction
- Add a table of contents for long documents
- Use code blocks with language tags
- Keep line length reasonable for readability
- Update the last modified date at the bottom
Last Updated: 2025-11-04