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

Validate with Lintel

npx @lintel/lintel check
Type: OutblocksApp

Definitions

OutblocksApp object
type string required

Type of the app.

Values: "static" "function" "service"
name string

Name of the app. Defaults to directory name.

env Record<string, string>

Environment variables common for all operations.

dir string

Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.

url string

External URL of the app.

path_redirect string

Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.

needs object
run object
4 nested properties
plugin string

Run plugin override. Defaults to first supported plugin available.

command string | string[]

Command to be run to for dev mode.

port integer

Port override, by default just assigns next port starting from listen-port.

env Record<string, string>

Additional environment variables available local run.

cdn object
1 nested properties
enabled boolean
build object
Needs object
Run object
plugin string

Run plugin override. Defaults to first supported plugin available.

command string | string[]

Command to be run to for dev mode.

port integer

Port override, by default just assigns next port starting from listen-port.

env Record<string, string>

Additional environment variables available local run.

StaticDeploy object
plugin string

Deploy plugin override. Defaults to first supported plugin available.

min_scale integer

Minimum scale of container deployment (used if deployment uses a container).

max_scale integer

Maximum scale of container deployment (used if deployment uses a container).

timeout integer

Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

patterns string[]

File/dir patterns to exclude (or force include if starts with '!').

ServiceDeploy object
plugin string

Deploy plugin override. Defaults to first supported plugin available.

env Record<string, string>

Additional environment variables.

cpu_limit number

CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.

memory_limit integer

Memory limit in MiB of container deployment.

min_scale integer

Minimum scale of container deployment.

max_scale integer

Maximum scale of container deployment.

timeout integer

Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

container object
5 nested properties
port integer

Docker container port to use.

command string | string[]

Docker command (CMD) to override.

entrypoint string | string[]

Docker entrypoint (ENTRYPOINT) to override.

liveness_probe object
7 nested properties
http_path string

HTTP path to probe.

grpc_service string

GRPC service to probe.

port integer

Port to use for probing. If not specified, default container port is used.

initial_delay_seconds integer

Number of seconds after the container has started before probes are initiated.

period_seconds integer

How often (in seconds) to perform the probe. Default to 10 seconds.

timeout_seconds integer

Number of seconds after which the probe times out. Defaults to 1 second.

failure_threshold integer

When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.

startup_probe object
7 nested properties
http_path string

HTTP path to probe.

grpc_service string

GRPC service to probe.

port integer

Port to use for probing. If not specified, default container port is used.

initial_delay_seconds integer

Number of seconds after the container has started before probes are initiated.

period_seconds integer

How often (in seconds) to perform the probe. Default to 10 seconds.

timeout_seconds integer

Number of seconds after which the probe times out. Defaults to 1 second.

failure_threshold integer

When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.

Scheduler object[]
FunctionDeploy object
plugin string

Deploy plugin override. Defaults to first supported plugin available.

env Record<string, string>

Additional environment variables.

memory_limit integer

Memory limit in MiB of function deployment.

min_scale integer

Minimum scale of container deployment (used if deployment uses a container).

max_scale integer

Maximum scale of container deployment (used if deployment uses a container).

timeout integer

Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

FunctionPackage object
patterns string[]

Package patterns to exclude (or force include if starts with '!').

CDN object
enabled boolean
StaticBasicAuth object
realm string

Basic auth realm name, defaults to 'restricted'.

users Record<string, string>

Basic auth users in form of user: password where password is either in plain text or in a form of apr1 hash (used by htpasswd).

StaticBuild object
env Record<string, string>

Additional environment variables available during build.

command string | string[]

Command to be run to generate output files.

dir string

Output dir to where static files end up.

ServiceBuild object
image string

Docker image to use. If specified, will try to pull this image if skip-build is enabled.

skip_build boolean

Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.

skip_pull boolean

Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.

build_args Record<string, string>

Docker build-args.

secrets Record<string, string>

Docker build secrets.

context string

Docker context directory, relative to application dir.

dockerfile string

Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.

FunctionBuild object
env Record<string, string>

Additional environment variables available during build.

command string | string[]

Command to be run to generate output files.

dir string

Output dir to where built files end up.

ServiceContainer object
port integer

Docker container port to use.

command string | string[]

Docker command (CMD) to override.

entrypoint string | string[]

Docker entrypoint (ENTRYPOINT) to override.

liveness_probe object
7 nested properties
http_path string

HTTP path to probe.

grpc_service string

GRPC service to probe.

port integer

Port to use for probing. If not specified, default container port is used.

initial_delay_seconds integer

Number of seconds after the container has started before probes are initiated.

period_seconds integer

How often (in seconds) to perform the probe. Default to 10 seconds.

timeout_seconds integer

Number of seconds after which the probe times out. Defaults to 1 second.

failure_threshold integer

When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.

startup_probe object
7 nested properties
http_path string

HTTP path to probe.

grpc_service string

GRPC service to probe.

port integer

Port to use for probing. If not specified, default container port is used.

initial_delay_seconds integer

Number of seconds after the container has started before probes are initiated.

period_seconds integer

How often (in seconds) to perform the probe. Default to 10 seconds.

timeout_seconds integer

Number of seconds after which the probe times out. Defaults to 1 second.

failure_threshold integer

When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.

ServiceContainerProbe object
http_path string

HTTP path to probe.

grpc_service string

GRPC service to probe.

port integer

Port to use for probing. If not specified, default container port is used.

initial_delay_seconds integer

Number of seconds after the container has started before probes are initiated.

period_seconds integer

How often (in seconds) to perform the probe. Default to 10 seconds.

timeout_seconds integer

Number of seconds after which the probe times out. Defaults to 1 second.

failure_threshold integer

When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.