DigitalOcean App Platform
Reviews App Platform app specs for the mistakes that cause downtime, leaked
secrets, and broken routing. Ships a stdlib-only validator, do_app_spec_lint.py,
that ingests the spec as JSON (recommended), the block-YAML DO emits, or the
digitalocean_app Terraform resource, and reports findings with a rule id,
severity, and a one-line fix.
When to invoke
- Reviewing or authoring an
app.yaml/.do/app.yaml/digitalocean_app. - A service has downtime on deploy or flaps with no warning (health check / HA).
- DigitalOcean warns that
routesis deprecated. - A credential may be sitting in an env
valuein plaintext. - Ingress routing behaves unexpectedly (overlapping prefixes).
Cross-cutting rules
- Prefer JSON input.
doctl apps spec get <app-id> --format jsonis the most reliable input; the YAML path is a subset parser and rejects anchors, flow collections, and folded/literal scalars. - Never put a literal secret in an env
value. Usetype: SECRETand a${VAR}substitution. Values containing${...}(GitHub secrets,${db.X}bindable refs,${APP_URL}app-wide vars) are references, not literals. - The app spec is the source of truth. App Platform reconciles to the spec on every deploy; fix the spec, not the running app.
Running the validator
# JSON (recommended)
doctl apps spec get <app-id> --format json > spec.json
python3 scripts/do_app_spec_lint.py spec.json
# YAML subset, or Terraform — format auto-detected by extension/content
python3 scripts/do_app_spec_lint.py .do/app.yaml
python3 scripts/do_app_spec_lint.py main.tf
# machine-readable
python3 scripts/do_app_spec_lint.py spec.json --format json
Exit 0 = clean or warnings only; 1 = at least one error-severity finding; 2 = unreadable/unparseable input.
Checks
- Secrets —
secret-not-encrypted(literal secret with type != SECRET),secret-build-scope(SECRET scoped RUN_AND_BUILD_TIME leaks into the build). - Reliability —
no-health-check,single-instance(one instance, no autoscaling),dev-db-as-prod(database with production: false). - Correctness —
port-mismatch,route-overlap,source-conflict(both git and image),deprecated-routes. - Sizing —
unknown-instance-slug,db-region-mismatch.
Proactive triggers
- env
valueis a literal API key/token/password (type != SECRET) → flagsecret-not-encrypted; move totype: SECRET+${VAR}. - a
servicehasinstance_count: 1and noautoscaling→ warn single point of failure. - a
servicehas nohealth_check.http_path→ warn deploys can't detect unhealthy instances. - both a git source and an
imageon one component → flagsource-conflict. - component-level
routespresent → recommendspec.ingress.rules. production: falseon a database backing real traffic → warn dev database.