Add health check endpoints

[sangwa]

Also compacts CLAUDE.md

Summary by CodeRabbit

Release Notes

• New Features

  • Added health check endpoints: /healthz/live returns the current server status, and /healthz/ready indicates when the server is ready to handle requests.

• Documentation

  • Simplified project documentation including architecture descriptions, configuration loading, operational constraints, and CI/CD workflows.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 80b026f8-4f3a-4267-add6-3474792cc0dc

📥 Commits

Reviewing files that changed from the base of the PR and between 225ac21 and dc8dd79.

📒 Files selected for processing (5)

• CLAUDE.md
• internal/crl.go
• internal/health.go
• internal/health_test.go
• internal/server.go

---

Walkthrough

The changes add health-check functionality to the server with a new readiness-tracking mechanism. A ready atomic boolean field is introduced to the Server struct. Two new HTTP endpoints (/healthz/live and /healthz/ready) are registered that return JSON status responses—the liveness endpoint always returns success, while the readiness endpoint returns service-unavailable status until the server is ready. The server marks itself ready after initial CRL cache refresh completes (or immediately if no CRL URLs are configured). Documentation is simplified across architecture descriptions, configuration guidance, and operational constraints, removing verbose implementation details while retaining key behaviors.

Sequence Diagram

sequenceDiagram
    participant Client
    participant Server
    participant CRL Cache
    participant Readiness State

    rect rgba(70, 130, 180, 0.5)
        Note over Server,Readiness State: Server Startup
        Server->>CRL Cache: runCRLRefresh() (if crlCache exists)
        CRL Cache->>CRL Cache: refreshAll()
        CRL Cache->>Readiness State: s.ready.Store(true)
    end

    rect rgba(144, 238, 144, 0.5)
        Note over Client,Readiness State: Health Check Requests
        Client->>Server: GET /healthz/live
        Server->>Client: HTTP 200 {"status":"ok"}
    end

    rect rgba(255, 192, 203, 0.5)
        Note over Client,Readiness State: Readiness Check (Before Ready)
        Client->>Server: GET /healthz/ready
        Server->>Readiness State: Check s.ready flag
        Server->>Client: HTTP 503 {"status":"not ready"}
    end

    rect rgba(144, 238, 144, 0.5)
        Note over Client,Readiness State: Readiness Check (After Ready)
        Client->>Server: GET /healthz/ready
        Server->>Readiness State: Check s.ready flag
        Server->>Client: HTTP 200 {"status":"ok"}
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A rabbit's ode to readiness

Health checks hop through the server's core,
Live and ready, watch them soar!
When CRLs dance and caches align,
The ready flag glows—all systems fine! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add health check endpoints' directly and clearly summarizes the main feature introduced in this PR: new HTTP health check endpoints (/healthz/live and /healthz/ready) with their readiness logic.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/health-checks

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}