Skip to content

Commit 66cc97a

Browse files
authored
Merge pull request #42871 from HarshCasper/RHDEVDOCS-2330
RHDEVDOCS-2330: Enhancements to starting pipelines via Topology
2 parents 41cf9d4 + 763ba16 commit 66cc97a

4 files changed

+45
-22
lines changed

cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ include::modules/op-interacting-with-pipelines-using-the-developer-perspective.a
4040

4141
include::modules/op-using-custom-pipeline-template-for-git-import.adoc[leveloffset=+1]
4242

43-
include::modules/op-starting-pipelines.adoc[leveloffset=+1]
43+
include::modules/op-starting-pipelines-from-pipelines-view.adoc[leveloffset=+1]
44+
45+
include::modules/op-starting-pipelines-from-topology-view.adoc[leveloffset=+1]
46+
47+
include::modules/op-interacting-pipelines-from-topology-view.adoc[leveloffset=+1]
4448

4549
include::modules/op-editing-pipelines.adoc[leveloffset=+1]
4650

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// This module is included in the following assembly:
2+
//
3+
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="op-interacting-pipelines_from_topology_view{context}"]
7+
= Interacting with pipelines from Topology view
8+
9+
The side panel of the application node in the *Topology* page displays the status of a pipeline run and you can interact with it.
10+
11+
* If a pipeline run does not start automatically, the side panel displays a message that the pipeline cannot be automatically started, hence it would need to be started manually.
12+
* If a pipeline is created but the user has not started the pipeline, its status is not started. When the user clicks the *Not started* status icon, the start dialog box opens in the *Topology* view.
13+
* If the pipeline has no build or build config, the *Builds* section is not visible. If there is a pipeline and build config, the *Builds section* is visible.
14+
* The side panel displays a *Log Snippet* when a pipeline run fails on a specific task run. You can view the *Log Snippet* in the *Pipeline Runs* section, under the *Resources* tab. It provides a general error message and a snippet of the log. A link to the *Logs* section provides quick access to the details about the failed run.

modules/op-starting-pipelines.adoc renamed to modules/op-starting-pipelines-from-pipelines-view.adoc

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
44

55
:_content-type: PROCEDURE
6-
[id="op-starting-pipelines_{context}"]
7-
= Starting pipelines
6+
[id="op-starting-pipelines_from_pipelines_view_{context}"]
7+
= Starting pipelines from Pipelines view
88

99
After you create a pipeline, you need to start it to execute the included tasks in the defined sequence. You can start a pipeline from the *Pipelines* view, the *Pipeline Details* page, or the *Topology* view.
1010

@@ -63,22 +63,3 @@ image::op_pipeline_run.png[Pipeline run details]
6363
+
6464
//Add workspace and credential steps in this section.
6565
//Probably need a sep section for logging and monitoring pipelines.
66-
. For pipelines created using the *From Git* option, you can use the *Topology* view to interact with pipelines after you start them:
67-
+
68-
[NOTE]
69-
====
70-
To see the pipelines created using the *Pipeline Builder* in the *Topology* view, customize the pipeline labels to link the pipeline with the application workload.
71-
====
72-
+
73-
.. On the left navigation panel, click *Topology*, and click on the application to see the pipeline runs listed in the side panel.
74-
.. In the *Pipeline Runs* section, click *Start Last Run* to start a new pipeline run with the same parameters and resources as the previous one. This option is disabled if a pipeline run has not been initiated.
75-
+
76-
.Pipelines in Topology view
77-
image::op_pipeline_topology.png[Pipelines in Topology view]
78-
+
79-
.. In the *Topology* page, hover to the left of the application to see the status of the pipeline run for the application.
80-
+
81-
[NOTE]
82-
====
83-
The side panel of the application node in the *Topology* page displays a *Log Snippet* when a pipeline run fails on a specific task run. You can view the *Log Snippet* in the *Pipeline Runs* section, under the *Resources* tab. *Log Snippet* provides a general error message and a snippet of the log. A link to the *Logs* section provides quick access to the details about the failed run.
84-
====
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// This module is included in the following assembly:
2+
//
3+
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="op-starting-pipelines_from_topology_view{context}"]
7+
= Starting pipelines from Topology view
8+
9+
For pipelines created using the *From Git* option, you can use the *Topology* view to interact with pipelines after you start them:
10+
11+
[NOTE]
12+
====
13+
To see the pipelines created using the *Pipeline Builder* in the *Topology* view, customize the pipeline labels to link the pipeline with the application workload.
14+
====
15+
.Procedure
16+
17+
. Click *Topology* in the left navigation panel.
18+
. Click the application to display *Pipeline Runs* in the side panel.
19+
. In *Pipeline Runs*, click *Start Last Run* to start a new pipeline run with the same parameters and resources as the previous one. This option is disabled if a pipeline run has not been initiated. You can also start a pipeline run when you create it.
20+
+
21+
.Pipelines in Topology view
22+
image::op_pipeline_topology.png[Pipelines in Topology view]
23+
24+
In the *Topology* page, hover to the left of the application to see the status of its pipeline run. After a pipeline is added, a bottom left icon indicates that there is an associated pipeline.

0 commit comments

Comments
 (0)