Directed Acyclic Graph
- Introduced in GitLab 12.2.
- Feature flag removed in GitLab 12.10.
A directed acyclic graph can be used in the context of a CI/CD pipeline to build relationships between jobs such that execution is performed in the quickest possible manner, regardless how stages may be set up.
For example, you may have a specific tool or separate website that is built as part of your main project. Using a DAG, you can specify the relationship between these jobs and GitLab will then execute the jobs as soon as possible instead of waiting for each stage to complete.
Unlike other DAG solutions for CI/CD, GitLab does not require you to choose one or the other. You can implement a hybrid combination of DAG and traditional stage-based operation within a single pipeline. Configuration is kept very simple, requiring a single keyword to enable the feature for any job.
Consider a monorepo as follows:
./service_a
./service_b
./service_c
./service_dIt has a pipeline that looks like the following:
| build | test | deploy |
|---|---|---|
| build_a | test_a | deploy_a |
| build_b | test_b | deploy_b |
| build_c | test_c | deploy_c |
| build_d | test_d | deploy_d |
Using a DAG, you can relate the _a jobs to each other separately from the _b jobs,
and even if service a takes a very long time to build, service b will not
wait for it and will finish as quickly as it can. In this very same pipeline, _c and
_d can be left alone and will run together in staged sequence just like any normal
GitLab pipeline.
Use cases
A DAG can help solve several different kinds of relationships between jobs within a CI/CD pipeline. Most typically this would cover when jobs need to fan in or out, and/or merge back together (diamond dependencies). This can happen when you're handling multi-platform builds or complex webs of dependencies as in something like an operating system build or a complex deployment graph of independently deployable but related microservices.
Additionally, a DAG can help with general speediness of pipelines and helping to deliver fast feedback. By creating dependency relationships that don't unnecessarily block each other, your pipelines will run as quickly as possible regardless of pipeline stages, ensuring output (including errors) is available to developers as quickly as possible.
Usage
Relationships are defined between jobs using the needs: keyword.
Note that needs: also works with the parallel keyword,
giving you powerful options for parallelization within your pipeline.
Limitations
A directed acyclic graph is a complicated feature, and as of the initial MVC there are certain use cases that you may need to work around. For more information:
-
needsrequirements and limitations. - Related epic tracking planned improvements.
DAG Visualization
- Introduced in GitLab 13.1 as a Beta feature.
- It's deployed behind a feature flag, disabled by default.
- It's enabled on GitLab.com.
- It's not recommended for production use.
- For GitLab self-managed instances, GitLab administrators can opt to enable it
The DAG visualization makes it easier to visualize the relationships between dependent jobs in a DAG. This graph will display all the jobs in a pipeline that need or are needed by other jobs. Jobs with no relationships are not displayed in this view.
Clicking a node will highlight all the job paths it depends on.
Enable or disable DAG Visualization (CORE ONLY)
DAG Visualization is under development and requires more testing, but is being made available as a beta features so users can check its limitations and uses.
It is deployed behind a feature flag that is disabled by default. GitLab administrators with access to the GitLab Rails console can opt to enable it for your instance:
# Instance-wide
Feature.enable(:dag_pipeline_tab)
# or by project
Feature.enable(:dag_pipeline_tab, Project.find(<project id>))