Skip to Content

IaC reference

Every IaC file kind and field, generated from the JSON schema.

An IaC checkout is a directory of small YAML files, one per resource. The path of a file says what it is:

Directory layout

projects/<project>/project.yaml       # ProjectFile
projects/<project>/apps/<app>.yaml    # AppFile
clusters/<name>.yaml                  # ClusterFile
buckets/<name>.yaml                   # BucketFile
storages/<name>.yaml                  # StorageFile
projects/<project>/sites/<site>.yaml  # SiteFile
secrets/<name>.yaml                   # SecretGroupFile
environments/<name>.yaml              # EnvironmentFile
key-rings/<name>.yaml                 # KeyRingFile

File kinds

  • Project file (ProjectFile): A project (Kubernetes namespace) with its applications.
  • App file (AppFile): An application deployed within a project.
  • Cluster file (ClusterFile): One cluster of an infra link.
  • Bucket file (BucketFile): A managed bucket.
  • Storage file (StorageFile): An external storage connection. Its credentials are entered in the UI, or read from an environment secret group when credentials: is set.
  • Site file (SiteFile): One static site of a linked project.
  • Secret group file (SecretGroupFile): One secret group.
  • Environment file (EnvironmentFile): One environment.
  • Key ring file (KeyRingFile): A key ring and its keys.

Shared types are listed on the types page.

Try it

Edit a file below; it is checked against the JSON schema as you type, like an editor with the schema modeline would. References to other files (a project's cluster, an app's pool) are checked when you sync, not here.

projects/web/apps/api.yaml

Checking the file against the schema needs JavaScript.

Advanced: other formats

Single-file formats for tools and one-off imports. Use the directory layout for a linked repository.

  • Manifest (Manifest): Root a-line.yaml manifest. Can be self-contained or reference external files for infrastructure and projects. File: a-line.yaml.
  • Infrastructure file (InfrastructureFile): Cluster infrastructure definition. File: infrastructure.yaml.
  • Org bundle (OrgBundle): The whole document. File: a-line-org.yaml.

On this page