diff options
Diffstat (limited to 'doc/ci/pipelines')
| -rw-r--r-- | doc/ci/pipelines/img/pipelines_graph_dependency_view_hover_v13_12.png | bin | 0 -> 42573 bytes | |||
| -rw-r--r-- | doc/ci/pipelines/img/pipelines_graph_dependency_view_links_v13_12.png | bin | 0 -> 37749 bytes | |||
| -rw-r--r-- | doc/ci/pipelines/img/pipelines_graph_dependency_view_v13_12.png | bin | 0 -> 36039 bytes | |||
| -rw-r--r-- | doc/ci/pipelines/img/pipelines_graph_stage_view_v13_12.png | bin | 0 -> 25969 bytes | |||
| -rw-r--r-- | doc/ci/pipelines/img/pipelines_v13_11.png | bin | 28783 -> 0 bytes | |||
| -rw-r--r-- | doc/ci/pipelines/index.md | 72 | ||||
| -rw-r--r-- | doc/ci/pipelines/job_artifacts.md | 7 | ||||
| -rw-r--r-- | doc/ci/pipelines/pipeline_artifacts.md | 5 | ||||
| -rw-r--r-- | doc/ci/pipelines/pipeline_efficiency.md | 2 | ||||
| -rw-r--r-- | doc/ci/pipelines/schedules.md | 2 |
10 files changed, 76 insertions, 12 deletions
diff --git a/doc/ci/pipelines/img/pipelines_graph_dependency_view_hover_v13_12.png b/doc/ci/pipelines/img/pipelines_graph_dependency_view_hover_v13_12.png Binary files differnew file mode 100644 index 00000000000..e73845b39b0 --- /dev/null +++ b/doc/ci/pipelines/img/pipelines_graph_dependency_view_hover_v13_12.png diff --git a/doc/ci/pipelines/img/pipelines_graph_dependency_view_links_v13_12.png b/doc/ci/pipelines/img/pipelines_graph_dependency_view_links_v13_12.png Binary files differnew file mode 100644 index 00000000000..1ce77881bc4 --- /dev/null +++ b/doc/ci/pipelines/img/pipelines_graph_dependency_view_links_v13_12.png diff --git a/doc/ci/pipelines/img/pipelines_graph_dependency_view_v13_12.png b/doc/ci/pipelines/img/pipelines_graph_dependency_view_v13_12.png Binary files differnew file mode 100644 index 00000000000..41840108441 --- /dev/null +++ b/doc/ci/pipelines/img/pipelines_graph_dependency_view_v13_12.png diff --git a/doc/ci/pipelines/img/pipelines_graph_stage_view_v13_12.png b/doc/ci/pipelines/img/pipelines_graph_stage_view_v13_12.png Binary files differnew file mode 100644 index 00000000000..d7d8f3c63d2 --- /dev/null +++ b/doc/ci/pipelines/img/pipelines_graph_stage_view_v13_12.png diff --git a/doc/ci/pipelines/img/pipelines_v13_11.png b/doc/ci/pipelines/img/pipelines_v13_11.png Binary files differdeleted file mode 100644 index 8981f4ce860..00000000000 --- a/doc/ci/pipelines/img/pipelines_v13_11.png +++ /dev/null diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index 6d013a43583..fa8a4cedf6f 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -325,23 +325,81 @@ Pipelines can be complex structures with many sequential and parallel jobs. To make it easier to understand the flow of a pipeline, GitLab has pipeline graphs for viewing pipelines and their statuses. -Pipeline graphs can be displayed in two different ways, depending on the page you +Pipeline graphs can be displayed as a large graph or a miniature representation, depending on the page you access the graph from. GitLab capitalizes the stages' names in the pipeline graphs. -### Regular pipeline graphs +### View full pipeline graph -> - [Visualization improved](https://gitlab.com/gitlab-org/gitlab/-/issues/276949) in GitLab 13.11. +> - [Visualization improvements introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/276949) in GitLab 13.11. -Regular pipeline graphs show the names of the jobs in each stage. Regular pipeline graphs can -be found when you are on a [single pipeline page](#view-pipelines). For example: +The [pipeline details page](#view-pipelines) displays the full pipeline graph of +all the jobs in the pipeline. - +You can group the jobs by: + +- Stage, which arranges jobs in the same stage together in the same column. + +  + +- [Job dependencies](#view-job-dependencies-in-the-pipeline-graph), which arranges + jobs based on their [`needs`](../yaml/README.md#needs) dependencies. [Multi-project pipeline graphs](../multi_project_pipelines.md#multi-project-pipeline-visualization) help you visualize the entire pipeline, including all cross-project inter-dependencies. **(PREMIUM)** +### View job dependencies in the pipeline graph + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/298973) in GitLab 13.12. +> - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. +> - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/328538) in GitLab 13.12. +> - Enabled on GitLab.com. +> - Recommended for production use. +> - To disable in GitLab self-managed instances, ask a GitLab administrator to [disable it](#enable-or-disable-job-dependency-view). **(FREE SELF)** + +This in-development feature might not be available for your use. There can be +[risks when enabling features still in development](../../user/feature_flags.md#risks-when-enabling-features-still-in-development). +Refer to this feature's version history for more details. + +You can arrange jobs in the pipeline graph based on their [`needs`](../yaml/README.md#needs) +dependencies. + +Jobs in the leftmost column run first, and jobs that depend on them are grouped in the next columns. + +For example, `build-job2` depends only on jobs in the first column, so it displays +in the second column from the left. `deploy-job2` depends on jobs in both the first +and second column and displays in the third column: + + + +To add lines that show the `needs` relationships between jobs, select the **Show dependencies** toggle. +These lines are similar to the [needs visualization](../directed_acyclic_graph/index.md#needs-visualization): + + + +To see the full `needs` dependency tree for a job, hover over it: + + + +#### Enable or disable job dependency view **(FREE SELF)** + +The job dependency view is deployed behind a feature flag that is **enabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can disable it. + +To enable it: + +```ruby +Feature.enable(:pipeline_graph_layers_view) +``` + +To disable it: + +```ruby +Feature.disable(:pipeline_graph_layers_view) +``` + ### Pipeline mini graphs Pipeline mini graphs take less space and can tell you at a @@ -356,6 +414,8 @@ Pipeline mini graphs allow you to see all related jobs for a single commit and t of each stage of your pipeline. This allows you to quickly see what failed and fix it. +Pipeline mini graphs only display jobs by stage. + Stages in pipeline mini graphs are collapsible. Hover your mouse over them and click to expand their jobs. | Mini graph | Mini graph expanded | diff --git a/doc/ci/pipelines/job_artifacts.md b/doc/ci/pipelines/job_artifacts.md index fa97f9bd75d..76f05f5e1e7 100644 --- a/doc/ci/pipelines/job_artifacts.md +++ b/doc/ci/pipelines/job_artifacts.md @@ -118,7 +118,7 @@ job with the same name, the job artifact from the parent pipeline is returned. ## Access the latest job artifacts by URL -You can download the latest job artifacts by using a URL. +You can download job artifacts from the latest successful pipeline by using a URL. To download the whole artifacts archive: @@ -173,9 +173,8 @@ https://gitlab.com/gitlab-org/gitlab/-/jobs/artifacts/master/file/htmlcov/index. ## When job artifacts are deleted -By default, the latest job artifacts from the most recent successful jobs are never deleted. -If a job is configured with [`expire_in`](../yaml/README.md#artifactsexpire_in), -its artifacts only expire if a more recent artifact exists. +See the [`expire_in`](../yaml/README.md#artifactsexpire_in) documentation for information on when +job artifacts are deleted. ### Keep artifacts from most recent successful jobs diff --git a/doc/ci/pipelines/pipeline_artifacts.md b/doc/ci/pipelines/pipeline_artifacts.md index e405258092d..bc770dd3d90 100644 --- a/doc/ci/pipelines/pipeline_artifacts.md +++ b/doc/ci/pipelines/pipeline_artifacts.md @@ -15,4 +15,7 @@ Pipeline artifacts are used by the [test coverage visualization feature](../../u Pipeline artifacts are saved to disk or object storage. They count towards a project's [storage usage quota](../../user/usage_quotas.md#storage-usage-quota). The **Artifacts** on the Usage Quotas page is the sum of all job artifacts and pipeline artifacts. -Pipeline artifacts are erased after one week. +## When pipeline artifacts are deleted + +See the [`expire_in`](../yaml/README.md#artifactsexpire_in) documentation for information on when +pipeline artifacts are deleted. diff --git a/doc/ci/pipelines/pipeline_efficiency.md b/doc/ci/pipelines/pipeline_efficiency.md index faebf40462e..2deb3b27748 100644 --- a/doc/ci/pipelines/pipeline_efficiency.md +++ b/doc/ci/pipelines/pipeline_efficiency.md @@ -110,6 +110,8 @@ and get the pipeline status and duration. In combination with a Grafana dashboar this helps build an actionable view for your operations team. Metric graphs can also be embedded into incidents making problem resolving easier. Additionally, it can also export metrics about jobs and environments. +If you use the GitLab CI Pipelines Exporter, you should start with the [example configuration](https://github.com/mvisonneau/gitlab-ci-pipelines-exporter/blob/main/docs/configuration_syntax.md). +  Alternatively, you can use a monitoring tool that can execute scripts, like diff --git a/doc/ci/pipelines/schedules.md b/doc/ci/pipelines/schedules.md index 752e2a97fad..fb8de034d2a 100644 --- a/doc/ci/pipelines/schedules.md +++ b/doc/ci/pipelines/schedules.md @@ -65,7 +65,7 @@ GitLab CI/CD so that they can be used in your [`.gitlab-ci.yml` file](../../ci/y To configure a job to be executed only when the pipeline has been scheduled (or the opposite), use -[only and except](../yaml/README.md#onlyexcept-basic) configuration keywords. +[only and except](../yaml/README.md#only--except) configuration keywords. In the example below `make world` runs in scheduled pipelines, and `make build` runs in pipelines that are not scheduled: |
