Local dev configuration (airplane.dev.yaml)

The context in which tasks and views are executed locally can be customized through local resources, config variables, and environment variables. This configuration is managed via the Studio UI and persisted to an airplane.dev.yaml file.
The following is a complete reference of fields supported by the airplane.dev.yaml file.
For more information, see Studio.

Resources
Resources are registered with the local dev server when developing a task locally.
resources
list
Top-level field that stores a list of resources.
yaml
Copied
1
// airplane.dev.yaml
2
resources:
3
  - slug: db
4
    name: My database
5
    kind: postgres
6
    # The following fields are resource-specific.
7
    host: localhost
8
    port: "5432"
9
    ssl: disable
10
    username: postgres
11
    password: password
12
    database: postgres

Common fields

slug
string
REQUIRED
A unique identifier that is used to reference the resource in a task. This should match the slug that's included in your resource attachments.
name
string
REQUIRED
A human-readable name for the resource.
kind
string
REQUIRED
The kind of the resource—for a complete list of resource kinds, see the Resource page.

Resource-specific fields
For an exhaustive list of fields that a resource of a specific kind can support, see the Resources reference page.

Config variables
Config variables are referenced by environment variables and config attachments and are loaded into the runtime when developing a task locally.
configVars
object
Top-level field that stores a map of config variables.
yaml
Copied
1
// airplane.dev.yaml
2
configVars:
3
    API_KEY: 1234
4
    <key>: <value>
<key>
string
REQUIRED
The name of the config variable.
<value>
string
REQUIRED
The value of the config variable.

Environment variables
Environment variables are loaded into the runtime when developing a task locally.
envVars
object
Top-level field that stores a map of environment variables.
yaml
Copied
1
// airplane.dev.yaml
2
envVars:
3
    MY_ENV_VAR: foo
4
    <key>: <value>
<key>
string
REQUIRED
The name of the environment variable.
<value>
string
REQUIRED
The value of the environment variable.
PrivacyTermsSupport