1
1
// This module is included in the following assemblies:
2
2
// * tkn_cli/op-tkn-reference.adoc
3
3
4
+ :_mod-docs-content-type: REFERENCE
4
5
[id="op-tkn-pipeline-run_{context} "]
5
6
= Pipeline run commands
6
7
@@ -17,10 +18,10 @@ $ tkn pipelinerun -h
17
18
== pipelinerun cancel
18
19
Cancel a pipeline run.
19
20
20
- .Example: Cancel the `mypipelinerun` pipeline run from a namespace
21
+ .Example: Cancel a pipeline run from a namespace
21
22
[source,terminal]
22
23
----
23
- $ tkn pipelinerun cancel mypipelinerun -n myspace
24
+ $ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
24
25
----
25
26
26
27
== pipelinerun delete
@@ -29,13 +30,13 @@ Delete a pipeline run.
29
30
.Example: Delete pipeline runs from a namespace
30
31
[source,terminal]
31
32
----
32
- $ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
33
+ $ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
33
34
----
34
35
35
36
.Example: Delete all pipeline runs from a namespace, except the five most recently executed pipeline runs
36
37
[source,terminal]
37
38
----
38
- $ tkn pipelinerun delete -n myspace --keep 5 <1>
39
+ $ tkn pipelinerun delete -n <namespace_name> --keep 5 <1>
39
40
----
40
41
<1> Replace `5` with the number of most recently executed pipeline runs you want to retain.
41
42
@@ -53,10 +54,10 @@ Starting with {pipelines-title} 1.6, the `tkn pipelinerun delete --all` command
53
54
== pipelinerun describe
54
55
Describe a pipeline run.
55
56
56
- .Example: Describe the `mypipelinerun` pipeline run in a namespace
57
+ .Example: Describe a pipeline run in a namespace
57
58
[source,terminal]
58
59
----
59
- $ tkn pipelinerun describe mypipelinerun -n myspace
60
+ $ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
60
61
----
61
62
62
63
== pipelinerun list
@@ -65,14 +66,14 @@ List pipeline runs.
65
66
.Example: Display a list of pipeline runs in a namespace
66
67
[source,terminal]
67
68
----
68
- $ tkn pipelinerun list -n myspace
69
+ $ tkn pipelinerun list -n <namespace_name>
69
70
----
70
71
71
72
== pipelinerun logs
72
73
Display the logs of a pipeline run.
73
74
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
75
76
[source,terminal]
76
77
----
77
- $ tkn pipelinerun logs mypipelinerun -a -n myspace
78
+ $ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
78
79
----
0 commit comments