OpenFaaS

Last updated 22 days ago

Below is the schema reference for the openfaas provider. For an introduction to configuring a Garden project with providers, 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

project

Type

Required

object

No

project.environments[]

project > environments

Type

Required

array[object]

No

project.environments[].providers[]

project > environments > providers

Type

Required

array[object]

No

project.environments[].providers[].name

project > environments > providers > name

The name of the provider plugin to use.

Type

Required

string

Yes

Example:

project:
...
environments:
- providers:
- name: "openfaas"

project.environments[].providers[].hostname

project > environments > providers > hostname

The hostname to configure for the function gateway. Defaults to the default hostname of the configured Kubernetes provider.

Important: If you have other types of services, this should be different from their ingress hostnames, or the other services should not expose paths under /function and /system to avoid routing conflicts.

Type

Required

string

No

Example:

project:
...
environments:
- providers:
- hostname: "functions.mydomain.com"

Complete YAML schema

project:
environments:
- providers:
- name:
hostname: