OpenFaaS

Deploy OpenFaaS functions using Garden. Requires either the kubernetes or local-kubernetes provider to be configured. Everything else is installed automatically.
Below is the schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide. The reference is divided into two sections. The first section lists and describes the available schema keys. The second section contains the complete YAML schema.
Configuration keys
apiVersion
The schema version of this module's config (currently not used).
Type
Required
Allowed Values
string
Yes
"garden.io/v0"
kind
Type
Required
Allowed Values
string
Yes
"Module"
type
The type of this module.
Type
Required
string
Yes
Example:
type: "container"
name
The name of this module.
Type
Required
string
Yes
Example:
name: "my-sweet-module"
description
Type
Required
string
No
include
Specify a list of POSIX-style paths or globs that should be regarded as the source files for this module. Files that do not match these paths or globs are excluded when computing the version of the module, as well as when responding to filesystem watch events.
Note that you can also exclude files by placing .gardenignore files in your source tree, which use the same format as .gitignore files.
Also note that specifying an empty list here means no sources should be included.
Type
Required
array[string]
No
Example:
include:
  - Dockerfile
  - my-app.js
repositoryUrl
A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
Type
Required
string
No
Example:
repositoryUrl: "git+https://github.com/org/repo.git#v2.0"
allowPublish
When false, disables pushing this module to remote registries.
Type
Required
boolean
No
build
Specify how to build the module. Note that plugins may define additional keys on this object.
Type
Required
object
No
build.dependencies[]
​build > dependencies
A list of modules that must be built before this module is built.
Type
Required
array[object]
No
Example:
build:
  ...
  dependencies:
    - name: some-other-module-name
build.dependencies[].name
​build > dependencies > name
Module name to build ahead of this module.
Type
Required
string
Yes
build.dependencies[].copy[]
​build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
Type
Required
array[object]
No
build.dependencies[].copy[].source
​build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
Type
Required
string
Yes
build.dependencies[].copy[].target
​build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s) to (defaults to same as source path).
Type
Required
string
No
build.command[]
​build > command
The command to run inside the module's directory to perform the build.
Type
Required
array[string]
No
Example:
build:
  ...
  command:
    - npm
    - run
    - build
env
Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with GARDEN) and values must be primitives.
Type
Required
object
No
tasks
A list of tasks that can be run in this module.
Type
Required
array[object]
No
tasks[].name
​tasks > name
The name of the task.
Type
Required
string
Yes
tasks[].description
​tasks > description
A description of the task.
Type
Required
string
No
tasks[].dependencies[]
​tasks > dependencies
The names of any tasks that must be executed, and the names of any services that must be running, before this task is executed.
Type
Required
array[string]
No
tasks[].timeout
​tasks > timeout
Maximum duration (in seconds) of the task's execution.
Type
Required
number
No
tasks[].command[]
​tasks > command
The command to run in the module build context.
Type
Required
array[string]
No
tests
A list of tests to run in the module.
Type
Required
array[object]
No
tests[].name
​tests > name
The name of the test.
Type
Required
string
Yes
tests[].dependencies[]
​tests > dependencies
The names of any services that must be running, and the names of any tasks that must be executed, before the test is run.
Type
Required
array[string]
No
tests[].timeout
​tests > timeout
Maximum duration (in seconds) of the test run.
Type
Required
number
No
tests[].command[]
​tests > command
The command to run in the module build context in order to test it.
Type
Required
array[string]
No
tests[].env
​tests > env
Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with GARDEN) and values must be primitives.
Type
Required
object
No
dependencies
The names of services/functions that this function depends on at runtime.
Type
Required
array[string]
No
handler
Specify which directory under the module contains the handler file/function.
Type
Required
string
No
image
The image name to use for the built OpenFaaS container (defaults to the module name)
Type
Required
string
No
lang
The OpenFaaS language template to use to build this function.
Type
Required
string
Yes
Complete YAML schema
apiVersion: garden.io/v0
kind: Module
type:
name:
description:
include:
repositoryUrl:
allowPublish: true
build:
  dependencies:
    - name:
      copy:
        - source:
          target: ''
  command:
    []
env: {}
tasks:
  - name:
    description:
    dependencies: []
    timeout: null
    command:
tests:
  - name:
    dependencies: []
    timeout: null
    command:
    env: {}
dependencies: []
handler: .
image:
lang:
Helm
Providers
Last updated last month
OpenFaaS

Configuration keys

`apiVersion`

`kind`

`type`

`name`

`description`

`include`

`repositoryUrl`

`allowPublish`

`build`

`build.dependencies[]`

`build.dependencies[].name`

`build.dependencies[].copy[]`

`build.dependencies[].copy[].source`

`build.dependencies[].copy[].target`

`build.command[]`

`env`

`tasks`

`tasks[].name`

`tasks[].description`

`tasks[].dependencies[]`

`tasks[].timeout`

`tasks[].command[]`

`tests`

`tests[].name`

`tests[].dependencies[]`

`tests[].timeout`

`tests[].command[]`

`tests[].env`

`dependencies`

`handler`

`image`

`lang`

Complete YAML schema
