-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #64318 from abrennan89/cherrypick-main
[pipelines-docs] RHDEVDOCS-5518: Documenting Pipelines templates in the admin console
- Loading branch information
Showing
18 changed files
with
118 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 0 additions & 52 deletions
52
create/working-with-pipelines-using-the-developer-perspective.adoc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
:_content-type: ASSEMBLY | ||
include::_attributes/common-attributes.adoc[] | ||
[id="working-with-pipelines-web-console"] | ||
= Working with {pipelines-title} using the Developer perspective | ||
: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 {OCP} 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 {OCP} cluster and have switched to link:https://docs.openshift.com/container-platform/latest/web_console/web-console-overview.html#about-developer-perspective_web-console-overview[the *Developer* perspective]. | ||
* You have the xref:../install_config/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:../hub/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] |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modules/odc-adding-a-GitHub-repository-containing-pipelines.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// This module is included in the following assemblies: | ||
// * create/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 {OCP} 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
// This module is included in the following assemblies: | ||
// * create/working-with-pipelines-using-the-developer-perspective.adoc | ||
// * create/working-with-pipelines-web-console.adoc | ||
|
||
:_content-type: CONCEPT | ||
[id="op-interacting-pipelines_from_topology_view{context}"] | ||
= Interacting with pipelines from Topology view | ||
|
||
The side panel of the application node in the *Topology* page displays the status of a pipeline run and you can interact with it. | ||
The side panel of the application node in the *Topology* page displays the status of a pipeline run and you can interact with it. | ||
|
||
* 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. | ||
* 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. | ||
* 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. | ||
* 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. | ||
* 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. | ||
* 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * create/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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.