Paasify Project settings


Configure main project settings. It provides global settings but also defaults vars and tags for all stacks.

root oneOf Project configuration
Type: object Default: {}

Configure project as a dict value. Most of these settings are overridable via environment vars.

 No Additional Properties
Example:

{
    "config": {
        "namespace": "my_ns1",
        "vars": [
            {
                "my_var1": "my_value1"
            }
        ],
        "tags": [
            "tag1",
            "tag2"
        ]
    }
}

root oneOf Project configuration namespace

Name of the project namespace. If not set, defaulted to directory name

root oneOf Project configuration namespace oneOf None
Type: null

Defaulted by the project dir name
root oneOf Project configuration namespace oneOf String
Type: string

Custom namespace name string

root oneOf Project configuration extra_vars

Extra vars file to load for this project

root oneOf Project configuration extra_vars oneOf List of file
Type: array of string

List of files to load

Each item of this array must be:

root oneOf Project configuration extra_vars oneOf List of file item 0 items
Type: string
root oneOf Project configuration extra_vars oneOf String
Type: string

A single file to load
root oneOf Project configuration extra_vars oneOf No configuration
Type: null

Disable extra_vars loading

Examples:

{
    "extra_vars": [
        "../common_vars.ymlcommon/common_vars.yml/absolute/path/common_vars.yml"
    ]
}

{
    "extra_vars": "single/file/to_load.yml"
}

{
    "extra_vars": null
}

root oneOf Project configuration vars

Environment configuration. Paasify leave two choices for the configuration, either use the native dict configuration or use the docker-compatible format

root oneOf Project configuration vars oneOf Env configuration as list
Type: array Default: []

Configure variables as a list. This is the recommended way asit preserves the variable parsing order, useful for templating. This format allow multiple configuration format.
Example:

{
    "env": [
        {
            "MYSQL_ADMIN_USER": "MyUser"
        },
        {
            "MYSQL_ADMIN_DB": "MyDB"
        },
        {
            "MYSQL_ENABLE_BACKUP": true
        },
        {
            "MYSQL_BACKUPS_NODES": 3
        },
        {
            "MYSQL_NODE_REPLICA": null
        },
        "MYSQL_WELCOME_STRING=Is alway a string"
    ]
}

Each additional property must conform to the following schema

root oneOf Project configuration vars oneOf Env configuration as list additionalProperties

Environment configuration. Paasify leave two choices for the configuration, either use the native dict configuration or use the docker-compatible format

root oneOf Project configuration vars oneOf Env configuration as list additionalProperties oneOf Variable definition as key/value
Type: object

Simple key value variable declaration, under the form of: {KEY: VALUE}. This does preserve value type.
Example:

{
    "env": [
        {
            "MYSQL_ADMIN_USER": "MyUser"
        },
        {
            "MYSQL_ADMIN_DB": "MyDB"
        }
    ]
}

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z_][A-Za-z0-9_]*$
root oneOf Project configuration vars oneOf Env configuration as list additionalProperties oneOf Variable definition as key/value Environment Key value
Type: object

Value must be serializable type
root oneOf Project configuration vars oneOf Env configuration as list additionalProperties oneOf Variable definition as string (Compat)
Type: string

Value must be a string, under the form of: KEY=VALUE. This does not preserve value type.

Must match regular expression: ^[A-Za-z_][A-Za-z0-9_]*=.*$
Example:

{
    "env": [
        "MYSQL_ADMIN_USER=MyUser",
        "MYSQL_ADMIN_DB=MyDB"
    ]
}
root oneOf Project configuration vars oneOf Env configuration as dict (Compat)
Type: object Default: {}

Configure variables as a dict. This option is only proposed for compatibility reasons. It does not preserve the order of the variables.
Example:

{
    "env": {
        "MYSQL_ADMIN_USER": "MyUser",
        "MYSQL_ADMIN_DB": "MyDB",
        "MYSQL_ENABLE_BACKUP": true,
        "MYSQL_BACKUPS_NODES": 3,
        "MYSQL_NODE_REPLICA": null
    }
}
root oneOf Project configuration vars oneOf Unset
Type: null Default: null

Do not define any vars
Examples:

{
    "env": null
}

{
    "env": []
}

{
    "env": {}
}

root oneOf Project configuration tags

Determine a list of tags to apply

root oneOf Project configuration tags oneOf List of tags
Type: array Default: []

Define a list of tags. You can interact in few ways with tags. Tags can support boths syntaxes at the same time.
Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag",
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

Each additional property must conform to the following schema

root oneOf Project configuration tags oneOf List of tags StackTag configuration

Tag definition. It support two formats at the same time: as string or dict. If the name is prefixed with a !, then it is removed from the processing list (both vars, docker-file and jsonnet processing).

root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As string
Default: ""

Just pass the tag you want to apply as string. This form does not allow jsonnet ovar override

root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As string oneOf Disabled Tag: ~$tag_name
Type: object

Completely disable a tag from the processing list, whatever how many instances there are.

Must match regular expression: [~].*
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As string oneOf Collection tag: $collection_name:$tag_name
Type: object

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

