Skip to Content

Site file

One static site of a linked project.

Schema definition: SiteFile.

Example

A minimal projects/<project>/sites/<site>.yaml:

projects/web/sites/docs.yaml
# yaml-language-server: $schema=https://a-line.cloud/schemas/iac/v1.json
version: 1
source:
  repo: example/docs

Fields

allow_delete

Type: boolean, optional.

Let removing this file delete the resource (held until confirmed).

autoscaling

Type: AutoscalingSpec, optional.

Scale the site's server pods between min and max (at least 1) on cpu, memory or cron triggers, like an app's autoscaling; a site never scales to zero. Not together with replicas.

domains

Type: list of DomainSpec, optional.

Custom domains routed to the site, the same entries as an app's domains without port (the static server's is fixed); path_prefix defaults to /. When set, the list is the site's domains: one added in the console but missing here is removed by the sync. Left out, the site's domains are managed in the console.

http

Type: HttpSpec, optional.

The site's HTTP settings, the same keys as an app's http.

mode

Type: string, optional.

versioned (the default): every deploy is a new immutable version. live: one mutable file tree, revalidated on change.

replicas

Type: integer, optional, format uint32.

A fixed number of server pods, at least 1 (default 1). More than one keeps the site up through a node drain or a pod restart. Not together with autoscaling; setting it turns autoscaling off.

retain_versions

Type: integer, optional, format uint32.

How many versions a versioned site keeps, 1 to 100 (default 20).

settings

Type: SiteSettings, optional.

Build settings (install and build command, output directory, SPA fallback). A present mapping replaces all of them.

source

Type: SiteSourceSpec, optional.

The repository the site is built from. A site is created only from a git source.

version

Type: SchemaVersion, required.

The IaC schema version this file is written for.

On this page