openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity

Update Pipeline builder section with information on switching from Builder view to YAML view and few other english changes.

Browse Source
This commit is contained in:
Rishu Mehra
2021-02-07 23:45:24 +05:30
committed by openshift-cherrypick-robot
parent 9950e9b448
commit ca7383b5bb
2 changed files with 35 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
images/op-pipeline-yaml.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 93 KiB

58
modules/op-constructing-pipelines-using-pipeline-builder.adoc
View File

@@ -5,41 +5,53 @@
[id="op-constructing-pipelines-using-pipeline-builder_{context}"]
= Constructing Pipelines using the Pipeline Builder
In the *Developer* perspective of the console, you can use the *Add* -> *Pipeline* -> *Pipeline Builder* option to:
In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeline* -> *Pipeline Builder* option to:
* Construct a Pipeline flow using existing Tasks and ClusterTasks. When you install the OpenShift Pipelines Operator, it adds reusable Pipeline ClusterTasks to your cluster.
* Specify the type of resources required for the Pipeline Run, and if required, add additional parameters to the Pipeline.
* Reference these Pipeline resources in each of the Tasks in the Pipeline as input and output resources.
* The parameters for a Task are prepopulated based on the specifications of the Task. If required, reference any additional parameters added to the Pipeline in the Task.
* Configure pipelines using either the *Pipeline builder* or the *YAML view*.
* Construct a pipeline flow using existing tasks and cluster tasks. When you install the OpenShift Pipelines Operator, it adds reusable pipeline cluster tasks to your cluster.
* Specify the type of resources required for the pipeline run, and if required, add additional parameters to the pipeline.
* Reference these pipeline resources in each of the tasks in the pipeline as input and output resources.
* If required, reference any additional parameters added to the pipeline in the task. The parameters for a task are prepopulated based on the specifications of the task.
* Use the Operator-installed, reusable snippets and samples to create detailed pipelines.
.Procedure
. In the *Add* view of the *Developer* perspective, click the *Pipeline* tile to see the *Pipeline Builder* page.
. Enter a unique name for the Pipeline.
. Select a Task from the *Select task* list to add a Task to the Pipeline. This example uses the *s2i-nodejs* Task.
.. To add sequential Tasks to the Pipeline, click the plus icon to the right or left of the Task, and from the *Select task* list, select the Task you want to add to the Pipeline. For this example, use the plus icon to the right of the *s2i-nodejs* Task to add an *openshift-client* Task.
.. To add a parallel Task to the existing Task, click the plus icon displayed below the Task, and from the *Select Task* list, select the parallel Task you want to add to the Pipeline.
. In the *+Add* view of the *Developer* perspective, click the *Pipeline* tile to see the *Pipeline Builder* page.
. Configure the pipeline using either the *Pipeline builder* view or the *YAML view*.
+
[NOTE]
====
The *Pipeline builder* view supports a limited number of fields whereas the *YAML view* supports all available fields. Optionally, you can also use the Operator-installed, reusable snippets and samples to create detailed Pipelines.
====
+
.YAML view
image::op-pipeline-yaml.png[]
+
To configure your pipeline using the *Pipeline Builder*:
.. Enter a unique name for the pipeline.
.. Select a task from the *Select Task* list to add a task to the pipeline. This example uses the *s2i-nodejs* task.
*** To add sequential tasks to the pipeline, click the plus icon to the right or left of the task, and from the *Select Task* list, select the task you want to add to the pipeline. For this example, use the plus icon to the right of the *s2i-nodejs* task to add an *openshift-client* task.
*** To add a parallel task to the existing task, click the plus icon displayed next to the task, and from the *Select Task* list, select the parallel task you want to add to the pipeline.
+
.Pipeline Builder
image::op-pipeline-builder.png[]
+
. Click *Add Resources* to specify the name and type of resources that the Pipeline Run will use. These resources are then used by the Tasks in the Pipeline as inputs and outputs.
.. Click *Add Resources* to specify the name and type of resources that the pipeline run will use. These resources are then used by the tasks in the pipeline as inputs and outputs.
For this example:
.. Add an input resource. In the *Name* field, enter `Source`, and from the *Resource Type* drop-down list, select *Git*.
.. Add an output resource. In the *Name* field, enter `Img`, and from the *Resource Type* drop-down list, select *Image*.
. The *Parameters* for a Task are prepopulated based on the specifications of the Task. If required, use the *Add Parameters* link to add additional parameters.
... Add an input resource. In the *Name* field, enter `Source`, and then from the *Resource Type* drop-down list, select *Git*.
... Add an output resource. In the *Name* field, enter `Img`, and then from the *Resource Type* drop-down list, select *Image*.
.. Optional: The *Parameters* for a task are prepopulated based on the specifications of the task. If required, use the *Add Parameters* link to add additional parameters.
+
. A *Missing Resources* warning is displayed on a Task if the resources for the Task are not specified. Click the *s2i-nodejs* Task to see the side panel with details for the Task.
.. If a *Missing Resources* warning is displayed on a task if the resources for the task are not specified. Click the *s2i-nodejs* task to see the side panel with details for the task.
+
.Tasks details in Pipelines Builder
image::op-pipeline-builder-task-details.png[]
+
. In the Task side panel, specify the resources and parameters for it:
.. In the task side panel, specify the resources and parameters for the *s2i-nodejs* task:
.. In the *Input Resources* -> *Source* section, the *Select Resources* drop-down list displays the resources that you added to the Pipeline. For this example, select *Source*.
.. In the *Output Resources* -> *Image* section, click the *Select Resources* list, and select *Img*.
.. If required, in the *Parameters* section, add more parameters to the default ones, by using the `$(params.<param-name>)` syntax.
. Similarly, add an input resource for the *openshift-client* Task.
. Click *Create* to create the Pipeline. You are redirected to the *Pipeline Details* page that displays the details of the created Pipeline. You can now use the *Action* button to start the Pipeline.
Optionally, you can also use the *Edit YAML* link, on the upper right of the *Pipeline Builder* page, to directly modify a Pipeline YAML file in the console. You can also use the operator-installed, reusable snippets and samples to create detailed Pipelines.
... In the *Input Resources* -> *Source* section, the *Select Resources* drop-down list displays the resources that you added to the pipeline. For this example, select *Source*.
... In the *Output Resources* -> *Image* section, click the *Select Resources* list, and select *Img*.
... If required, in the *Parameters* section, add more parameters to the default ones, by using the `$(params.<param-name>)` syntax.
... Similarly, add an input resource for the *openshift-client* task.
. Click *Create* to create and view the pipeline in the *Pipeline Details* and the click the *Action* button to start the pipeline.