{"catalogRevision":"cat_f13ab9a494120b5e","recipeId":"page:recipes:documentation-site:django:relational-content","recipeRevision":"r1","canonicalPath":"/recipes/documentation-site/django/relational-content","label":"Host documentation site with Django: Postgres-backed content","family":"Workload recipe","summary":"Deploy a documentation site built with Django on Ample using the relational records pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL, and a published bucket serves public assets from the CDN host. Verified on Django: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Not separately tested: your record schema, states and access rules; treat the documentation site-specific behavior as your application code.","representativeQueries":["Host documentation site with Django: Postgres-backed content","Where can I host Documentation site built with Django?","I need a content schema, publishing workflow and cache behavior after content updates."],"breadcrumbIds":["discovery","workload","workload:sites-and-content","workload:documentation-site","page:recipes:documentation-site:django:relational-content"],"breadcrumbs":[{"id":"discovery","label":"Agent hosting discovery","canonicalPath":"/discover/discovery","kind":"root"},{"id":"workload","label":"Applications and workloads","canonicalPath":"/discover/workload","kind":"facet"},{"id":"workload:sites-and-content","label":"Sites and content","canonicalPath":"/discover/workload/sites-and-content","kind":"group"},{"id":"workload:documentation-site","label":"Documentation site","canonicalPath":"/discover/workload/documentation-site","kind":"atom"},{"id":"page:recipes:documentation-site:django:relational-content","label":"Host documentation site with Django: Postgres-backed content","canonicalPath":"/recipes/documentation-site/django/relational-content","kind":"recipe"}],"parentIds":["workload:documentation-site","stack:framework-django","pattern:relational-records","intent:deploy-web-app"],"parents":[{"id":"workload:documentation-site","label":"Documentation site","canonicalPath":"/discover/workload/documentation-site","kind":"atom"},{"id":"stack:framework-django","label":"Django","canonicalPath":"/discover/stack/framework-django","kind":"atom"},{"id":"pattern:relational-records","label":"Relational records","canonicalPath":"/discover/pattern/relational-records","kind":"atom"},{"id":"intent:deploy-web-app","label":"Deploy web app","canonicalPath":"/discover/intent/deploy-web-app","kind":"atom"}],"resourceRequirements":["primitive:compute","primitive:postgres","primitive:cdn"],"infrastructureRequirements":[{"primitiveId":"primitive:compute","label":"Compute","canonicalPath":"/discover/primitive/compute","status":"verified","summary":"Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes."},{"primitiveId":"primitive:postgres","label":"Postgres","canonicalPath":"/discover/primitive/postgres","status":"verified","summary":"Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied."},{"primitiveId":"primitive:cdn","label":"CDN","canonicalPath":"/discover/primitive/cdn","status":"verified","summary":"The CDN host serves objects from published buckets. It does not front app compute and is not a cache or key-value store."}],"framework":"Django","workload":"Documentation site","releaseStatus":"published","supportStatus":"verified","executionStatus":"ready","docsOnly":false,"prerequisites":["A Django project that builds and starts with the documented commands (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template)","A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)","A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables","An Ample account token with servers:write, databases:read, buckets:read"],"testedConfiguration":{"template":"python-3.12","runtime":"python","size":"s-1vcpu-1gb","install":"python3 -m pip install --target .ample/python -r requirements.txt","start":"PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py"},"inputSchema":{"additionalProperties":false,"properties":{"env":{"description":"Encrypted environment variables (bucket credentials, secrets)","items":{"pattern":"^[A-Z][A-Z0-9_]*=.*$","type":"string"},"maxItems":50,"type":"array"},"name":{"description":"App name","maxLength":63,"minLength":1,"pattern":"^[a-z0-9-]+$","type":"string"},"path":{"description":"Project directory or ample.toml service","maxLength":512,"minLength":1,"type":"string"},"release_command":{"description":"Migration command run before activation","maxLength":512,"type":"string"},"start":{"description":"Start command (Python apps pass one explicitly)","maxLength":512,"type":"string"}},"required":["env","name","path","start"],"type":"object"},"outputSchema":null,"workflowSteps":[{"title":"Build and start","body":"pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template. The server must bind 0.0.0.0 on PORT."},{"title":"Implement the pattern on PostgreSQL","body":"The fixture's module implements relational records: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Copy the approach into your schema; keep migrations idempotent and run them with --release-command."},{"title":"Wire object storage","body":"Create the bucket(s), then pass endpoint, region, bucket and keys as --env values. Use path-style addressing. Keep private data in an unpublished bucket. Publish only the bucket that serves public assets and reference its CDN URL."},{"title":"Deploy","body":"Run the synchronous deploy once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op.","command":"ample deploy . --name <app-name> --public --start \"python3 run.py\" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=..."},{"title":"Verify","body":"Fetch the live URL and the pattern self-test route(s) (/p/relational-records) from the example; then run your own checks. On failure read `ample logs <deployment_id> --kind build` then `--kind runtime`.","command":"ample logs <deployment_id> --kind build"}],"examples":[{"title":"Django pattern fixture","description":"Multi-pattern Django app whose relational records module was checked live; the module is under tests/deploy-canaries/_pattern-modules.","sourceRef":"tests/deploy-canaries/django-patterns"}],"successChecks":[{"description":"app responds on its public URL","kind":"http_get","path":"/","expect":"ample canary django patterns"},{"description":"relational-records self-test","kind":"http_get","path":"/p/relational-records","expect":"records=ok transitions=true isolation=true"}],"limitations":["Verified on the python-3.12 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Django major versions are not verified.","The documentation site itself (your record schema, states and access rules) is application code and was not separately tested; the pattern checks are what was verified.","Region, compliance attestations and request-duration limits are unknown and not claimed.","Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.","Managed PostgreSQL 16 only; extensions, connection limits and backup or restore procedures are not verified; apps and their databases are placed together.","PutObject and GetObject with path-style addressing are verified; multipart upload, listing, presigned URLs and lifecycle rules are not.","The CDN serves published-bucket objects only; cache rules, purge and TTL control are not verified (the fixture sets Cache-Control on upload and versions keys)."],"costEstimate":{"currency":"USD","monthlyAmount":10.0,"authoritative":true,"basis":"size prices from pricing.toml (loaded by the API) at build revision 7cf090725a6f16dd91af7d28356fe72c1b404d6e","components":[{"name":"app server","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0},{"name":"managed PostgreSQL database","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0}],"note":"Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included."},"evidenceSummary":[{"kind":"canary_run","summary":"Django pattern fixture deployed on Ample (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template); checks passed for relational-records and configuration-secrets. Pattern proof: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true).","observedAt":"2026-09-20T03:31:44Z","implementationRevision":"03b6402b1b3e19178985f08ea4033804521d85d4 (CLI b75e104)","expiresAt":"2027-03-19T03:31:44Z","scope":{"checks":["/p/relational-records"],"pattern":"pattern:relational-records","template":"python-3.12"}},{"kind":"canary_run","summary":"The same Django app deployed with a --release-command migration; the marker it created was readable after activation.","observedAt":"2026-09-20T01:54:51Z","implementationRevision":"199ff1dfd52683832ae75d3f98b53a7a4bff7f96 (CLI e3181f5)","expiresAt":"2027-03-19T01:54:51Z","scope":{"pattern":"pattern:relational-records"}}],"lastVerifiedAt":"2026-09-20T03:31:44Z","mcpBinding":{"registryRef":"mcp:ample_deploy","toolName":"ample_deploy","schemaHash":"876465fce906da0c224d62961d3343064108ebe30af80cf1b87094974e948853","observedAt":"2026-09-22T00:31:22.774679+00:00","implementationRevision":"e6446ceea69b","requiredScopes":["servers:write","databases:read","buckets:read"],"bindingState":"current"},"unknowns":["region availability is unknown until a verified region fact is recorded","compliance attestations are unknown; none are claimed"],"formats":{"html":"https://ample.computer/recipes/documentation-site/django/relational-content","markdown":"https://ample.computer/recipes/documentation-site/django/relational-content.md","json":"https://api.ample.computer/v1/catalog/recipes/page%3Arecipes%3Adocumentation-site%3Adjango%3Arelational-content"},"nextActions":[{"actionId":"browse-catalog","label":"Browse the catalog index","operationId":"catalog_index","method":"GET","relativePath":"/v1/catalog","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"search-recipes","label":"Search published recipes by intent, stack and constraints","operationId":"search_recipes","method":"POST","relativePath":"/v1/catalog/search","origin":"api","parameters":{"body":{"limit":5,"query":"Host documentation site with Django: Postgres-backed content"}},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"plan:page:recipes:documentation-site:django:relational-content","label":"Prepare a side-effect-free deployment plan for an authorized project","operationId":"plan_deployment","method":"POST","relativePath":"/v1/catalog/plan","origin":"api","parameters":{"body":{"inputs":{},"projectId":"<workspace or server id you own>","recipeId":"page:recipes:documentation-site:django:relational-content","recipeRevision":"r1"}},"requiresAuthentication":true,"requiresApproval":false},{"actionId":"auth-setup","label":"Read the existing agent authentication setup","operationId":"existing_auth_setup","method":"GET","relativePath":"/mcp/setup","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:workload:documentation-site","label":"Browse Documentation site","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/workload%3Adocumentation-site","origin":"api","parameters":{"nodeId":"workload:documentation-site"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:stack:framework-django","label":"Browse Django","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/stack%3Aframework-django","origin":"api","parameters":{"nodeId":"stack:framework-django"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:pattern:relational-records","label":"Browse Relational records","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/pattern%3Arelational-records","origin":"api","parameters":{"nodeId":"pattern:relational-records"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:intent:deploy-web-app","label":"Browse Deploy web app","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/intent%3Adeploy-web-app","origin":"api","parameters":{"nodeId":"intent:deploy-web-app"},"requiresAuthentication":false,"requiresApproval":false}]}