artifact storage.md
Host graphql api with Gin: stored input and output artifacts
Summary
Deploy a graphql api built with Gin on Ample using the generated downloads 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 Gin: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Not separately tested: your export formats, retention policy and entitlement model; treat the graphql api-specific behavior as your application code.
Infrastructure requirements
- Compute: verified (Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.)
- Postgres: verified (Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.)
- S3-compatible object storage: verified (Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.)
Prerequisites
- A Gin project that builds and starts with the documented commands (CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build))
- A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)
- A bucket from
ample bucket createwith its credentials passed as encrypted S3_* environment variables - An Ample account token with servers:write, databases:read, buckets:read
Exact tested configuration
- template:
ubuntu-24.04 - runtime:
go - size:
s-1vcpu-1gb - build:
CGO_ENABLED=0 go build -o app ./... - start:
./app
Steps
Build and start. CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build). The server must bind 0.0.0.0 on PORT.
Implement the pattern on PostgreSQL. The fixture's module implements generated downloads: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.
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.
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.
ample deploy . --name <app-name> --public --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=...Verify. Fetch the live URL and the pattern self-test route(s) (/p/generated-downloads) from the example; then run your own checks. On failure read
ample logs <deployment_id> --kind buildthen--kind runtime.ample logs <deployment_id> --kind build
Tested examples
- Gin pattern fixture (tests/deploy-canaries/gin-patterns): Multi-pattern Gin app whose generated downloads module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
Success checks
- app responds on its public URL (
/on the live URL, expect ample canary gin patterns) - generated-downloads self-test (
/p/generated-downloadson the live URL, expect export=ok rows=3 (with ?token=...; 401 without))
Limitations
- Verified on the ubuntu-24.04 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Gin major versions are not verified.
- The graphql api itself (your export formats, retention policy and entitlement model) 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.
Cost estimate
Estimated 10.00 USD per month (size prices from pricing.toml at build revision a1b8c38919e59cd035ebabaced73cf84ece24371).
- app server x1
s-1vcpu-1gb: 5.00 USD - managed PostgreSQL database x1
s-1vcpu-1gb: 5.00 USD
Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.
Verification evidence
- canary_run on 2026-09-21T01:15:54Z at revision
50dbac567d2c5cc8e55e6c748a646be0025d9cfb-dirty (CLI 0.1.21): Gin pattern fixture deployed on Ample (CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build)); checks passed for generated-downloads and configuration-secrets. Pattern proof: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). (expires 2027-03-20T01:15:54Z) - canary_run on 2026-09-20T02:43:30Z at revision
199ff1dfd52683832ae75d3f98b53a7a4bff7f96-dirty (CLI b75e104): The same Gin app deployed with a --release-command migration; the marker it created was readable after activation. (expires 2027-03-19T02:43:30Z)
Last verified: 2026-09-21T01:15:54Z
Execution binding
MCP tool ample_deploy (registry mcp:ample_deploy), schema hash 876465fce906da0c observed 2026-09-21T03:19:59.461917+00:00 at revision 49962bcade4f, binding state current, required scopes: servers:write, databases:read, buckets:read.
Input schema
{
"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"
}
},
"required": [
"env",
"name",
"path"
],
"type": "object"
}
Next actions
- Browse the catalog index (GET /v1/catalog on the api origin; auth: false, approval: false)
- Search published recipes by intent, stack and constraints (POST /v1/catalog/search on the api origin; auth: false, approval: false)
- Prepare a side-effect-free deployment plan for an authorized project (POST /v1/catalog/plan on the api origin; auth: true, approval: false)
- Read the existing agent authentication setup (GET /mcp/setup on the api origin; auth: false, approval: false)
- Browse GraphQL API (GET /v1/catalog/nodes/workload%3Agraphql-api on the api origin; auth: false, approval: false)
- Browse Gin (GET /v1/catalog/nodes/stack%3Aframework-gin on the api origin; auth: false, approval: false)
- Browse Generated downloads (GET /v1/catalog/nodes/pattern%3Agenerated-downloads on the api origin; auth: false, approval: false)
- Browse Deploy API (GET /v1/catalog/nodes/intent%3Adeploy-api on the api origin; auth: false, approval: false)
Actions describe possible next steps. They are typed data, not commands, and grant no permission.