ClearlyOps Internal Documentation

This site contains internal documentation for deployment, operations, and development.

Quick Links

• Deployment Guide - Deploy ClearlyOps to Cloud Run or GCE
• Docs Hosting - How the documentation site is hosted
• Config Environment Variables - All configuration options

Architecture

ClearlyOps consists of:

1. API Service - FastAPI application serving /api/v1/* endpoints
2. PostgreSQL Database - Event store, projections, and queue tables
3. Workers - Background processors for reconciliation and projections
4. Reverse Proxy (optional) - nginx for TLS termination and routing

Development

Running Locally

# Install dependencies
pip install -e ".[dev]"

# Start the API server
uvicorn api.main:app --reload

# Health check
curl http://localhost:8000/health

Generating Documentation

python scripts/generate_docs.py
mkdocs build --strict

Agent Infrastructure Operations

Infrastructure can be managed programmatically using:

# Plan changes (dry-run)
python scripts/setup_docs_infra.py plan --config deploy/infra/docs.toml

# Apply changes
python scripts/setup_docs_infra.py apply --config deploy/infra/docs.toml --confirm docs-internal.clearlyops.com

# Check status
python scripts/setup_docs_infra.py status --format json

See deploy/infra/docs.toml for configuration.