Merge pull request #64315 from openshift-cherrypick-robot/cherry-pick…

…-62463-to-enterprise-4.12 [enterprise-4.12] RHDEVDOCS-5518: Documenting Pipelines templates in the admin console
openshift · Sep 5, 2023 · b7f6ca3 · b7f6ca3
2 parents bed03b0 + 72b1afe
commit b7f6ca3
Show file tree

Hide file tree

Showing 17 changed files with 115 additions and 157 deletions.
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1876,8 +1876,8 @@ Topics:
     File: remote-pipelines-tasks-resolvers
   - Name: Using Pipelines as Code
     File: using-pipelines-as-code
-  - Name: Working with OpenShift Pipelines using the Developer perspective
-    File: working-with-pipelines-using-the-developer-perspective
+  - Name: Working with OpenShift Pipelines in the web console
+    File: working-with-pipelines-web-console
   - Name: Customizing configurations in the TektonConfig custom resource
     File: customizing-configurations-in-the-tektonconfig-cr
   - Name: Reducing resource consumption of OpenShift Pipelines

diff --git a/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc b/cicd/pipelines/creating-applications-with-cicd-pipelines.adoc
@@ -81,7 +81,7 @@ include::modules/op-validating-pull-requests-using-GitHub-interceptors.adoc[leve
 == Additional resources
 
 * To include {pac} along with the application source code in the same repository, see xref:../../cicd/pipelines/using-pipelines-as-code.adoc#using-pipelines-as-code[Using {pac}].
-* For more details on pipelines in the *Developer* perspective, see the xref:../../cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc#working-with-pipelines-using-the-developer-perspective[working with pipelines in the *Developer* perspective] section.
+* For more details on pipelines in the *Developer* perspective, see the xref:../../cicd/pipelines/working-with-pipelines-web-console.adoc#working-with-pipelines-web-console[working with pipelines in the web console] section.
 * To learn more about Security Context Constraints (SCCs), see the xref:../../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing Security Context Constraints] section.
 * For more examples of reusable tasks, see the link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog] repository. Additionally, you can also see the Tekton Catalog in the Tekton project.
 * To install and deploy a custom instance of Tekton Hub for reusable tasks and pipelines, see xref:../../cicd/pipelines/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}].

diff --git a/cicd/pipelines/customizing-configurations-in-the-tektonconfig-cr.adoc b/cicd/pipelines/customizing-configurations-in-the-tektonconfig-cr.adoc
@@ -52,5 +52,5 @@ include::modules/op-annotations-for-automatic-pruning-taskruns-pipelineruns.adoc
 
 * xref:../../cicd/pipelines/authenticating-pipelines-using-git-secret.adoc#op-configuring-ssh-authentication-for-git_authenticating-pipelines-using-git-secret[Configuring SSH authentication for Git]
 * xref:../../cicd/pipelines/managing-nonversioned-and-versioned-cluster-tasks.adoc#managing-nonversioned-and-versioned-cluster-tasks[Managing non-versioned and versioned cluster tasks]
-* xref:../../cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc#using-custom-pipeline-template-for-git-import_working-with-pipelines-using-the-developer-perspective[Using a custom pipeline template for creating and deploying an application from a Git repository]
 * xref:../../applications/pruning-objects.adoc#pruning-objects[Pruning objects to reclaim resources]
+* xref:../../cicd/pipelines/working-with-pipelines-web-console.adoc#op-creating-pipeline-templates-admin-console_working-with-pipelines-web-console[Creating pipeline templates in the Administrator perspective]
diff --git a/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc b/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc
diff --git a/cicd/pipelines/working-with-pipelines-web-console.adoc b/cicd/pipelines/working-with-pipelines-web-console.adoc
@@ -0,0 +1,49 @@
+:_content-type: ASSEMBLY
+[id="working-with-pipelines-web-console"]
+= Working with {pipelines-title} in the web console
+include::_attributes/common-attributes.adoc[]
+:context: working-with-pipelines-web-console
+
+toc::[]
+
+You can use the *Administrator* or *Developer* perspective to create and modify `Pipeline`, `PipelineRun`, and `Repository` objects from the *Pipelines* page in the {product-title} web console.
+You can also use the *+Add* page in the *Developer* perspective of the web console to create CI/CD pipelines for your software delivery process.
+
+// Dev console
+include::modules/op-odc-pipelines-abstract.adoc[leveloffset=+1]
+
+[discrete]
+[id="prerequisites_working-with-pipelines-web-console"]
+== Prerequisites
+
+* You have access to an {product-title} cluster, and have xref:../../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[switched to the *Developer* perspective].
+* You have the xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[{pipelines-shortname} 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=+2]
+
+include::modules/op-creating-pipelines-along-with-applications.adoc[leveloffset=+2]
+
+include::modules/odc-adding-a-GitHub-repository-containing-pipelines.adoc[leveloffset=+2]
+
+include::modules/op-interacting-with-pipelines-using-the-developer-perspective.adoc[leveloffset=+2]
+
+include::modules/op-starting-pipelines-from-pipelines-view.adoc[leveloffset=+2]
+
+include::modules/op-starting-pipelines-from-topology-view.adoc[leveloffset=+2]
+
+include::modules/op-interacting-pipelines-from-topology-view.adoc[leveloffset=+2]
+
+include::modules/op-editing-pipelines.adoc[leveloffset=+2]
+
+include::modules/op-deleting-pipelines.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+[id="additional-resources_working-with-pipelines-web-console"]
+=== Additional resources
+
+* xref:../../cicd/pipelines/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using Tekton Hub with {pipelines-shortname}]
+
+// Admin console
+include::modules/op-creating-pipeline-templates-admin-console.adoc[leveloffset=+1]
diff --git a/images/import-icon.png b/images/import-icon.png
diff --git a/modules/op-constructing-pipelines-using-pipeline-builder.adoc b/modules/op-constructing-pipelines-using-pipeline-builder.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-constructing-pipelines-using-pipeline-builder_{context}"]

