mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
pipelines in odc
assembly and flow changes minor updates images and start mods review edits1 review edits 2 img edit review edits 3 update title of app_pipeline flow build fix revert changes to file name topic map changes review edits 4 adding image tags intro sentences
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
1c6beb1290
commit
518460c3fb
@@ -766,7 +766,7 @@ Topics:
|
||||
File: installing-pipelines
|
||||
- Name: Uninstalling OpenShift Pipelines
|
||||
File: uninstalling-pipelines
|
||||
- Name: Creating applications with OpenShift Pipelines
|
||||
- Name: Creating CI/CD solutions for applications using OpenShift Pipelines
|
||||
File: creating-applications-with-cicd-pipelines
|
||||
- Name: Working with Pipelines using the Developer perspective
|
||||
File: working-with-pipelines-using-the-developer-perspective
|
||||
|
||||
BIN
images/op-pipeline-builder-task-details.png
Normal file
BIN
images/op-pipeline-builder-task-details.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
BIN
images/op-pipeline-builder.png
Normal file
BIN
images/op-pipeline-builder.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
BIN
images/op_pipeline_run.png
Normal file
BIN
images/op_pipeline_run.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
BIN
images/op_pipeline_topology.png
Normal file
BIN
images/op_pipeline_topology.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
@@ -43,7 +43,7 @@ The resource name must be unique in a namespace. Modify the resource name if you
|
||||
====
|
||||
The *Knative Service* option is displayed in the *Import from git* form only if the *Serverless Operator* is installed in your cluster. For further details refer to documentation on installing OpenShift Serverless.
|
||||
====
|
||||
|
||||
. In the *Pipelines* section, select *Add Pipeline*, and then click *Show Pipeline Visualization* to see the pipeline for the application.
|
||||
. In the *Advanced Options* section, the *Create a route to the application* is selected by default so that you can access your application using a publicly available URL. You can clear the check box if you do not want to expose your application on a public route.
|
||||
. Optional: You can use the following advanced options to further customize your application:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Ths module is included in the following assembly:
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="about-tasks_{context}"]
|
||||
= About Tasks
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
|
||||
|
||||
[id="about-triggers_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
|
||||
[id="adding-triggers_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Ths module is included in the following assembly:
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// assembly_creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="assembling-a-pipeline_{context}"]
|
||||
= Assembling a Pipeline
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
|
||||
|
||||
[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:
|
||||
|
||||
* 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.
|
||||
|
||||
.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.
|
||||
+
|
||||
.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.
|
||||
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.
|
||||
+
|
||||
. 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 *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.
|
||||
@@ -1,6 +1,6 @@
|
||||
// Ths module is included in the following assembly:
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="creating-pipeline-tasks_{context}"]
|
||||
= Creating Pipeline Tasks
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-cicd-solutions-using-openshift-pipelines.adoc
|
||||
|
||||
[id="creating-project-and-checking-pipeline-service-account_{context}"]
|
||||
= Creating a project and checking your Pipeline ServiceAccount
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="creating-webhooks_{context}"]
|
||||
= Creating Webhooks
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Ths module is included in the following assembly:
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="defining-and-creating-pipelineresources_{context}"]
|
||||
= Defining and creating PipelineResources
|
||||
|
||||
12
modules/op-deleting-pipelines.adoc
Normal file
12
modules/op-deleting-pipelines.adoc
Normal file
@@ -0,0 +1,12 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
|
||||
|
||||
[id="op-deleting-pipelines_{context}"]
|
||||
= Deleting Pipelines
|
||||
|
||||
You can delete the Pipelines in your cluster using the *Developer* perspective of the web console.
|
||||
|
||||
.Procedure
|
||||
. In the *Pipelines* view of the *Developer* perspective, click the *Options* {Kebab} menu adjoining a Pipeline, and select *Delete Pipeline*.
|
||||
. In the *Delete Pipeline* confirmation prompt, click *Delete* to confirm the deletion.
|
||||
18
modules/op-editing-pipelines.adoc
Normal file
18
modules/op-editing-pipelines.adoc
Normal file
@@ -0,0 +1,18 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
|
||||
|
||||
[id="op-editing-pipelines_{context}"]
|
||||
= Editing Pipelines
|
||||
|
||||
You can edit the Pipelines in your cluster using the *Developer* perspective of the web console:
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Pipelines* view of the *Developer* perspective, select the Pipeline you want to edit to see the details of the Pipeline.
|
||||
In the *Pipeline Details* page, click *Actions* and select *Edit Pipeline*.
|
||||
. In the *Pipeline Builder* page:
|
||||
* You can add additional Tasks, parameters, or resources to the Pipeline.
|
||||
* You can click the Task you want to modify to see the Task details in the side panel and modify the required Task details, such as the display name, parameters and resources.
|
||||
* Alternatively, to delete the Task, click the Task, and in the side panel, click *Actions* and select *Remove Task*.
|
||||
. Click *Save* to save the modified Pipeline.
|
||||
@@ -11,36 +11,16 @@ The *Pipelines* view in the *Developer* perspective lists all the Pipelines in a
|
||||
.Procedure
|
||||
. In the *Pipelines* view of the *Developer* perspective, select a project from the *Project* drop-down list to see the Pipelines in that project.
|
||||
+
|
||||
//image::op-pipeline-list.png[Pipelines in the Developer perspective]
|
||||
.Pipelines view in the Developer perspective
|
||||
image::op-pipeline-list.png[]
|
||||
+
|
||||
. Click on the required Pipeline to see the *Pipeline Details* page. This provides a visual representation of all the serial and parallel Tasks in the Pipeline. The Tasks are also listed at the lower right of the page. You can click the listed *Tasks* to view Task details.
|
||||
. Click the required Pipeline to see the *Pipeline Details* page. This page provides a visual representation of all the serial and parallel Tasks in the Pipeline. The Tasks are also listed at the lower right of the page. You can click the listed *Tasks* to view Task details.
|
||||
+
|
||||
//image::op-pipeline-details.png[Pipeline details]
|
||||
+
|
||||
. Optionally, in the *Pipeline Details* page:
|
||||
|
||||
* Click the *YAML* tab to edit the YAML file for the Pipeline.
|
||||
* Click the *Pipeline Runs* tab to see the completed, running, or failed runs for the Pipeline. You can use the Options menu {kebab} to stop a running Pipeline, to rerun a Pipeline using the same parameters and resources as that of the previous Pipeline execution, or to delete a PipelineRun.
|
||||
* Click the *Parameters* tab to see the parameters defined in the Pipeline. You can also add or edit additional parameters as required.
|
||||
* Click the *Resources* tab to see the resources defined in the Pipeline. You can also add or edit additional resources as required.
|
||||
|
||||
////
|
||||
. Click *Actions* and select *Start* to start the Pipeline. The *Start Pipeline* dialog box displays the *Git Resources* and the *Image Resources* based on the Pipeline definition.
|
||||
.. In the *Parameters* section, enter a unique name in the `IMAGE_NAME` field.
|
||||
.. Use the drop-down lists to select or create the required resources to customize the Pipeline as required. For this example, retain the default values and click *Start* to start the PipelineRun. After the Pipeline starts, the Tasks are executed sequentially in the Pipeline.
|
||||
//Specifically for this Pipeline `IMAGE_NAME` may end up as 'APP_NAME' to fulfil what they are looking for. Ticket: https://issues.redhat.com/browse/SRVKP-631 Update docs based on the bug resolution
|
||||
|
||||
. The *Pipeline Run Details* page displays the pipeline being executed. You can:
|
||||
|
||||
* Hover over the tasks to see the time taken for the execution of each step.
|
||||
* Click on a task to see logs for each of the steps in the task.
|
||||
* Click the *Logs* tab to see the logs according to the execution sequence of the tasks and use the *Download* button to download the logs to a text file.
|
||||
+
|
||||
image::pipeline_run.png[Pipeline run]
|
||||
+
|
||||
. On the left navigation panel, click *Topology* and click on the application to see the pipeline runs listed in the right panel.
|
||||
. In the *Pipeline Runs* section, click *Start Last Run* to start a new pipeline run with the same parameters and resources as the previous ones. This option is disabled if a pipeline run has not been initiated.
|
||||
+
|
||||
image::pipeline_topology.png[Pipeline topology]
|
||||
+
|
||||
. In the *Topology* page, hover to the left of the application to see the status of the pipeline run for the application.
|
||||
////
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
{pipelines-title} provide a set of standard Custom Resource Definitions (CRDs) that act as the building blocks from which you can assemble a CI/CD pipeline for your application.
|
||||
|
||||
Task:: A Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task.
|
||||
Task:: A Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more Steps. Steps are a series of commands that are sequentially executed by the Task.
|
||||
|
||||
Pipeline:: A Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, parameters, and one or more Tasks. A Pipeline interacts with the outside world by using PipelineResources, which are added to Tasks as inputs and outputs.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// // *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
|
||||
|
||||
[id="running-a-pipeline_{context}"]
|
||||
|
||||
50
modules/op-starting-pipelines.adoc
Normal file
50
modules/op-starting-pipelines.adoc
Normal file
@@ -0,0 +1,50 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
|
||||
|
||||
[id="op-starting-pipelines_{context}"]
|
||||
= Starting Pipelines
|
||||
|
||||
After you create a Pipeline, you need to start it to execute the included Tasks in the defined sequence. You can start a Pipeline Run from the *Pipelines* view, *Pipeline Details* page, or the *Topology* view.
|
||||
|
||||
.Procedure
|
||||
To start a Pipeline using the *Pipelines* view:
|
||||
|
||||
. In the *Pipelines* view of the *Developer* perspective, click the *Options* {Kebab} menu adjoining a Pipeline, and select *Start*.
|
||||
. The *Start Pipeline* dialog box displays the *Git Resources* and the *Image Resources* based on the Pipeline definition.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For Pipelines created using the *From Git* option, the *Start Pipeline* dialog box also displays an `APP_NAME` field in the *Parameters* section, and all the fields in the dialog box are prepopulated by the Pipeline templates.
|
||||
====
|
||||
+
|
||||
.. If you have resources in your namespace, the *Git Resources* and the *Image Resources* fields are prepopulated with those resources. If required, use the drop-downs to select or create the required resources and customize the Pipeline Run instance.
|
||||
.. If required, modify the *Advanced Options* and add credentials to authenticate the specified Git server or Docker registry.
|
||||
|
||||
. Click *Start* to start the PipelineRun.
|
||||
. The *Pipeline Run Details* page displays the Pipeline being executed. After the Pipeline starts, the Tasks and Steps within each Task are executed.
|
||||
You can:
|
||||
|
||||
* Hover over the Tasks to see the time taken for the execution of each Step.
|
||||
* Click on a Task to see logs for each of the Steps in the Task.
|
||||
* Click the *Logs* tab to see the logs according to the execution sequence of the Tasks and use the *Download* button to download the logs to a text file.
|
||||
+
|
||||
.Pipeline run
|
||||
image::op_pipeline_run.png[]
|
||||
+
|
||||
//Add workspace and credential steps in this section.
|
||||
//Probably need a sep section for logging and monitoring pipelines.
|
||||
. For Pipelines created using the *From Git* option, you can use the *Topology* view to interact with Pipelines after you start them:
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
To see Pipelines created using the *Pipeline Builder* in the *Topology* view, customize the Pipeline labels to link the Pipeline with the application workload.
|
||||
====
|
||||
+
|
||||
.. On the left navigation panel, click *Topology*, and click on the application to see the Pipeline Runs listed in the side panel.
|
||||
.. In the *Pipeline Runs* section, click *Start Last Run* to start a new Pipeline Run with the same parameters and resources as the previous ones. This option is disabled if a Pipeline Run has not been initiated.
|
||||
+
|
||||
.Pipelines on the Topology view
|
||||
image::op_pipeline_topology.png[]
|
||||
+
|
||||
.. In the *Topology* page, hover to the left of the application to see the status of the Pipeline Run for the application.
|
||||
@@ -1,6 +1,6 @@
|
||||
// This module is included in the following assembly:
|
||||
//
|
||||
// *openshift_pipelines/op-creating-applications-with-cicd-pipelines.adoc
|
||||
// *openshift_pipelines/creating-applications-with-cicd-pipelines.adoc
|
||||
|
||||
[id="triggering-a-pipeline_{context}"]
|
||||
= Triggering a PipelineRun
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[id='creating-applications-with-cicd-pipelines']
|
||||
= Creating applications with OpenShift Pipelines
|
||||
= Creating CI/CD solutions for applications using OpenShift Pipelines
|
||||
include::modules/common-attributes.adoc[]
|
||||
include::modules/pipelines-document-attributes.adoc[]
|
||||
:context: creating-applications-with-cicd-pipelines
|
||||
|
||||
@@ -7,9 +7,16 @@ include::modules/pipelines-document-attributes.adoc[]
|
||||
:context: working-with-pipelines-using-the-developer-perspective
|
||||
toc::[]
|
||||
|
||||
You can use the *Developer* perspective of the {product-title} web console to create CI/CD Pipelines for your software delivery process while creating an application on {product-title}.
|
||||
You can use the *Developer* perspective of the {product-title} web console to create CI/CD Pipelines for your software delivery process.
|
||||
|
||||
|
||||
In the *Developer* perspective:
|
||||
|
||||
* Use the *Add* -> *Pipeline* -> *Pipeline Builder* option to create customized Pipelines for your application.
|
||||
* Use the *Add* -> *From Git* option to create Pipelines using operator-installed Pipeline templates and resources while creating an application on {product-title}.
|
||||
|
||||
After you create the Pipelines for your application, you can view and visually interact with the deployed Pipelines in the *Pipelines* view. You can also use the *Topology* view to interact with the Pipelines created using the *From Git* option. You need to apply custom labels to a Pipeline created using the *Pipeline Builder* to see it in the *Topology* view.
|
||||
|
||||
After you create Pipelines, you can view and visually interact with your deployed Pipelines.
|
||||
////
|
||||
NOTE: The .NET Core runtime is not yet supported by the Pipeline templates.
|
||||
////
|
||||
@@ -17,9 +24,22 @@ NOTE: The .NET Core runtime is not yet supported by the Pipeline templates.
|
||||
[Discrete]
|
||||
.Prerequisites
|
||||
|
||||
* You have access to an {product-title} cluster and have logged in to the xref:../web_console/web-console.adoc[web console].
|
||||
* You have cluster administrator privileges to install Operators and have xref:../pipelines/installing-pipelines.adoc#installing-pipelines[installed the OpenShift Pipelines Operator].
|
||||
* You are in the xref:../web_console/odc-about-developer-perspective.adoc[Developer perspective].
|
||||
* You have access to an {product-title} cluster and have switched to the xref:../web_console/odc-about-developer-perspective.adoc[Developer perspective] in the web console.
|
||||
* You have the xref:../pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines Operator installed] in your cluster.
|
||||
* You are a cluster administrator or a user with create and edit permissions.
|
||||
* You have created a project.
|
||||
|
||||
|
||||
include::modules/op-constructing-pipelines-using-pipeline-builder.adoc[leveloffset=+1]
|
||||
|
||||
== Creating applications with OpenShift Pipelines
|
||||
|
||||
To create Pipelines along with applications, use the *From Git* option in the *Add* view of the *Developer* perspective. For more information, see xref:../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
|
||||
|
||||
include::modules/op-interacting-with-pipelines-using-the-developer-perspective.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/op-starting-pipelines.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/op-editing-pipelines.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/op-deleting-pipelines.adoc[leveloffset=+1]
|
||||
|
||||
Reference in New Issue
Block a user