Must match regular expression: ^.*:.*$
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As string oneOf Tag name: $tag_name
Type: object

Will find the best matching tag.See: Specific tag documentation for further informations.

Must match regular expression: .*

Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag"
    ]
}
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As object
Type: object Default: {}

Define a tag. The key represent the name of the tag, while it's value is passed as vars during jsonnet processing. This form allow jsonnet ovar override
Example:

{
    "tags": [
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [~].*
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As object Disabled Tag: ~$tag_name
Default: {}

Completely disable a tag from the processing list, whatever how many instances there are.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*:.*$
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As object Collection tag: $collection_name:$tag_name
Default: {}

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root oneOf Project configuration tags oneOf List of tags StackTag configuration oneOf As object Tag name: $tag_name
Default: {}

Will find the best matching tag.See: Specific tag documentation for further informations.
root oneOf Project configuration tags oneOf Unset
Type: null Default: null

Do not declare any tags
Example:

{
    "tags": null
}

root oneOf Project configuration tags_suffix

Determine a list of tags to apply

root oneOf Project configuration tags_suffix oneOf List of tags
Type: array Default: []

Define a list of tags. You can interact in few ways with tags. Tags can support boths syntaxes at the same time.
Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag",
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

Each additional property must conform to the following schema

root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration

Tag definition. It support two formats at the same time: as string or dict. If the name is prefixed with a !, then it is removed from the processing list (both vars, docker-file and jsonnet processing).

root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As string
Default: ""

Just pass the tag you want to apply as string. This form does not allow jsonnet ovar override

root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As string oneOf Disabled Tag: ~$tag_name
Type: object

Completely disable a tag from the processing list, whatever how many instances there are.

Must match regular expression: [~].*
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As string oneOf Collection tag: $collection_name:$tag_name
Type: object

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

Must match regular expression: ^.*:.*$
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As string oneOf Tag name: $tag_name
Type: object

Will find the best matching tag.See: Specific tag documentation for further informations.

Must match regular expression: .*

Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag"
    ]
}
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As object
Type: object Default: {}

Define a tag. The key represent the name of the tag, while it's value is passed as vars during jsonnet processing. This form allow jsonnet ovar override
Example:

{
    "tags": [
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [~].*
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As object Disabled Tag: ~$tag_name
Default: {}

Completely disable a tag from the processing list, whatever how many instances there are.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*:.*$
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As object Collection tag: $collection_name:$tag_name
Default: {}

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root oneOf Project configuration tags_suffix oneOf List of tags StackTag configuration oneOf As object Tag name: $tag_name
Default: {}

Will find the best matching tag.See: Specific tag documentation for further informations.
root oneOf Project configuration tags_suffix oneOf Unset
Type: null Default: null

Do not declare any tags
Example:

{
    "tags": null
}

root oneOf Project configuration tags_prefix

Determine a list of tags to apply

root oneOf Project configuration tags_prefix oneOf List of tags
Type: array Default: []

Define a list of tags. You can interact in few ways with tags. Tags can support boths syntaxes at the same time.
Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag",
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

Each additional property must conform to the following schema

root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration

Tag definition. It support two formats at the same time: as string or dict. If the name is prefixed with a !, then it is removed from the processing list (both vars, docker-file and jsonnet processing).

root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As string
Default: ""

Just pass the tag you want to apply as string. This form does not allow jsonnet ovar override

root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As string oneOf Disabled Tag: ~$tag_name
Type: object

Completely disable a tag from the processing list, whatever how many instances there are.

Must match regular expression: [~].*
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As string oneOf Collection tag: $collection_name:$tag_name
Type: object

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

Must match regular expression: ^.*:.*$
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As string oneOf Tag name: $tag_name
Type: object

Will find the best matching tag.See: Specific tag documentation for further informations.

Must match regular expression: .*

Example:

{
    "tags": [
        "my_tagg",
        "~my_prefix_tag",
        "my_collection:my_prefix_tag"
    ]
}
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As object
Type: object Default: {}

Define a tag. The key represent the name of the tag, while it's value is passed as vars during jsonnet processing. This form allow jsonnet ovar override
Example:

{
    "tags": [
        {
            "other_tag": {
                "specific_conf": "val1"
            }
        },
        {
            "my_collection:another_tag": null
        },
        {
            "~ignore_this_tag": {
                "specific_conf": "val1"
            }
        }
    ]
}

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: [~].*
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As object Disabled Tag: ~$tag_name
Default: {}

Completely disable a tag from the processing list, whatever how many instances there are.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.*:.*$
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As object Collection tag: $collection_name:$tag_name
Default: {}

Reference a tag from a specific collection.See: Specific tag documentation for further informations.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root oneOf Project configuration tags_prefix oneOf List of tags StackTag configuration oneOf As object Tag name: $tag_name
Default: {}

Will find the best matching tag.See: Specific tag documentation for further informations.
root oneOf Project configuration tags_prefix oneOf Unset
Type: null Default: null

Do not declare any tags
Example:

{
    "tags": null
}
root oneOf Empty
Type: null Default: null

Use automatic conf if not set. You can still override conf values with environment vars.
Examples:

{
    "config": null
}

{
    "config": {}
}