Developer Documentation

Secure access control and authentication mechanisms for the Blueberry IDP platform using Firebase Auth, API tokens, and RBAC.

Comprehensive guide to configuration management and secrets handling using Google Secret Manager, Kubernetes secrets, and various configuration methods.

Understand the networking architecture, ingress setup, and traffic flow optimization with NEG for secure and scalable networking.

Complete workflows for environment creation, deletion, CI/CD integration, and troubleshooting common scenarios.

Interactive API documentation with Swagger UI. Explore all available endpoints, view request/response schemas, and test API calls directly.

Clean and professional API documentation with ReDoc. Navigate through API endpoints with a modern, responsive interface.

This document provides a comprehensive analysis of the Blueberry IDP repository structure and actionable recommendations for improvement. The repository shows good internal organization within major components but lacks cohesion at the root level, with mixed concerns and inconsistent conventions.

This directory contains visual representations of the Blueberry IDP architecture, including system components, deployment topology, and testing relationships.

This document illustrates the authentication flows in the Blueberry IDP, covering both Firebase authentication for web users and API token authentication for CI/CD systems.

This directory contains system architecture documentation for the Blueberry Internal Developer Platform.

This document provides a comprehensive view of the Blueberry Internal Developer Platform's component architecture, showing how different parts of the system interact to provide ephemeral Kubernetes environments for testing pull requests.

This directory contains detailed documentation for each major component of the Blueberry Internal Developer Platform.

This document illustrates how the Blueberry IDP components are deployed within the Google Cloud Platform and Kubernetes infrastructure.

This document explains how the organized test scripts in `scripts/by-auth/` map to different system components of the Blueberry IDP.

This document illustrates how the Blueberry IDP tracks and analyzes costs for environments, resources, and usage patterns.

This document illustrates how data flows through the Blueberry IDP system, including user data, environment metadata, configuration data, and operational metrics.

This document illustrates the complete environment creation flow in the Blueberry IDP, from initial request to ready environment.

This document illustrates the security architecture of the Blueberry IDP, including authentication, authorization, network security, and data protection mechanisms.

This document illustrates how the Blueberry IDP processes webhooks from various sources including GitLab, GitHub, and custom integrations.

 


This project uses pre-commit hooks to automatically run linters on every commit, ensuring code quality and consistency.

- **Theme**: Dark mode with blue glassmorphism

The navbar appears differently between Docker Compose (local) and Kubernetes environments:

This guide provides standards, templates, and best practices for contributing to the Blueberry IDP documentation.

- [ ] Visit `/api/health/ui-debug` in both environments

This document explains the startup optimizations implemented in Blueberry IDP to improve Docker container startup performance.

Welcome to the Blueberry Internal Developer Platform documentation. This guide will help you navigate our comprehensive documentation.

This guide helps you navigate the Blueberry IDP documentation based on your specific role, goals, and current situation.

This directory contains conceptual guides, best practices, and topic-focused documentation for the Blueberry Internal Developer Platform.

This directory contains all operational documentation for managing and maintaining the Blueberry Internal Developer Platform.

This guide provides comprehensive security documentation for the Blueberry Internal Developer Platform, covering policies, procedures, and best practices.

This document explains the monitoring, readiness checks, and background task systems in Blueberry IDP through architectural diagrams.

This guide explains how to set up and configure cost tracking for the Blueberry IDP.

This guide provides operational procedures to verify that cost tracking is working correctly and storing accurate data for the Blueberry IDP.

This document describes the provisioning time tracking system implemented in Blueberry IDP.

Documentation for default node service account in guides

Comprehensive guide to monitoring the Blueberry IDP infrastructure and applications.

Standard operating procedures for Blueberry IDP on-call engineers.

The readiness checks were too aggressive, marking environments as FAILED too quickly during normal provisioning in GKE Autopilot:

Quick reference for diagnosing and resolving common issues in the Blueberry IDP.

Blueberry automatically handles Kubernetes secrets for every ephemeral environment.

Welcome to the Blueberry Internal Developer Platform API documentation. This section provides comprehensive reference for all REST API endpoints.

This directory contains technical reference documentation for the Blueberry Internal Developer Platform.

This directory contains documentation for Blueberry IDP's configuration loading mechanisms and priority systems.

This directory contains comprehensive documentation for Blueberry IDP's configuration management system.

This directory contains documentation for Blueberry IDP's configuration validation and warning systems.

The Environments API is the core of the Blueberry IDP, providing endpoints for creating, managing, and monitoring ephemeral environments.

The Health API provides endpoints for monitoring the service status and readiness of the Blueberry IDP.

This directory contains documentation for Blueberry IDP's Kubernetes deployment configuration and integration patterns.

This directory contains documentation for Blueberry IDP's runtime override system and Helm values processing.

This directory contains documentation for Blueberry IDP's secret management workflows and security patterns.

The Webhooks API enables external systems to integrate with Blueberry IDP by sending event notifications and triggering actions.

This directory contains comprehensive setup documentation organized by deployment phases. Follow the guides in order for a complete Blueberry IDP deployment.

Prerequisite:

Prerequisite:

This guide shows how to set up GitLab CI to automatically create and update ephemeral environments for your pull requests using Blueberry IDP.

This document describes the dedicated service account for GitLab CI/CD operations.

**Phase**: 1 - Prerequisites & Secrets

This guide explains how to set up GitLab webhook notifications to receive Slack messages when your pipeline completes.

**Duration**: 30-45 minutes

**Duration**: 45-60 minutes

**Duration**: 15-30 minutes

**Duration**: 30-45 minutes

**Duration**: 30-45 minutes

**Duration**: 15-30 minutes

**Duration**: 30-60 minutes

**Phase**: 1 - Prerequisites & Secrets

If you're seeing a 403 Forbidden error when trying to authenticate with Firebase, or the Firebase Auth REST API returns 404 errors, it means Firebase Authentication is not properly configured for your project.

**Severity:** P1 - Critical

This directory contains comprehensive documentation for all workflows in the Blueberry Internal Developer Platform. Workflows are organized by category to make them easy to find and understand.

This directory contains documentation for Blueberry IDP's configuration workflows and environment management processes.

Core workflows are the essential processes that power the Blueberry IDP. These workflows handle the fundamental operations of creating, managing, and destroying environments.

This workflow creates a new ephemeral environment in the Blueberry IDP for testing pull requests or feature branches. The environment is automatically provisioned with all required services and is accessible via a unique URL.

**Last Updated:** 2024-01-10

Developer workflows guide contributors and users through common development tasks, from initial setup to advanced debugging techniques.

This workflow processes GitHub pull request webhooks to automatically create and manage ephemeral environments. When a PR is opened, updated, or closed, the webhook triggers appropriate actions in the Blueberry IDP.

**Incident Number:** INC-[YYYY-MM-DD-###]

Procedures and playbooks for handling incidents in the Blueberry IDP.

Integration workflows handle connections between the Blueberry IDP and external systems, enabling seamless operation across multiple platforms and services.

Operational workflows cover the day-to-day procedures for running and maintaining the Blueberry IDP in production.

Standardized procedures for routine operational tasks in the Blueberry IDP.

Security workflows ensure the Blueberry IDP maintains strong security posture through proper authentication, authorization, and compliance procedures.

The endpoint `/api/environments/{environment_id}/extend-ttl` is implemented in `blueberry/api/environments.py`. It handles:

This directory contains reusable templates for common workflows. These templates provide a starting point for documenting new workflows and ensure consistency across all workflow documentation.

[Provide a brief 1-2 sentence description of what this workflow accomplishes and when it should be used.]