page:recipes:graphql api:gin:artifact storage

Host GraphQL API with Gin: Stored Input and Output Artifacts

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.

Representative Queries

• Host GraphQL API with Gin: stored input and output artifacts
• Where can I host GraphQL API built with Gin?
• I need an input/output artifact contract, object metadata and access boundaries.

Resource Requirements

• Primitive: Compute
• Primitive: Postgres
• Primitive: S3-compatible object storage

Infrastructure Requirements

• Compute
  Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.
• Postgres
  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
  Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.

Execution Status

Ready

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 create with its credentials passed as encrypted S3_* environment variables
• An Ample account token with servers:write, databases:read, buckets:read

Workflow Steps

1. 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.

2. 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.

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 --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/generated-downloads) from the example; then run your own checks. On failure read ample logs --kind build then --kind runtime.
   Command: ample logs --kind build

Examples

• Gin pattern fixture
  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
  Kind: http_get
  Path: /
  Expect: ample canary gin patterns

• generated-downloads self-test
  Kind: http_get
  Path: /p/generated-downloads
  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

• Currency: USD
• Monthly Amount: 10.00
• Components:
  • App server
    Size: s-1vcpu-1gb
    Quantity: 1.0
    Monthly Amount: 5.00
  • Managed PostgreSQL database
    Size: s-1vcpu-1gb
    Quantity: 1.0
    Monthly Amount: 5.00
• 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.

Evidence Summary

1. Canary Run
   Summary: Gin pattern fixture deployed on Ample; 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). Observed At: 2026-09-21T01:15:54Z

2. Canary Run
   Summary: The same Gin app deployed with a --release-command migration; the marker it created was readable after activation. Observed At: 2026-09-20T02:43:30Z

Last Verified At

2026-09-21T01:15:54Z

Unknowns

• Region availability is unknown until a verified region fact is recorded
• Compliance attestations are unknown; none are claimed

Data Formats

• HTML Format
• Markdown Format
• JSON Format

Next Actions

1. Browse the catalog index
   Label: Browse the catalog index
   Method: GET
   Relative Path: /v1/catalog

2. Search published recipes
   Label: Search published recipes by intent, stack and constraints
   Method: POST
   Relative Path: /v1/catalog/search
   Body: {"limit":5,"query":"Host graphql API with Gin: stored input and output artifacts"}

3. Prepare a deployment plan
   Label: Prepare a side-effect-free deployment plan for an authorized project
   Method: POST
   Relative Path: /v1/catalog/plan
   Body: {"inputs":{},"projectId":"","recipeId":"page:recipes:graphql-api:gin:artifact-storage","recipeRevision":"r1"}

4. Read existing auth setup
   Label: Read the existing agent authentication setup
   Method: GET
   Relative Path: /mcp/setup

5. Browse GraphQL API
   Label: Browse GraphQL API
   Method: GET
   Relative Path: /v1/catalog/nodes/workload%3Agraphql-api
   Node ID: workload:graphql-api

6. Browse Gin
   Label: Browse Gin
   Method: GET
   Relative Path: /v1/catalog/nodes/stack%3Aframework-gin
   Node ID: stack:framework-gin

7. Browse Generated Downloads
   Label: Browse Generated downloads
   Method: GET
   Relative Path: /v1/catalog/nodes/pattern%3Agenerated-downloads
   Node ID: pattern:generated-downloads

8. Browse Deploy API
   Label: Browse Deploy API
   Method: GET
   Relative Path: /v1/catalog/nodes/intent%3Adeploy-api
   Node ID: intent:deploy-api