Golem Application Manifest Reference

Optional list of glob patterns that are used for adding search patterns for other Application Manifests when using auto discovery of them. The patterns are relative to the manifest document in which they are defined.

The default search pattern is **/golem.yaml, which searches for golem.yaml documents in every subdirectory recursively. Templates and examples provided by Golem usually use more specific search patterns to make the lookups more efficient.

The includes fields can be defined in one manifest only, usually in the project root directory. Defining it multiple times results in validation error.

includes:
- components-dir/*/golem.yaml
- custom-templates/golem-*.yaml

Required application name which will be used as the deployment name for the application.

Optional path that overrides the default path of the default temporary directory (golem-temp) which is used for storing various intermediate artifacts.

The path is relative to the manifest document in which they are defined.

tempDir: target/golem-temp

Optional list of paths of directories where WIT dependency packages can be stored. The paths are relative to the manifest document in which they are defined.

During component WIT generation these paths are checked for resolving missing dependencies. It is intended to be used for eliminating duplication of common dependencies and interfaces.

The witDeps fields can be defined in one manifest only, usually in the project root directory. Defining it multiple times results in validation error.

witDeps:
- wit-common/deps

Optional object for defining HTTP APIs and HTTP API deployments. APIs and deployments can be defined in multiple manifests, and they are merged during deployment.

Optional map of HTTP API definitions by API name.

Required string version of the API.

Optional project reference for the API.

Optional array of HTTP routes.

Required HTTP method for the route, accepted values:

• CONNECT

  available since1.2.4
• DELETE

  available since1.2.4
• GET

  available since1.2.4
• HEAD

  available since1.2.4
• OPTIONS

  available since1.2.4
• PATCH

  available since1.2.4
• POST

  available since1.2.4
• PUT

  available since1.2.4
• TRACE

  available since1.2.4

Required HTTP path pattern for the route.

Optional ID of the required HTTP API security.

Required API binding.

*Optional binding type, accepted values:

• default(default value)

  available since1.2.4
• cors-preflight

  available since1.2.4
• file-server

  available since1.2.4
• file-handle

  available since1.2.4

Required name of the component to be used in the bindings.

Optional agent name to be used in the bindings.

Optional Rib script for calculating the idempotency key.

Optional Rib script for calculating the invocation context.

Required Rib script for creating the response.

Optional map of HTTP API deployments by environment name.

Optional list of HTTP API deployments for the environment.

Required domain for the deployment.

Required list of HTTP API Definitions for the deployment.

Optional application environments by environment name.

Optional boolean which when set to true marks the environment as default. Only one environment can be marked as default. If missing, the first environment is used as default.

Optional account that owns the application environment. When not specified then the current user will be used.

Optional server configuration for the environment. Accepted values:

• local

  available since1.4.0
• cloud

  available since1.4.0

or a custom server object with the fields documented below.

Required URL for custom servers.

Optional custom URL for golem worker service.

Optional boolean which defaults to false, when set to true it allows insecure connections to the server.

Optional boolean which when set to true selects OAuth2 based authentication.

Optional string static token for authentication when using static token based authentication.

Optional preset name or list of preset names which will be used for the application in the given environment.

Optional default format for the environment, accepted values:

• text(default value)

  available since1.4.0
• json

  available since1.4.0
• pretty-json

  available since1.4.0
• pretty

  available since1.4.0

  alias for pretty-json
• yaml

  available since1.4.0
• pretty-yaml

  available since1.4.0

Optional boolean which when set enables the auto-confirm (yes) flag by default.

Optional boolean which when set enables redeploy-agents flag by default.

Optional boolean which when set enables reset flag by default.

Optional boolean to enable compatibility checks during deployment.

Optional boolean to enable version checks during deployment.

Optional boolean to allow security overrides during deployment.

Optional map of Golem components indexed by component-name-s used for defining components.

The components field can be defined in multiple manifest documents, but the used component-name-s must be unique across all the used manifest documents. Using the same component-name more then once results in validation error.

components:
  pack-ns:component-name:
    sourceWit: # ...
    # ...
  pack:comp-b:
    sourceWit: # ...
    # ...

Optional template name or list of template names which will be used for creating the component fields.

The template name must be one of that are defined in componentTemplates.

See componentTemplates and Template variable and functions for defining templates.

Optional map of presets used to define preset variations for a component.

A preset contains the same fields as a component. Presets can also specify a components.<component-name>.presets.<preset-name>.default flag to mark it as the default preset for selection.

Preset specific components.<component-name>.default.

Optional boolean which when set to true marks the preset as the default for selection.

Optional string enum of component types, accepted values:

• durable(default value)

  available since1.1.0
• ephemeral

  available since1.2.2
• library

  available since1.2.2

See Ephemeral vs Durable Workers for more information about component types.

components:
  pack-ns:component-name:
    # ...
    componentType: durable
  pack-ns:component-name:
    # ...
    componentType: ephemeral

Optional merge mode for components.<component-name>.build. Accepted values:

• append(default value)

  available since1.4.0
• prepend

  available since1.4.0
• replace

  available since1.4.0

Optional list of files entries, which can be used for defining the Initial File System for the component.

components:
  pack-ns:component-name:
    # ...
    files:
    - sourcePath: ./files/foo.txt
      targetPath: /files/foo.txt
      permissions: read-only
    - sourcePath: ./files/bar.txt
      targetPath: /files/bar.txt
      permissions: read-write

Optional merge mode for components.<component-name>.files. Accepted values:

• append(default value)

  available since1.4.0
• prepend

  available since1.4.0
• replace

  available since1.4.0

Required source path of the file to be added to the Initial File System. The path can be a file path relative to the manifest document or an URL.

Required target path of the file in the Initial File System. The path must be an absolute path.

Optional string enum which controls file permissions. Accepted values:

• read-only(default value)

  available since1.1.0
• read-write

  available since1.1.0

Optional list of component plugin installation entries,

Optional merge mode for components.<component-name>.plugins. Accepted values:

• append(default value)

  available since1.4.0
• prepend

  available since1.4.0
• replace

  available since1.4.0

Required name of the plugin.

Required version of the plugin.

Optional account used for installing the plugin.

Optional string map of plugin parameters.

Required directory path for the user defined component WIT directory.

The path is relative to the manifest document in which the field is defined.

The WIT directory can omit the deps folder if the required dependencies are available in some of the folders defined in witDeps.

components:
  pack-ns:component-name:
    # ...
    sourceWit: wit

Optional string map of environment variables for the component.

Optional merge mode for components.<component-name>.env. Accepted values:

• upsert(default value)

  available since1.4.0
• replace

  available since1.4.0
• remove

  available since1.4.0

Required directory path for the generated WIT directory created by the golem tooling, which handles exported interface extraction and includes resolved package and client dependencies.

This directory is intended to be used as source for binding generation.

The path is relative to the manifest document in which the field is defined.

This folder is usually added to .gitignore, as it is generated as part of build.

components:
  pack-ns:component-name:
    # ...
    generatedWit: wit-generated

Required file path which should point to the built component WASM file before linking.

The path is relative to the manifest document in which the field is defined.

This file is usually added to .gitignore, as it is created as part of build.

components:
  pack-ns:component-name:
    # ...
    componentWasm: build/component.wasm

Optional list of component dependencies.

Optional merge mode for components.<component-name>.dependencies. Accepted values:

• append(default value)

  available since1.4.0
• prepend

  available since1.4.0
• replace

  available since1.4.0

Required string enum that defines the dependency type. Accepted values:

• wasm

  available since1.4.0
• wasm-rpc

  deprecated since1.3.0|available since1.4.0
• wasm-rpc-static

  deprecated since1.3.0|available since1.4.0

Required target component name when using a component dependency by name.

Required path of the target component WASM when using path based dependencies.

Required URL of the target component WASM when using URL based dependencies.

Optional file path which should point to the built component WASM file after linking.

Defaults to golem-temp/linked-wasm/component-name.wasm, see tempDir.

The path is relative to the manifest document in which the field is defined.

This file is usually added to .gitignore, as it is created as part of build.

components:
  pack-ns:component-name:
    # ...
    linkedWasm: golem-temp/component/component.wasm

Optional list of build commands that creates components.<component-name>.componentWasm.

components:
  pack-ns:component-name:
    build:
    - command: bindgen-tool wit-generated
    - command: build-tool wit-generated component.wasm

Required external command that will be used as a build step for creating components.<component-name>.componentWasm.

Optional directory path which will be used as working directory when executing components.<component-name>.build[*].command.

The path is relative to the manifest document, and defaults to ..

Optional list of directory paths which will be deleted before executing the command.

The path is relative to components.<component-name>.build[*].dir.

The rmdirs field is useful when a binding generator does not automatically clean stale bindings.

Directories are not removed if the command is skipped because of up-to-date checks, see components.<component-name>.build[*].sources and components.<component-name>.build[*].targets.

Directories are removed before executing components.<component-name>.build[*].mkdirs.

Optional list of directory paths which will be created before executing the command if they do not exists.

The path is relative to components.<component-name>.build[*].dir.

The mkdirs field is useful when a build of binding generator tool does not automatically create required nested folders.

Directories are not created if the command is skipped because of up-to-date checks, see components.<component-name>.build[*].sources and components.<component-name>.build[*].targets.

Directories are created after executing components.<component-name>.build[*].rmdirs.

Optional list of paths and globs which are used as sources for performing up-to-date checks.

If defined then components.<component-name>.build[*].targets also have to be used.

The up-to-date check

• skips executing components.<component-name>.build[*].command
• if all matching files defined by components.<component-name>.build[*].targets
• are newer then the matched files defined by sources.

components:
  pack-ns:component-name:
    # ...
    build:
    - command: build-tool src-dir out.wasm
      sources:
      - src-dir/*
      targets:
      - out.wasm

Optional list of paths and globs which are used as targets for performing up-to-date checks.

If defined then components.<component-name>.build[*].sources also have to be used.

See components.<component-name>.build[*].sources for up-to-date check details.

Optional map of component specific external commands, which are useful for defining e.g. one time installation or update related commands for the component.

The commands can be executed using:

golem exec command-name

Multiple components can use the same command-name, the above command will execute all matching commands in this case, both component specific and project ones.

For defining project level custom commands see customCommands.

components:
  pack-ns:component-name:
    # ...
    customCommands:
      npm-install:
      - command: npm install

Component specific customCommands.<command-name>[*].dir.

Component specific customCommands.<command-name>[*].rmdirs.

Component specific customCommands.<command-name>[*].mkdirs.

Component specific customCommands.<command-name>[*].mkdirs.

Component specific customCommands.<command-name>[*].sources.

Component specific customCommands.<command-name>[*].targets.

Component specific clean.

Optional list of paths which are added as targets to the golem clean command.

The paths are relative to the manifest document.

The clean command deletes the following paths:

• tempDir
• components.<component-name>.generatedWit
• components.<component-name>.linkedWasm
• build and custom command targets
• the paths defined in common and component specific clean fields.

Optional map of custom external commands, which are useful for defining e.g. one time installation or update related project commands.

The commands can be executed using:

golem exec command-name

Components specific custom commands can use the same command-name, the above command will execute all matching commands in this case, both component specific and project ones.

For defining component specific custom commands see components.<component-name>.customCommands.

customCommands:
  npm-install:
  - command: npm install

Optional directory path which will be used as working directory when executing customCommands.<command-name>[*].command.

The path is relative to the manifest document, and defaults to ..

Optional list of directory paths which will be deleted before executing the command.

The path is relative to customCommands.<command-name>[*].dir.

The rmdirs field is useful when a binding generator does not automatically clean stale bindings.

Directories are not removed if the command is skipped because of up-to-date checks, see customCommands.<command-name>[*].sources and customCommands.<command-name>[*].targets.

Directories are removed before executing customCommands.<command-name>[*].mkdirs.

Optional list of directory paths which will be created before executing the command if they do not exists.

The path is relative to customCommands.<command-name>[*].dir.

The mkdirs field is useful when a build of binding generator tool does not automatically create required nested folders.

Directories are not created if the command is skipped because of up-to-date checks, see customCommands.<command-name>[*].sources and customCommands.<command-name>[*].targets.

Directories are created after executing customCommands.<command-name>[*].rmdirs.

Optional list of paths and globs which are used as sources for performing up-to-date checks.

If defined then customCommands.<command-name>[*].targets also have to be used.

The up-to-date check

• skips executing customCommands.<command-name>[*].command
• if all matching files defined by customCommands.<command-name>[*].targets
• are newer then the matched files defined by sources.

Optional list of paths and globs which are used as targets for performing up-to-date checks.

If defined then customCommands.<command-name>[*].sources also have to be used.

See customCommands.<command-name>[*].sources for up-to-date check details.

Optional map of named templates, which can be used in components.<component-name>.templates.

Templates help in extracting common build patterns and reuse them for multiple components.

The templates field can be defined in multiple application manifest documents, but the template names must be unique.

See Template variable and functions for more information about templating.

Templated components.<component-name>.componentType.

Templated components.<component-name>.files.

Templated components.<component-name>.files[*].sourcePath.

Templated components.<component-name>.files[*].targetPath.

Templated components.<component-name>.files[*].permissions.

Templated components.<component-name>.sourceWit.

Templated components.<component-name>.generatedWit.

Templated components.<component-name>.componentWasm.

Templated components.<component-name>.linkedWasm.

Templated components.<component-name>.build.

Templated components.<component-name>.build[*].command.

Templated components.<component-name>.build[*].dir.

Templated components.<component-name>.build[*].rmdirs.

Templated components.<component-name>.build[*].mkdirs.

Templated components.<component-name>.build[*].sources.

Templated components.<component-name>.build[*].targets.

Templated components.<component-name>.customCommands.

Templated components.<component-name>.customCommands.<command-name>[*].dir.

Templated components.<component-name>.customCommands.<command-name>[*].rmdirs.

Templated components.<component-name>.customCommands.<command-name>[*].mkdirs.

Templated components.<component-name>.customCommands.<command-name>[*].mkdirs.

Templated components.<component-name>.customCommands.<command-name>[*].sources.

Templated components.<component-name>.customCommands.<command-name>[*].targets.

Templated components.<component-name>.clean.

Templated components.<component-name>.presets.

Templated and preset specific components.<component-name>.default.