# Planekeeper Internal Docs > Planekeeper internal engineering documentation — architecture, decisions, runbooks, and development guides. This file is an LLM-friendly index of the site, generated by Hugo. Each link points at a clean Markdown rendering of the page (suffix `/index.md`) — token-optimized for LLM ingestion. ## API > API authentication, endpoints, and integration details. - [API Endpoints](https://internal-docs.planekeeper.com/api/endpoints/index.md) - [Authentication](https://internal-docs.planekeeper.com/api/authentication/index.md) ## Architecture > System overview, binaries, and project structure. - [Binaries & Services](https://internal-docs.planekeeper.com/architecture/binaries/index.md) - [Project Structure](https://internal-docs.planekeeper.com/architecture/project-structure/index.md) - [System Overview](https://internal-docs.planekeeper.com/architecture/overview/index.md) ## Configuration > Environment variables and service IDs. - [Environment Variables](https://internal-docs.planekeeper.com/configuration/environment-variables/index.md) - [Service IDs](https://internal-docs.planekeeper.com/configuration/service-ids/index.md) ## Database > Schema design and migration management. - [Database Schema](https://internal-docs.planekeeper.com/database/schema/index.md) - [Migrations](https://internal-docs.planekeeper.com/database/migrations/index.md) ## Development > Commands, coding standards, and common tasks. - [Build Commands](https://internal-docs.planekeeper.com/development/commands/index.md) - [Coding Standards](https://internal-docs.planekeeper.com/development/coding-standards/index.md) - [Common Tasks](https://internal-docs.planekeeper.com/development/common-tasks/index.md) - [Known Pitfalls](https://internal-docs.planekeeper.com/development/known-pitfalls/index.md) ## Operations > Deployment, debugging, and onboarding. - [Build and Deploy Pipeline](https://internal-docs.planekeeper.com/operations/build-and-deploy-pipeline/index.md): How planekeeper code goes from monorepo to running containers — Bazel build, image push, SSH deploy, compose up. - [Getting Started with Planekeeper](https://internal-docs.planekeeper.com/operations/onboarding/index.md) - [Planekeeper Deployment Guide](https://internal-docs.planekeeper.com/operations/deployment/index.md) - [Production Debugging Scenarios](https://internal-docs.planekeeper.com/operations/debugging-production/index.md) ## Reference > Permissions and configuration reference. - [Permissions Reference](https://internal-docs.planekeeper.com/reference/permissions/index.md) ## Testing > E2E test plans and automation strategy. - [E2E Test Automation Strategy](https://internal-docs.planekeeper.com/testing/e2e-automation-strategy/index.md) - [Planekeeper E2E Test Plan](https://internal-docs.planekeeper.com/testing/e2e-test-plan/index.md) ## Troubleshooting > Debugging guides and common issues. - [Troubleshooting Guide](https://internal-docs.planekeeper.com/troubleshooting/guide/index.md) ## Architecture Decision Records - [ADR-001: Multi-Tenant Organization Boundary](https://internal-docs.planekeeper.com/decisions/001-multi-tenant-org-boundary/index.md) - [ADR-002: Dual Authentication (JWT + API Key)](https://internal-docs.planekeeper.com/decisions/002-dual-auth-jwt-and-api-key/index.md) - [ADR-003: Agent Pull-Based Architecture](https://internal-docs.planekeeper.com/decisions/003-agent-pull-architecture/index.md) - [ADR-004: Event-Driven Alert and Notification Pipeline](https://internal-docs.planekeeper.com/decisions/004-event-driven-alerts/index.md) - [ADR-005: SKIP LOCKED for Distributed Job Claims](https://internal-docs.planekeeper.com/decisions/005-skip-locked-distributed-jobs/index.md) - [ADR-006: One Alert Per Config with Upsert](https://internal-docs.planekeeper.com/decisions/006-one-alert-per-config-upsert/index.md) - [ADR-007: Three-Tier OpenAPI Spec Split](https://internal-docs.planekeeper.com/decisions/007-three-tier-openapi-split/index.md) - [ADR-008: UI Communicates via API Only](https://internal-docs.planekeeper.com/decisions/008-ui-api-only-no-direct-db/index.md) - [ADR-009: Generated Route Registration](https://internal-docs.planekeeper.com/decisions/009-generated-route-registration/index.md) - [ADR-010: Casbin v3 IAM-Style Permission System](https://internal-docs.planekeeper.com/decisions/010-casbin-iam-permissions/index.md) - [ADR-011: Global Data Separation](https://internal-docs.planekeeper.com/decisions/011-global-data-separation/index.md) - [ADR-NNN: Title](https://internal-docs.planekeeper.com/decisions/template/index.md) ## Feature Specifications - [Feature: Alerts](https://internal-docs.planekeeper.com/requirements/alerts/index.md) - [Feature: Authentication](https://internal-docs.planekeeper.com/requirements/authentication/index.md) - [Feature: Gather Jobs](https://internal-docs.planekeeper.com/requirements/gather-jobs/index.md) - [Feature: Helm Sync Jobs](https://internal-docs.planekeeper.com/requirements/helm-sync-jobs/index.md) - [Feature: Monitoring Rules](https://internal-docs.planekeeper.com/requirements/monitoring-rules/index.md) - [Feature: Notifications](https://internal-docs.planekeeper.com/requirements/notifications/index.md) - [Feature: Permissions](https://internal-docs.planekeeper.com/requirements/permissions/index.md) - [Feature: Reporting & Analytics](https://internal-docs.planekeeper.com/requirements/reporting/index.md) - [Feature: Scrape Jobs](https://internal-docs.planekeeper.com/requirements/scrape-jobs/index.md) - [Feature: Task Engine](https://internal-docs.planekeeper.com/requirements/task-engine/index.md) - [Feature: Title](https://internal-docs.planekeeper.com/requirements/template/index.md) ## Operational Runbooks - [Runbook: API Key Rotation](https://internal-docs.planekeeper.com/runbooks/api-key-rotation/index.md) - [Runbook: Database Restore](https://internal-docs.planekeeper.com/runbooks/database-restore/index.md) - [Runbook: Dead Letter Recovery](https://internal-docs.planekeeper.com/runbooks/dead-letter-recovery/index.md) - [Runbook: Rollback Migration](https://internal-docs.planekeeper.com/runbooks/rollback-migration/index.md) - [Runbook: Service Recovery](https://internal-docs.planekeeper.com/runbooks/service-recovery/index.md) ## Security Model - [Authentication Flows](https://internal-docs.planekeeper.com/security/authentication-flows/index.md) - [Data Protection](https://internal-docs.planekeeper.com/security/data-protection/index.md) - [Network Isolation](https://internal-docs.planekeeper.com/security/network-isolation/index.md) ## Optional - [Categories index](https://internal-docs.planekeeper.com/categories/) - [Tags index](https://internal-docs.planekeeper.com/tags/)