Outblocks project configuration

Outblocks project configuration files

Type OutblocksProject
File match project.outblocks.yaml project.outblocks.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/outblocks-project-configuration/latest.json
Source https://raw.githubusercontent.com/outblocks/outblocks-cli/master/schema/schema-project.json

Validate with Lintel

npx @lintel/lintel check
Type: OutblocksProject

Definitions

OutblocksProject object
name string
dns object[]
state object
2 nested properties
type string required

State type, plugin specific value e.g. 'gcp' for gcp plugin or use 'local' for local state.

path string

Path of local state, used only when state type is 'local'.

secrets object
1 nested properties
type string

Secrets provider type, plugin specific value e.g. 'gcp' for gcp plugin.

dependencies object
monitoring object
3 nested properties
plugin string

Monitoring plugin override. Defaults to first supported plugin available.

channels MonitoringChannel[]

Monitoring notification channels.

targets MonitoringTarget[]

Monitoring targets.

plugins Plugin[]

Project-wide plugins.

defaults object
3 nested properties
deploy object
1 nested properties
plugin string

Deploy plugin override. Defaults to first supported plugin available.

dns object
1 nested properties
plugin string

DNS plugin override. Defaults to first supported plugin available.

run object
2 nested properties
plugin string

Run plugin override. Defaults to first supported plugin available.

env Record<string, string>

Additional environment variables added to every app that supports environment variables.

DNS object[]
SSL object
cert_file string

Public key file path. Required to be in PEM format.

key_file string

Private key file path. Required to be in PEM format.

cert string

Public key value in PEM format.

key string

Private key value in PEM format.

State object
type string required

State type, plugin specific value e.g. 'gcp' for gcp plugin or use 'local' for local state.

path string

Path of local state, used only when state type is 'local'.

Secrets object
type string

Secrets provider type, plugin specific value e.g. 'gcp' for gcp plugin.

Dependencies object
DependencyDatabaseUser object
password string

Explicitly set password, defaults to a randomly generated string.

hostname string

Hostname that user is allowed to connect from. Not all databases may support it.

DependencyStorageCORS object
origins string[]

The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".

methods string[]

The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".

response_headers string[]

The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

max_age_in_seconds integer

The value in seconds to return in the Access-Control-Max-Age header used in preflight responses.

DependencyRun object
plugin string
DependencyDeploy object
plugin string
Monitoring object
plugin string

Monitoring plugin override. Defaults to first supported plugin available.

channels MonitoringChannel[]

Monitoring notification channels.

targets MonitoringTarget[]

Monitoring targets.

MonitoringChannel object
type string required

Notification channel type. Possible values: slack, email.

Values: "slack" "email"
MonitoringTarget object
url string required

Target full url.

frequency integer

Check frequency in minutes. Defaults to 5 minutes.

Values: 1 5 10 15
locations string[]

Check locations to use. Defaults to 'all'.

Plugin object
name string required
Defaults object
deploy object
1 nested properties
plugin string

Deploy plugin override. Defaults to first supported plugin available.

dns object
1 nested properties
plugin string

DNS plugin override. Defaults to first supported plugin available.

run object
2 nested properties
plugin string

Run plugin override. Defaults to first supported plugin available.

env Record<string, string>

Additional environment variables added to every app that supports environment variables.

DefaultDeploy object
plugin string

Deploy plugin override. Defaults to first supported plugin available.

DefaultDNS object
plugin string

DNS plugin override. Defaults to first supported plugin available.

DefaultRun object
plugin string

Run plugin override. Defaults to first supported plugin available.

env Record<string, string>

Additional environment variables added to every app that supports environment variables.