User Documentation YAML tags

Upsun Beta

Access our newest offering - Upsun!

Get your free trial by clicking the link below.

Get your Upsun free trial

In addition to the basic functions you should be familiar with, YAML allows for special tags. accepts certain custom tags to facilitate working with configuration files.

These tags work with configuration files, but may not elsewhere.

Include Anchor to this heading

Use the !include tag to embed external files within a given YAML file.

The tag requires two properties:

Property Type Possible values Description
type string string, binary, or yaml See the descriptions of strings, binaries, and YAML. Defaults to yaml.
path string The path to the file to include, relative to the application directory or source.root.

string Anchor to this heading

Use string to include an external file inline in the YAML file as if entered as a multi-line string.

For example, if you have a build hook like the following:
    build: |
        set -e
        cp a.txt b.txt        

You could create a file for the script:
set -e
cp a.txt b.txt

And replace the hook with an include tag for an identical result:
    build: !include
        type: string

This helps you break longer configuration like build scripts out into a separate file for easier maintenance.

binary Anchor to this heading

Use binary to include an external binary file inline in the YAML file. The file is base64 encoded.

For example, you could include a favicon.ico file in the same folder as your app configuration. Then you can include it as follows:
    favicon: !include
        type: binary
        path: favicon.ico

yaml Anchor to this heading

Use yaml to include an external YAML file inline as if entered directly. Because yaml is the default, you can use it without specifying the type.

For example, you could have your configuration for works defined in a worker.yaml file:

size: S
    start: python
        type: worker

Then the following three configurations are exactly equivalent:
    queue1: !include "worker.yaml"
    queue1: !include
        type: yaml
        path: 'worker.yaml'
        size: S
            start: python
                type: worker

This can help simplify more complex files.

Archive Anchor to this heading

Use the !archive tag for a reference to an entire directory specified relative to where the YAML file is.

For example, you might want to define a configuration directory for your Solr service. You might do so as follows:

    type: solr:8.0
    disk: 1024
        conf_dir: !archive "solr/conf"

The !archive tag means that the value for conf_dir isn’t the string solr/conf but the entire solr/conf directory. This directory is in the .platform directory, since that’s where the .platform/services.yaml file is. The solr/conf directory is then copied into the management system to use with the service.

Is this page helpful?