diff --git a/modules/op-creating-pipeline-templates-admin-console.adoc b/modules/op-creating-pipeline-templates-admin-console.adoc
@@ -0,0 +1,40 @@
+// Module included in the following assemblies:
+//
+// * cicd/pipelines/working-with-pipelines-web-console.adoc
+
+:_content-type: PROCEDURE
+[id="op-creating-pipeline-templates-admin-console_{context}"]
+= Creating pipeline templates in the Administrator perspective
+
+As a cluster administrator, you can create pipeline templates that developers can reuse when they create a pipeline on the cluster.
+
+.Prerequisites
+
+* You have access to an {product-title} cluster with cluster administrator permissions, and have switched to the *Administrator* perspective.
+* You have installed the {pipelines-shortname} Operator in your cluster.
+
+.Procedure
+
+. Navigate to the *Pipelines* page to view existing pipeline templates.
+
+. Click the image:../images/import-icon.png[title="Import"] icon to go to the *Import YAML* page.
+
+. Add the YAML for your pipeline template. The template must include the following information:
++
+[source,yaml]
+----
+apiVersion: tekton.dev/v1beta1
+kind: Pipeline
+metadata:
+# ...
+  namespace: openshift # <1>
+  labels:
+    pipeline.openshift.io/runtime: <runtime> # <2>
+    pipeline.openshift.io/type: <pipeline-type> # <3>
+# ...
+----
+<1> The template must be created in the `openshift` namespace.
+<2> The template must contain the `pipeline.openshift.io/runtime` label. The accepted runtime values for this label are `nodejs`, `golang`, `dotnet`, `java`, `php`, `ruby`, `perl`, `python`, `nginx`, and `httpd`.
+<3> The template must contain the `pipeline.openshift.io/type:` label. The accepted type values for this label are `openshift`, `knative`, and `kubernetes`.
+
+. Click *Create*. After the pipeline has been created, you are taken to the *Pipeline details* page, where you can view information about or edit your pipeline.
diff --git a/modules/op-creating-pipelines-along-with-applications.adoc b/modules/op-creating-pipelines-along-with-applications.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: CONCEPT
 [id="op-creating-pipelines-along-with-applications_{context}"]

diff --git a/modules/op-deleting-pipelines.adoc b/modules/op-deleting-pipelines.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-deleting-pipelines_{context}"]

diff --git a/modules/op-editing-pipelines.adoc b/modules/op-editing-pipelines.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-editing-pipelines_{context}"]

diff --git a/modules/op-interacting-pipelines-from-topology-view.adoc b/modules/op-interacting-pipelines-from-topology-view.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: CONCEPT
 [id="op-interacting-pipelines_from_topology_view{context}"]

diff --git a/modules/op-interacting-with-pipelines-using-the-developer-perspective.adoc b/modules/op-interacting-with-pipelines-using-the-developer-perspective.adoc
@@ -1,6 +1,6 @@
 // Ths module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-interacting-with-pipelines-using-the-developer-perspective_{context}"]

diff --git a/modules/op-odc-pipelines-abstract.adoc b/modules/op-odc-pipelines-abstract.adoc
@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+//
+// * cicd/pipelines/working-with-pipelines-web-console.adoc
+
+:_content-type: CONCEPT
+[id="op-odc-pipelines-abstract_{context}"]
+= Working with {pipelines-title} in the Developer perspective
+
+In the *Developer* perspective, you can access the following options for creating pipelines from the *+Add* page:
+
+* Use the *+Add* -> *Pipelines* -> *Pipeline builder* option to create customized pipelines for your application.
+* Use the *+Add* -> *From Git* option to create pipelines using pipeline templates and resources while creating an application.
+
+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 must apply custom labels to pipelines created using the *Pipeline builder* to see them in the *Topology* view.
diff --git a/modules/op-starting-pipelines-from-pipelines-view.adoc b/modules/op-starting-pipelines-from-pipelines-view.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-starting-pipelines_from_pipelines_view_{context}"]

diff --git a/modules/op-starting-pipelines-from-topology-view.adoc b/modules/op-starting-pipelines-from-topology-view.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assembly:
 //
-// *openshift_pipelines/working-with-pipelines-using-the-developer-perspective.adoc
+// *openshift_pipelines/working-with-pipelines-web-console.adoc
 
 :_content-type: PROCEDURE
 [id="op-starting-pipelines_from_topology_view{context}"]

diff --git a/modules/op-using-custom-pipeline-template-for-git-import.adoc b/modules/op-using-custom-pipeline-template-for-git-import.adoc