Explanation¶

Understanding-oriented discussions of concepts

Explanations clarify and deepen understanding of Airbase concepts, architecture, and design decisions. They discuss the "why" behind the platform.

Available Explanations¶

Content Guidelines - Understanding the Diátaxis framework used in this documentation
Airbase Console - Understanding the Console web interface
Architecture - How Airbase works under the hood
Environments Concept - Deep dive into environments and isolation

Coming Soon¶

Deployment Workflow¶

File: deployment-workflow.md Goal: Understand the deployment process Content: - Build phase (Docker image creation) - Push phase (registry upload) - Deploy phase (Kubernetes update) - Rolling deployments - Health checks and readiness - Deployment failures and rollbacks - Zero-downtime deployments

4. Container Security Model¶

File: container-security.md Goal: Understand Airbase security requirements Content: - Why non-root containers - The app user concept - File permission requirements - Security scanning - Secret management - Network isolation - Compliance considerations

5. Environment Variables Design¶

File: env-variables-design.md Goal: Understand how environment variables work Content: - Why separate from container images - Platform-level vs image-level configuration - Environment-specific file patterns - Twelve-factor app principles - Secret management strategy - Configuration precedence - When to rebuild vs redeploy

6. Development Workflows¶

File: development-workflows.md Goal: Understand different development patterns Content: - Local development → staging → production - Branch-based deployments - Feature environment patterns - Continuous deployment strategies - Testing strategies - Team collaboration patterns

7. Why Airbase for Government¶

File: government-use-case.md Goal: Understand Airbase's purpose and context Content: - Singapore Government needs - Cloud infrastructure complexity - Developer productivity goals - Security and compliance requirements - Standardization benefits - Comparison with managing raw Kubernetes - Cost and resource optimization

8. Design Decisions¶

File: design-decisions.md Goal: Understand key design choices Content: - Why Docker/containers - Why Kubernetes abstraction - Port 3000 as default - CLI-first approach - Environment file naming (.env.) - Interactive mode defaults (Y vs N) - Project handle format (team/project)

Writing Explanations¶

For guidelines on writing explanation documentation, see Content Guidelines.