Skip to content

Commit 9796c75

Browse files
Merge pull request #82259 from abhisheksharma402/pipeline-run-commands-update
updated tekton pipeline-run commands
2 parents acccbc7 + dd5fa4e commit 9796c75

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

modules/op-tkn-pipeline-run.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// This module is included in the following assemblies:
22
// * tkn_cli/op-tkn-reference.adoc
33

4+
:_mod-docs-content-type: REFERENCE
45
[id="op-tkn-pipeline-run_{context}"]
56
= Pipeline run commands
67

@@ -17,10 +18,10 @@ $ tkn pipelinerun -h
1718
== pipelinerun cancel
1819
Cancel a pipeline run.
1920

20-
.Example: Cancel the `mypipelinerun` pipeline run from a namespace
21+
.Example: Cancel a pipeline run from a namespace
2122
[source,terminal]
2223
----
23-
$ tkn pipelinerun cancel mypipelinerun -n myspace
24+
$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
2425
----
2526

2627
== pipelinerun delete
@@ -29,13 +30,13 @@ Delete a pipeline run.
2930
.Example: Delete pipeline runs from a namespace
3031
[source,terminal]
3132
----
32-
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
33+
$ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
3334
----
3435

3536
.Example: Delete all pipeline runs from a namespace, except the five most recently executed pipeline runs
3637
[source,terminal]
3738
----
38-
$ tkn pipelinerun delete -n myspace --keep 5 <1>
39+
$ tkn pipelinerun delete -n <namespace_name> --keep 5 <1>
3940
----
4041
<1> Replace `5` with the number of most recently executed pipeline runs you want to retain.
4142

@@ -53,10 +54,10 @@ Starting with {pipelines-title} 1.6, the `tkn pipelinerun delete --all` command
5354
== pipelinerun describe
5455
Describe a pipeline run.
5556

56-
.Example: Describe the `mypipelinerun` pipeline run in a namespace
57+
.Example: Describe a pipeline run in a namespace
5758
[source,terminal]
5859
----
59-
$ tkn pipelinerun describe mypipelinerun -n myspace
60+
$ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
6061
----
6162

6263
== pipelinerun list
@@ -65,14 +66,14 @@ List pipeline runs.
6566
.Example: Display a list of pipeline runs in a namespace
6667
[source,terminal]
6768
----
68-
$ tkn pipelinerun list -n myspace
69+
$ tkn pipelinerun list -n <namespace_name>
6970
----
7071

7172
== pipelinerun logs
7273
Display the logs of a pipeline run.
7374

74-
.Example: Display the logs of the `mypipelinerun` pipeline run with all tasks and steps in a namespace
75+
.Example: Display the logs of a pipeline run with all tasks and steps in a namespace
7576
[source,terminal]
7677
----
77-
$ tkn pipelinerun logs mypipelinerun -a -n myspace
78+
$ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
7879
----

0 commit comments

Comments
 (0)