Live contexts
This page describes the contexts a live workflow can use in expressions for calculating YAML attribute values.
Context name | Description |
---|---|
env | |
flow | |
project | |
images | |
multi | |
params | |
tags | |
volumes | |
git |
The
env
context contains environment variables that have been set in a workflow or a job. For more information about setting environment variables in your workflow, see "Live workflow syntax."The
env
context syntax allows you to use the value of an environment variable in your workflow file. If you want to use the value of an environment variable inside a job, use your operating system's standard method for reading environment variables.Property name | Type | Description |
---|---|---|
env.<env-name> | str | The value of a specific environment variable. |
The
flow
context contains information about the workflow: its id, title, etc.Property name | Type | Description |
---|---|---|
flow.flow_id | str | The workflow's ID. It's automatically generated based on the workflow's YAML filename with a dropped suffix (this will always 'live' in live mode). You can override the property by setting the flow.id attribute. |
flow.project_id | str | The project's ID. It is automatically generated based on the name of the project folder. You can override it using project.id attribute. Check the project configuration for details. |
flow.workspace | LocalPath | A path to the workspace (the root folder of the project). |
flow.title | str |
The
project
context contains information about the project: its ID, owner, etc.Property name | Type | Description |
---|---|---|
project.id | str | The project's ID. It is automatically generated based on the name of the project folder. You can override it using project.id attribute. Check the project configuration for details. This context property is an alias to flow.project_id . |
project.owner | str | |
project.role | str |
Property name | Type | Description |
---|---|---|
images.<image-id>.id | str | |
images.<image-id>.ref | str | |
images.<image-id>.context | LocalPath or None | The context directory used for building the image or None if the context is not set. The path is relative to the project's root (flow.workspace property). |
images.<image-id>.full_context_path | LocalPath or None | The absolute path, pointing to the context folder if set. |
images.<image-id>.dockerfile | LocalPath or None | A path to Dockerfile or None if not set. |
images.<image-id>.full_dockerfile_path | LocalPath or None | Full version of the dockerfile attribute. |
images.<image-id>.build_args | list[str] | A sequence of additional build arguments. |
images.<image-id>.env | dict[str, str] | Environment variables passed to the image builder. |
images.<image-id>.volumes | list[str] | A sequence of volume definitions passed to the image builder. |
The additional arguments passed to multi-job.
Property name | Type | Description |
---|---|---|
multi.args | str | Additional command line arguments passed to multi-job.
The command line run defines the field as neuro-flow run <job-id> -- <args> .multi.args is mainly used for passing args to command line parameters accepted by multi-job, see jobs.<job-id>.cmd for details. |
multi.suffix | str |
Parameter described in the
jobs.<job-id>.params
attribute and available for substitution - for example, in jobs.<job-id>.cmd
calculation.Property name | Type | Description |
---|---|---|
params.<param-name> | str | The value of a specific parameter. |
Supported parameter values:
project
, flow
, env
, tags
, volumes
, images
.A set of job tags.
Tags are combined from system tags (
project:<project-id>
, job:<job-id>
), flow default tags (see defaults.tags
attribute), and job-specific tags (see jobs.<job-id>.tags
attribute).Property name | Type | Description |
---|---|---|
tags | set[str] | This context changes for each job. You can access this context from any job. |
Property name | Type | Description |
---|---|---|
volumes.<volume-id>.id | str | |
volumes.<volume-id>.remote | URL | Remote volume URI, e.g. storage:path/to .
For more information, see volumes.<volume-id>.remote attribute. |
volumes.<volume-id>.mount | RemotePath | The path inside a job by which the volume should be mounted. |
volumes.<volume-id>.read_only | bool | True if the volume is mounted in read-only mode, False otherwise. |
volumes.<volume-id>.local | LocalPath or None | A path in the workspace folder to synchronize with remote Neu.ro storage or None if not set. |
volumes.<volume-id>.full_local_path | LocalPath or None | Full version of local property. |
volumes.<volume-id>.ref | str | A volume reference that can be used as a jobs.<job-id>.volumes item. The calculated value looks like storage:path/to:/mnt/path:rw .The value is assembled from remote , mount , and read_only properties. |
volumes.<volume-id>.ref_ro | str | Like ref but read-only mode is enforced. |
volumes.<volume-id>.ref_rw | str | Like ref but read-write mode is enforced. |
The
git
context contains contains a mapping of your project's workspace to a git repository.This context can only be used if the project's workspace is inside some git repository.
Property name | Type | Description |
---|---|---|
git.sha | str | SHA of the current commit. |
git.branch | str | Name of the current branch. |
git.tags | list[str] | List of tags that point to the current commit. |
Last modified 9mo ago