Configuration reference

The keys the v4 schema accepts, grouped by the block they belong to. Defaults are what you get when the key is absent, not what a generated file would contain. The keys are the same whether you write YAML, JSON or the executable form TypeScript configuration covers.

Top level

env is validated at 100 keys at most, each value a string of 65536 characters at most, and then goes unused: no part of the build or the provisioning pipeline applies it, so a name written there appears in neither a build nor a running Function. Set variables with the console, the CLI or the API instead. Unknown keys at this level pass validation and are discarded too.

functions.<pattern>

The key is a glob, or a regular expression anchored at both ends when it is not the name of an existing file. Every file it matches becomes one Function.

runtime, memory, max_duration, includeFiles, and excludeFiles merge across every pattern that matches a file, with later patterns winning. symlinks and schedule are read only from the pattern that first produced the file.

routes[]

An entry in has or missing is { type: host, value }, or { type: header | cookie | query, key, value } where value is optional. Both are validated strictly and then ignored.

images

Supplying the block fills in every key you leave out. Omitting it emits no policy.

A localPatterns entry takes pathname (1 to 2048 characters) and search. A remotePatterns entry requires hostname (1 to 253 characters) and takes protocol (http or https), port, pathname, and search. A variant name matches ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$ and sets at least one of width (1 to 8192), height (1 to 8192), quality (1 to 100), format, and fit (contain, cover, fill, inside, outside).

services.storage

services:
  storage:
    buckets:
      user-uploads: null
      brand-assets:
        visibility: public

buckets is required when storage is present. A bucket name is 3 to 63 characters of lowercase letters, digits, and hyphens, starting and ending alphanumeric, and it may not look like a UUID. The value is null, {}, or { visibility: public | private }, and visibility defaults to private.

Provisioning is additive and scoped to the deployment's environment. A repeated deployment reuses an existing bucket without changing its visibility, and a bucket you stop declaring is never deleted. Declaring buckets on a deployment that has no environment fails the build. Buckets covers what you then do with them.

When the file is rejected

One more check runs outside the build. gigadrive deploy reads the parser's error list before uploading and refuses a project that resolves to no Functions, no assets and no routes: The current project config does not resolve to any functions, assets or routes and can not be deployed. An archive uploaded without that check is unpacked and read the same way, and the deployment fails with the same message before any build starts. The build itself never reads that list.