# Live contexts This page describes the contexts a [live workflow](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#live-workflow) can use in expressions for calculating YAML attribute values. ## Live Contexts | Context name | Description | | ------------ | -------------------------------------------------------------------------------------------------------------------- | | `env` | Contains environment variables set in a workflow or a job. For more information, see [`env` context](#env-context) . | | `flow` | Information about the main workflow settings, defaults, etc. See [`flow` context](#flow-context) for details. | | `project` | Information about the project. See [`project` context](#project-context) for details. | | `images` | Contains a mapping of images on the Apolo registry. See [`images` context](#images-context) for details. | | `multi` | Multi-job context. For more information, see [`multi` context](#multi-context). | | `params` | A mapping of global workflow parameters. For more information, see [`params` context](#params-context). | | `tags` | A set of job tags set in a workflow or a job. See [`tags` context](#tags-context) for details. | | `volumes` | Contains a mapping of volume definitions. For more information, see [`volumes` context](#volumes-context). | | `git` | A mapping of the flow's workspace to a git repository. For more information, see [`git` context](#git-context). | ### `env` context 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](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#live-workflow)." 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.` | `str` | The value of a specific environment variable. | ### `flow` context 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`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#id) attribute. | | `flow.project_id` | `str` | The project's ID. It is automatically generated based on the name of the flow folder. You can override it using [`project.id`](https://docs.apolo.us/index/apolo-flow-reference/project-configuration-syntax#id) attribute. Check [the project configuration](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/project-configuration-syntax) for details. | | `flow.workspace` | `LocalPath` | A path to the workspace (the root folder of the flow). | | `flow.title` | `str` | The workflow title. Set the [`flow.title`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#title) attribute to override the auto-generated value. | | `flow.username` | `str` | Name of user who executed the workflow run. | ### `project` context 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 flow folder. You can override it using [`project.id`](https://docs.apolo.us/index/apolo-flow-reference/project-configuration-syntax#id) attribute. Check [the project configuration](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/project-configuration-syntax) for details. This context property is an alias to `flow.project_id` . | | `project.owner` | `str` | The project's owner. See also: [the project configuration](https://docs.apolo.us/index/apolo-flow-reference/project-configuration-syntax#owner). | | `project.project_name` | `str` | The platform project name. Set the [project.project\_name](https://docs.apolo.us/index/apolo-flow-reference/project-configuration-syntax#project_name) attribute to override the auto-calculated value. | ### `images` context Contains information about images defined in the [`images` section](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#images) of a *live* workflow. | Property name | Type | Description | | ---------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `images..id` | `str` | The image definition identifier. For more information, see [`images.`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#images-less-than-image-id-greater-than) section. | | `images..ref` | `str` | The image reference. For more information, see [`images..ref`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#images-less-than-image-id-greater-than-ref) attribute. | | `images..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 flow's root (flow\.workspace property).

For more information, see images.\.context attribute.

| | `images..full_context_path` | `LocalPath` or `None` | The absolute path, pointing to the `context` folder if set. | | `images..dockerfile` | `LocalPath`or `None` |

A path to Dockerfile or None if not set.

For more information, see images.\.dockerfile attribute.

| | `images..full_dockerfile_path` | `LocalPath` or `None` | Full version of the `dockerfile` attribute. | | `images..build_args` | `list[str]` |

A sequence of additional build arguments.

For more information, see images.\.build\_args attribute.

| | `images..env` | `dict[str, str]` |

Environment variables passed to the image builder.

For more information, see images.\.env attribute.

| | `images..volumes` | `list[str]` |

A sequence of volume definitions passed to the image builder.

For more information, see images.\.volumes attribute.

| ### `multi` context 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 apolo-flow run \ -- \.

multi.args is mainly used for passing args to command line parameters accepted by multi-job, see jobs.\.cmd for details.

| | `multi.suffix` | `str` | *multi-job* suffix added to [`jobs.`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#jobs-job-id-env). | ### `params` context Parameter described in the [`jobs..params` attribute](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#jobs-less-than-job-id-greater-than-params) and available for substitution - for example, in [`jobs..cmd`](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#jobs-less-than-job-id-greater-than-cmd) calculation. | Property name | Type | Description | | --------------------- | ----- | ---------------------------------- | | `params.` | `str` | The value of a specific parameter. | Supported parameter values: `project`, `flow`, `env`, `tags`, `volumes`, `images`. ### `tags` context A set of job tags. Tags are combined from system tags (`project:`, `job:`), flow default tags (see [`defaults.tags` attribute](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#defaults-tags)), and job-specific tags (see `jobs..tags` attribute). | Property name | Type | Description | | ------------- | ---------- | ---------------------------------------------------------------------------- | | `tags` | `set[str]` | This context changes for each job. You can access this context from any job. | ### `volumes` context Contains information about volumes defined in the [`volumes` section ](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#volumes)of a *live* workflow. | Property name | Type | Description | | ------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `volumes..id` | `str` | The volume definition identifier. For more information, see [`volumes.` section](https://docs.apolo.us/index/apolo-flow-reference/workflow-syntax/live-workflow-syntax/..#volumes-less-than-volume-id-greater-than). | | `volumes..remote` | `URL` |

Remote volume URI, e.g. storage:path/to.
For more information, see volumes.\.remote attribute.

| | `volumes..mount` | `RemotePath` |

The path inside a job by which the volume should be mounted.

For more information, see volumes.\.mount attribute.

| | `volumes..read_only` | `bool` |

True if the volume is mounted in read-only mode, False otherwise.

For more information, see volumes.\.read\_only attribute.

| | `volumes..local` | `LocalPath`or `None` |

A path in the workspace folder to synchronize with remote Apolo storage or None if not set.

For more information, see volumes.\.local attribute.

| | `volumes..full_local_path` | `LocalPath` or `None` | Full version of `local` property. | | `volumes..ref` | `str` |

A volume reference that can be used as a jobs.\.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..ref_ro` | `str` | Like `ref` but *read-only* mode is enforced. | | `volumes..ref_rw` | `str` | Like `ref` but *read-write* mode is enforced. | ### `git` context The `git` context contains a mapping of your flow's workspace to a git repository. This context can only be used if the flow'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. |