Page 2 of 8~120 min topic

Deploy a RAG app

Define config pins and health-contract fields

Types and env contracts make **containerized café FAQ RAG with readiness probes and versioned index pin** fail closed before any provider or cluster call.

~15 min this pageData contract

1Learn the idea

Read

Define trusted borders

Implement types or schemas around GET /readyz so illegal states are unrepresentable at the boundary. For containerized café FAQ RAG with readiness probes and versioned index pin, trusted inputs come from sessions, signatures, pinned digests, or workload identity — not from free-form model text. platform engineer shipping faq-index@sha256:a1b2 to staging should be able to read the contract and know which fields are optional, which are enumerated, and which abort the request. Constructors and boot paths must not perform provider side effects; injection points keep tests honest.

Read

Environment and secrets contract

Document required env vars in .env.example with placeholders only. Rotation story belongs later, but the contract already forbids printing secrets and forbids defaulting to fail-open when a dependency is missing. Invariant to encode in types/tests: readyz fails if index digest ≠ pinned digest; rollback restores previous digest in < 2 min. If a config number lacks units, fix the name (timeout_ms, rpm_hard) before writing logic.

Read

Implementation artifact

@app.get("/readyz")
def readyz():
    live = load_digest()
    if live != os.environ["INDEX_DIGEST"]:
        raise HTTPException(503, "index_digest_mismatch")
    return {"ready": True, "digest": live}

Read

Fixture kit

Create fixtures for the golden path and for DEPLOY-EMPTY-INDEX-5. Name files after the behavior (429-retry-after.json, cross-tenant.json, empty-citation.json) rather than test1. Each fixture carries expected status/code. This kit is the shared language for validation and failure pages.

Read

Stage depth

Compatibility promise: additive fields may appear only if readers ignore unknowns safely; breaking changes bump a version visible on the wire. For AI payloads, size limits arrive before JSON parse when hostile blobs are a risk. Document how clock skew, idempotency keys, and tracing headers travel through containerized café FAQ RAG with readiness probes and versioned index pin. If you use feature flags later, the contract already states that flags are not authorization. Link each config knob to a unit and a failure mode (“0 means disabled” vs “0 means divide-by-zero”). A peer reviewing the PR should find DEPLOY-EMPTY-INDEX-5 named in a comment on the adversarial fixture.

Read

Field notes for `deploy-rag-app` / `setup-and-contract`

Generate OpenAPI or a typed client only after the hand schema is stable for one fixture round-trip. Record how errors look on the wire — problem+json, envelope, or bare status — and stick to one. Clock sources must be injectable for skew tests. If webhooks appear later, document signature header names now even as TODOs. Keep sample payloads UTF-8 and free of real emails. Add a makefile or npm script that validates schemas without network. In this chapter the product is containerized café FAQ RAG with readiness probes and versioned index pin, the human stakeholder is platform engineer shipping faq-index@sha256:a1b2 to staging, and the incident id you design against is DEPLOY-EMPTY-INDEX-5. Re-state the oracle in your notes — kubectl rollout status shows ready; /readyz 200 only when index pin matches — and keep the invariant visible: readyz fails if index digest ≠ pinned digest; rollback restores previous digest in < 2 min. Track ready_ratio == 1 and citation_miss_rate ≤ 0.02 during rollout as the scoreboard. Surface under change control: GET /readyz. If you only have forty minutes, finish the fixture for new pods serve empty index while old pods terminate — citation miss spike before polishing UI. Promotion language stays ternary: promote, hold, or roll back based on evidence, not hope.

Go deeper

Before you start

Why this matters

For Deploy a RAG app, sketch the request and response shapes that cross GET /readyz without naming a framework. Mark which fields are trusted (session, signatures, digests) versus untrusted (user text, model JSON, webhook bodies). If a field can change authorization, it does not belong in model output. Predict one 422/401 you will assert before coding adapters for containerized café FAQ RAG with readiness probes and versioned index pin.

In the wild

See how this idea shows up as a product and a company — then come back to the lesson. Skills transfer across vendors.

Check your understanding

Page assessment

Answer from memory. Completion is saved from this evidence, not from opening the next page.

1. Can a newcomer list trusted vs untrusted fields?
2. Does boot avoid external side effects?
3. Are fixtures named after DEPLOY-EMPTY-INDEX-5-class failures?

All responses are required.