Skip to content

Commit 0fd6723

Browse files
authored
Pipeline build icons (#721)
* Add new icons for pipeline builds Added new icons for each of pipeline's build statues * Update pipeline build section with new status icons Added table with status icons and descriptions * Update monitoring-pipelines.md * Add build approval denied status Added status for pipeline build with approval denied * Update monitoring-pipelines.md Added missing nomarkdown tags to pipeline build status table * Update monitoring-pipelines.md Minor formatting fixes * Update monitoring-pipelines.md
1 parent fe96442 commit 0fd6723

9 files changed

+22
-18
lines changed

_docs/pipelines/monitoring-pipelines.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,9 @@ View activity for Codefresh pipelines in in the **Builds** tab.
1212
* Global build view: The default view, displays builds for all pipelines for all projects across your organization.
1313
* Project build view: Selecting a project displays the builds for the pipelines in the project.
1414

15-
As a user, you can see builds from all pipelines you have access to. If your permissions do not include access to specific pipelines, you will not see builds from those pipelines.
15+
As a user, you can see builds from all pipelines you have access to. If your permissions do not include access to specific pipelines, you will not see builds from those pipelines.
1616

17-
## Viewing pipeline status
18-
19-
Each screen contains all builds sorted from the most recent to the oldest. The first time you visit
20-
the screen there are no filters defined. To narrow the list, use the filters on the top
21-
of the screen.
17+
The Builds page for a pipeline displays by default all builds sorted from the most recent to the oldest. To narrow the list, you can use the date range filter, and additional filters at the top of the page.
2218

2319
{% include
2420
image.html
@@ -30,22 +26,30 @@ caption="Pipeline activity"
3026
max-width="80%"
3127
%}
3228

29+
## Viewing status for pipeline builds
3330

31+
Each build's status is displayed beneath the build details, identifiable by a distinct icon. Refer to the table below for a description of the various statuses associated with pipeline builds.
3432

35-
### Applying filters on the build view
3633

37-
Directly above the list you can find several filters.
34+
{: .table .table-bordered .table-hover}
35+
| Pipeline Build Status Icon       | Description |
36+
| ------------------------| ---------------- |
37+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-running.png" display=inline-block/> {:/}| Pipeline build is currently running. |
38+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-successful.png" display=inline-block/> {:/}| Pipeline build completed successfully. |
39+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-delayed.png" display=inline-block/> {:/}| Pipeline build run has been delayed as there are no free builders. <br>A build can be delayed for a maximum of seven days. Each account can have up to a 1000 delayed builds at any time. <br>{::nomarkdown}<b>NOTE</b>: <ul><li>Builds that are delayed for more than seven days are terminated with a _Delay time limit exceeded_ reason. </li><li>If the total number of delayed builds for an account exceed 1000, older builds are terminated with a <i>Maximum delayed workflows exceeded</i> reason.</li></ul>{:/}|
40+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-pending-approval.png" display=inline-block/> {:/}| Pipeline build is pending approval. |
41+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-denied.png" display=inline-block/> {:/}| Pipeline build pending approval has been denied approval. |
42+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-terminating.png" display=inline-block/> {:/}| Pipeline build is gracefully terminating execution.|
43+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-terminated.png" display=inline-block/> {:/}| Pipeline build execution has been manually or automatically terminated. |
44+
|{::nomarkdown}<img src="../../../images/icons/pipeline-build-failed-error.png" display=inline-block/> {:/}| Pipeline build execution has failed because of errors. |
45+
46+
47+
### Applying filters on the build view
3848

39-
At the most basic level you can choose between
49+
The **Add Filters** option allows you to filter the list of builds by additional criteria, including build status.
4050

41-
* *Running* builds that are currently executing
42-
* *Pending* builds which are queued and waiting to start
43-
* *Delayed* builds which cannot run yet, because there are no free pipeline builders.
44-
A build can be delayed for a maximum of seven days, and each account can have up to 1000 delayed builds at any time.
45-
* Builds that are delayed for more than seven days are terminated with a _Delay time limit exceeded_ reason.
46-
* If the total number of delayed builds exceed 1000, older builds are terminated with a _Maximum delayed workflows exceeded_ reason.
51+
At the most basic level, you can filter by status, choosing between Running/Pending/Delayed builds.
4752

48-
* *All* builds regardless of running stage (this is the default)
4953

5054
You can further filter the builds by choosing the various filter types that specify the build job.
5155

@@ -77,7 +81,7 @@ The available filters are:
7781

7882

7983
Notice that all filters are multiple-choice so you can select multiple values for each filter category.
80-
At any given point you can see all the active filters on top of the screen.
84+
At any given point you can see all the active filters at the top of the page the screen.
8185

8286
{% include
8387
image.html
@@ -286,7 +290,7 @@ A variable with a strikethrough indicates an override by the same variable in a
286290

287291

288292

289-
### Reviewing the yaml for the pipeline
293+
### Reviewing the YAML for the pipeline
290294

291295
From the step details you can also click on the yaml tab to see the yaml segment for that individual step:
292296

443 Bytes
Loading
518 Bytes
Loading
683 Bytes
Loading
890 Bytes
Loading
724 Bytes
Loading
712 Bytes
Loading
848 Bytes
Loading
851 Bytes
Loading

0 commit comments

Comments
 (0)