## Host partner portal with Flask: private documents

### Summary
Deploy a partner portal built with Flask on Ample using the private document library 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, a private S3-compatible bucket holds objects with credentials delivered as encrypted environment variables. Verified on Flask: a role-to-document access model with negative tests (401 without identity, 403 for the wrong role) and a private-bucket round-trip for the allowed role (private=ok). Not separately tested: your identity integration and role assignments; treat the partner portal-specific behavior as your application code.

### Framework
Flask

### Workload
Partner portal

### Release Status
Published

### Support Status
Verified

### Execution Status
Ready

### Costs
- **Currency:** USD
- **Monthly Amount:** $10.00
- **Basis:** size prices from pricing.toml (loaded by the API) at build revision 1ac5595375130d45290090e82ed0f554ccd45405-dirty

### Prerequisites
1. A Flask project that builds and starts with the documented commands (pip install into .ample/python from requirements.txt, then waitress from app.py reading PORT on the python-3.12 template).
2. A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env).
3. A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables.
4. An Ample account token with servers:write, databases:read, buckets:read.

### Tested Configuration
- **Template:** python-3.12
- **Runtime:** python
- **Size:** s-1vcpu-1gb
- **Install Command:** python3 -m pip install --target .ample/python -r requirements.txt
- **Start Command:** PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 app.py

### Workflow Steps
1. **Build and start**  
   pip install into .ample/python from requirements.txt, then waitress from app.py reading PORT on the python-3.12 template. The server must bind 0.0.0.0 on PORT.
2. **Implement the pattern on PostgreSQL**  
   The fixture's module implements private document library: a role-to-document access model with negative tests (401 without identity, 403 for the wrong role) and a private-bucket round-trip for the allowed role (private=ok). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.
3. **Wire object storage**  
   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.
4. **Deploy**  
   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 --public --start "python3 app.py" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=...
5. **Verify**  
   Fetch the live URL and the pattern self-test route(s) (/p/private-document-library) from the example; then run your own checks. On failure read `ample logs --kind build` then `--kind runtime`.  
   
   **Command:** ample logs --kind build

### Examples
- **Title:** Flask pattern fixture  
  **Description:** Multi-pattern Flask app whose private document library module was checked live; the module is under tests/deploy-canaries/_pattern-modules.  
  **Source Ref:** tests/deploy-canaries/flask-patterns

### Evidence Summary
- **Kind:** canary_run  
  **Summary:** Flask pattern fixture deployed on Ample with checks passed for private-document-library and configuration-secrets. 
- **Kind:** canary_run  
  **Summary:** The same Flask app deployed with a --release-command migration; the marker it created was readable after activation.

### Limitations
- Verified on the python-3.12 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Flask major versions are not verified.
- The partner portal itself (your identity integration and role assignments) is application code and was not separately tested; the pattern checks are what was verified.
- Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.