FerryDocs

Top-level keys

A blueprint has four top-level keys. Ferry ignores each other key with a warning.

Edit on GitHub
ferry.yaml
envVarGroups:          # env groups
  - name: shared-settings
databases:             # Postgres databases
  - name: app-db
services:              # services and Redis datastores
  - type: web
    name: hello

A starts one part of the file.

The four keys

Top-level keyContains
envVarGroupsEnv groups: sets of variables that services link to.
databasesPostgres databases.
servicesServices of each type, and Redis datastores (type: redis or keyvalue).
projectsThe projects of Render. Ferry applies their environments[].services, databases and envVarGroups to this server, with a warning. Ferry has no projects and no environments.

Other keys

Ferry ignores each other top-level key with a warning. This includes the x- keys that hold a . The anchor continues to work:

ferry.yaml
x-defaults: &defaults
  autoDeploy: false

services:
  - <<: *defaults 
    type: worker
    name: queue
    repo: https://github.com/acme/queue

See also How Ferry reads values.

On this page