Outblocks App configuration
Outblocks App configuration files
| 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
Definitions
Type of the app.
Name of the app. Defaults to directory name.
Environment variables common for all operations.
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.
External URL of the app.
Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.
4 nested properties
Run plugin override. Defaults to first supported plugin available.
Command to be run to for dev mode.
Port override, by default just assigns next port starting from listen-port.
Additional environment variables available local run.
1 nested properties
Run plugin override. Defaults to first supported plugin available.
Command to be run to for dev mode.
Port override, by default just assigns next port starting from listen-port.
Additional environment variables available local run.
Deploy plugin override. Defaults to first supported plugin available.
Minimum scale of container deployment (used if deployment uses a container).
Maximum scale of container deployment (used if deployment uses a container).
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
File/dir patterns to exclude (or force include if starts with '!').
Deploy plugin override. Defaults to first supported plugin available.
Additional environment variables.
CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.
Memory limit in MiB of container deployment.
Minimum scale of container deployment.
Maximum scale of container deployment.
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
5 nested properties
Docker container port to use.
Docker command (CMD) to override.
Docker entrypoint (ENTRYPOINT) to override.
7 nested properties
HTTP path to probe.
GRPC service to probe.
Port to use for probing. If not specified, default container port is used.
Number of seconds after the container has started before probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds.
Number of seconds after which the probe times out. Defaults to 1 second.
When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.
7 nested properties
HTTP path to probe.
GRPC service to probe.
Port to use for probing. If not specified, default container port is used.
Number of seconds after the container has started before probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds.
Number of seconds after which the probe times out. Defaults to 1 second.
When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.
Deploy plugin override. Defaults to first supported plugin available.
Additional environment variables.
Memory limit in MiB of function deployment.
Minimum scale of container deployment (used if deployment uses a container).
Maximum scale of container deployment (used if deployment uses a container).
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
Package patterns to exclude (or force include if starts with '!').
Basic auth realm name, defaults to 'restricted'.
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).
Additional environment variables available during build.
Command to be run to generate output files.
Output dir to where static files end up.
Docker image to use. If specified, will try to pull this image if skip-build is enabled.
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 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.
Docker build-args.
Docker build secrets.
Docker context directory, relative to application dir.
Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.
Additional environment variables available during build.
Command to be run to generate output files.
Output dir to where built files end up.
Docker container port to use.
Docker command (CMD) to override.
Docker entrypoint (ENTRYPOINT) to override.
7 nested properties
HTTP path to probe.
GRPC service to probe.
Port to use for probing. If not specified, default container port is used.
Number of seconds after the container has started before probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds.
Number of seconds after which the probe times out. Defaults to 1 second.
When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.
7 nested properties
HTTP path to probe.
GRPC service to probe.
Port to use for probing. If not specified, default container port is used.
Number of seconds after the container has started before probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds.
Number of seconds after which the probe times out. Defaults to 1 second.
When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.
HTTP path to probe.
GRPC service to probe.
Port to use for probing. If not specified, default container port is used.
Number of seconds after the container has started before probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds.
Number of seconds after which the probe times out. Defaults to 1 second.
When a probe fails, Kubernetes will try failure_threshold times before giving up. Defaults to 3.