latest--common-environment-subschemas

shared
Schema URL https://catalog.lintel.tools/schemas/schemastore/mlos-config-mlos-jsonc-mlos-json5-mlos-json/_shared/latest--common-environment-subschemas.json
Parent schema mlos-config-mlos-jsonc-mlos-json5-mlos-json

config elements common to several Environments.

Definitions

common_environment_config object
tunable_params string[]

The names of tunable groups to reference (i.e., keys from the tunable params).

minItems=0uniqueItems=true
required_args string[]

Required arguments for the Environment to instantiate. These can be presented as environment variables for scripts to use.

minItems=1uniqueItems=true
const_args Record<string, string | number | boolean | null | array>

Default argument value constants to use for the Environment when not overridden by globals.

command_lines string[]

The command lines to execute.

setup_run_teardown_configs object
setup string[]

The command lines to execute.

minItems=1
run string[]

The command lines to execute.

minItems=1
teardown string[]

The command lines to execute.

minItems=1
results_stdout_pattern string

A regex to parse the stdout of the run phase for results.

shell_param_type string

All parameters must be valid shell variable names, else use shell_env_params_rename.

shell_env_params_config object
shell_env_params shell_param_type[]

An explicit list of parameters (and their values) to pass to the shell as environment variables.

minItems=1uniqueItems=true
shell_env_params_rename Record<string, string>

An explicit mapping of environment variable names from params to be populated with the parameter values and passed to the shell commands.

file_download_config object
from string required

Remote path to download the file from.

to string required

Local path to download the file to.

file_upload_config object
from string required

Local path to upload the file from.

to string required

Remote path to upload the file to.