This documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.5.3. OpenShift Pipelines tkn reference
This section lists the basic tkn
CLI commands.
5.3.1. Basic syntax 复制链接链接已复制到粘贴板!
tkn [command or options] [arguments…]
5.3.2. Global options 复制链接链接已复制到粘贴板!
--help, -h
5.3.3. Utility commands 复制链接链接已复制到粘贴板!
5.3.3.1. tkn 复制链接链接已复制到粘贴板!
Parent command for tkn
CLI.
Example: Display all options
tkn
$ tkn
5.3.3.2. completion [shell] 复制链接链接已复制到粘贴板!
Print shell completion code which must be evaluated to provide interactive completion. Supported shells are bash
and zsh
.
Example: Completion code for bash
shell
tkn completion bash
$ tkn completion bash
5.3.3.3. version 复制链接链接已复制到粘贴板!
Print version information of the tkn
CLI.
Example: Check the tkn
version
tkn version
$ tkn version
5.3.4. Pipelines management commands 复制链接链接已复制到粘贴板!
5.3.4.1. pipeline 复制链接链接已复制到粘贴板!
Manage Pipelines.
Example: Display help
tkn pipeline --help
$ tkn pipeline --help
5.3.4.2. pipeline delete 复制链接链接已复制到粘贴板!
Delete a Pipeline.
Example: Delete the mypipeline
Pipeline from a namespace
tkn pipeline delete mypipeline -n myspace
$ tkn pipeline delete mypipeline -n myspace
5.3.4.3. pipeline describe 复制链接链接已复制到粘贴板!
Describe a Pipeline.
Example: Describe mypipeline
Pipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline
5.3.4.4. pipeline list 复制链接链接已复制到粘贴板!
List Pipelines.
Example: Display a list of Pipelines
tkn pipeline list
$ tkn pipeline list
5.3.4.5. pipeline logs 复制链接链接已复制到粘贴板!
Display Pipeline logs for a specific Pipeline.
Example: Stream live logs for the mypipeline
Pipeline
tkn pipeline logs -f mypipeline
$ tkn pipeline logs -f mypipeline
5.3.4.6. pipeline start 复制链接链接已复制到粘贴板!
Start a Pipeline.
Example: Start mypipeline
Pipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline
5.3.5. PipelineRun commands 复制链接链接已复制到粘贴板!
5.3.5.1. pipelinerun 复制链接链接已复制到粘贴板!
Manage PipelineRuns.
Example: Display help
tkn pipelinerun -h
$ tkn pipelinerun -h
5.3.5.2. pipelinerun cancel 复制链接链接已复制到粘贴板!
Cancel a PipelineRun.
Example: Cancel the mypipelinerun
PipelineRun from a namespace
tkn pipelinerun cancel mypipelinerun -n myspace
$ tkn pipelinerun cancel mypipelinerun -n myspace
5.3.5.3. pipelinerun delete 复制链接链接已复制到粘贴板!
Delete a PipelineRun.
Example: Delete PipelineRuns from a namespace
tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
5.3.5.4. pipelinerun describe 复制链接链接已复制到粘贴板!
Describe a PipelineRun.
Example: Describe the mypipelinerun
PipelineRun in a namespace
tkn pipelinerun describe mypipelinerun -n myspace
$ tkn pipelinerun describe mypipelinerun -n myspace
5.3.5.5. pipelinerun list 复制链接链接已复制到粘贴板!
List PipelineRuns.
Example: Display a list of PipelineRuns in a namespace
tkn pipelinerun list -n myspace
$ tkn pipelinerun list -n myspace
5.3.5.6. pipelinerun logs 复制链接链接已复制到粘贴板!
Display the logs of a PipelineRun.
Example: Display the logs of the mypipelinerun
PipelineRun with all tasks and steps in a namespace
tkn pipelinerun logs mypipelinerun -a -n myspace
$ tkn pipelinerun logs mypipelinerun -a -n myspace
5.3.6. Task management commands 复制链接链接已复制到粘贴板!
5.3.6.1. task 复制链接链接已复制到粘贴板!
Manage Tasks.
Example: Display help
tkn task -h
$ tkn task -h
5.3.6.2. task delete 复制链接链接已复制到粘贴板!
Delete a Task.
Example: Delete mytask1
and mytask2
Tasks from a namespace
tkn task delete mytask1 mytask2 -n myspace
$ tkn task delete mytask1 mytask2 -n myspace
5.3.6.3. task describe 复制链接链接已复制到粘贴板!
Describe a Task.
Example: Describe the mytask
Task in a namespace
tkn task describe mytask -n myspace
$ tkn task describe mytask -n myspace
5.3.6.4. task list 复制链接链接已复制到粘贴板!
List Tasks.
Example: List all the Tasks in a namespace
tkn task list -n myspace
$ tkn task list -n myspace
5.3.6.5. task logs 复制链接链接已复制到粘贴板!
Display Task logs.
Example: Display logs for the mytaskrun
TaskRun of the mytask
Task
tkn task logs mytask mytaskrun -n myspace
$ tkn task logs mytask mytaskrun -n myspace
5.3.6.6. task start 复制链接链接已复制到粘贴板!
Start a Task.
Example: Start the mytask
Task in a namespace
tkn task start mytask -s <ServiceAccountName> -n myspace
$ tkn task start mytask -s <ServiceAccountName> -n myspace
5.3.7. TaskRun commands 复制链接链接已复制到粘贴板!
5.3.7.1. taskrun 复制链接链接已复制到粘贴板!
Manage TaskRuns.
Example: Display help
tkn taskrun -h
$ tkn taskrun -h
5.3.7.2. taskrun cancel 复制链接链接已复制到粘贴板!
Cancel a TaskRun.
Example: Cancel the mytaskrun
TaskRun from a namespace
tkn taskrun cancel mytaskrun -n myspace
$ tkn taskrun cancel mytaskrun -n myspace
5.3.7.3. taskrun delete 复制链接链接已复制到粘贴板!
Delete a TaskRun.
Example: Delete mytaskrun1
and mytaskrun2
TaskRuns from a namespace
tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
5.3.7.4. taskrun describe 复制链接链接已复制到粘贴板!
Describe a TaskRun.
Example: Describe the mytaskrun
TaskRun in a namespace
tkn taskrun describe mytaskrun -n myspace
$ tkn taskrun describe mytaskrun -n myspace
5.3.7.5. taskrun list 复制链接链接已复制到粘贴板!
List TaskRuns.
Example: List all TaskRuns in a namespace
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace
5.3.7.6. taskrun logs 复制链接链接已复制到粘贴板!
Display TaskRun logs.
Example: Display live logs for the mytaskrun
TaskRun in a namespace
tkn taskrun logs -f mytaskrun -n myspace
$ tkn taskrun logs -f mytaskrun -n myspace
5.3.8. Condition management commands 复制链接链接已复制到粘贴板!
5.3.8.1. condition 复制链接链接已复制到粘贴板!
Manage Conditions.
Example: Display help
tkn condition --help
$ tkn condition --help
5.3.8.2. condition delete 复制链接链接已复制到粘贴板!
Delete a Condition.
Example: Delete the mycondition1
Condition from a namespace
tkn condition delete mycondition1 -n myspace
$ tkn condition delete mycondition1 -n myspace
5.3.8.3. condition describe 复制链接链接已复制到粘贴板!
Describe a Condition.
Example: Describe the mycondition1
Condition in a namespace
tkn condition describe mycondition1 -n myspace
$ tkn condition describe mycondition1 -n myspace
5.3.8.4. condition list 复制链接链接已复制到粘贴板!
List Conditions.
Example: List Conditions in a namespace
tkn condition list -n myspace
$ tkn condition list -n myspace
5.3.9. Pipeline Resource management commands 复制链接链接已复制到粘贴板!
5.3.9.1. resource 复制链接链接已复制到粘贴板!
Manage Pipeline Resources.
Example: Display help
tkn resource -h
$ tkn resource -h
5.3.9.2. resource create 复制链接链接已复制到粘贴板!
Create a Pipeline Resource.
Example: Create a Pipeline Resource in a namespace
tkn resource create -n myspace
$ tkn resource create -n myspace
This is an interactive command that asks for input on the name of the Resource, type of the Resource, and the values based on the type of the Resource.
5.3.9.3. resource delete 复制链接链接已复制到粘贴板!
Delete a Pipeline Resource.
Example: Delete the myresource
Pipeline Resource from a namespace
tkn resource delete myresource -n myspace
$ tkn resource delete myresource -n myspace
5.3.9.4. resource describe 复制链接链接已复制到粘贴板!
Describe a Pipeline Resource.
Example: Describe the myresource
Pipeline Resource
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace
5.3.9.5. resource list 复制链接链接已复制到粘贴板!
List Pipeline Resources.
Example: List all Pipeline Resources in a namespace
tkn resource list -n myspace
$ tkn resource list -n myspace
5.3.10. ClusterTask management commands 复制链接链接已复制到粘贴板!
5.3.10.1. clustertask 复制链接链接已复制到粘贴板!
Manage ClusterTasks.
Example: Display help
tkn clustertask --help
$ tkn clustertask --help
5.3.10.2. clustertask delete 复制链接链接已复制到粘贴板!
Delete a ClusterTask resource in a cluster.
Example: Delete mytask1
and mytask2
ClusterTasks
tkn clustertask delete mytask1 mytask2
$ tkn clustertask delete mytask1 mytask2
5.3.10.3. clustertask describe 复制链接链接已复制到粘贴板!
Describe a ClusterTask.
Example: Describe the mytask
ClusterTask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask1
5.3.10.4. clustertask list 复制链接链接已复制到粘贴板!
List ClusterTasks.
Example: List ClusterTasks
tkn clustertask list
$ tkn clustertask list
5.3.10.5. clustertask start 复制链接链接已复制到粘贴板!
Start ClusterTasks.
Example: Start the mytask
ClusterTask
tkn clustertask start mytask
$ tkn clustertask start mytask
5.3.11. Trigger management commands 复制链接链接已复制到粘贴板!
5.3.11.1. eventlistener 复制链接链接已复制到粘贴板!
Manage EventListeners.
Example: Display help
tkn eventlistener -h
$ tkn eventlistener -h
5.3.11.2. eventlistener delete 复制链接链接已复制到粘贴板!
Delete an EventListener.
Example: Delete mylistener1
and mylistener2
EventListeners in a namespace
tkn eventlistener delete mylistener1 mylistener2 -n myspace
$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
5.3.11.3. eventlistener describe 复制链接链接已复制到粘贴板!
Describe an EventListener.
Example: Describe the mylistener
EventListener in a namespace
tkn eventlistener describe mylistener -n myspace
$ tkn eventlistener describe mylistener -n myspace
5.3.11.4. eventlistener list 复制链接链接已复制到粘贴板!
List EventListeners.
Example: List all the EventListeners in a namespace
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace
5.3.11.5. triggerbinding 复制链接链接已复制到粘贴板!
Manage TriggerBindings.
Example: Display TriggerBindings help
tkn triggerbinding -h
$ tkn triggerbinding -h
5.3.11.6. triggerbinding delete 复制链接链接已复制到粘贴板!
Delete a TriggerBinding.
Example: Delete mybinding1
and mybinding2
TriggerBindings in a namespace
tkn triggerbinding delete mybinding1 mybinding2 -n myspace
$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
5.3.11.7. triggerbinding describe 复制链接链接已复制到粘贴板!
Describe a TriggerBinding.
Example: Describe the mybinding
TriggerBinding in a namespace
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace
5.3.11.8. triggerbinding list 复制链接链接已复制到粘贴板!
List TriggerBindings.
Example: List all the TriggerBindings in a namespace
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace
5.3.11.9. triggertemplate 复制链接链接已复制到粘贴板!
Manage TriggerTemplates.
Example: Display TriggerTemplate help
tkn triggertemplate -h
$ tkn triggertemplate -h
5.3.11.10. triggertemplate delete 复制链接链接已复制到粘贴板!
Delete a TriggerTemplate.
Example: Delete mytemplate1
and mytemplate2
TriggerTemplates in a namespace
tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
5.3.11.11. triggertemplate describe 复制链接链接已复制到粘贴板!
Describe a TriggerTemplate.
Example: Describe the mytemplate
TriggerTemplate in a namespace
tkn triggertemplate describe mytemplate -n `myspace`
$ tkn triggertemplate describe mytemplate -n `myspace`
5.3.11.12. triggertemplate list 复制链接链接已复制到粘贴板!
List TriggerTemplates.
Example: List all the TriggerTemplates in a namespace
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace
5.3.11.13. clustertriggerbinding 复制链接链接已复制到粘贴板!
Manage ClusterTriggerBindings.
Example: Display ClusterTriggerBindings help
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h
5.3.11.14. clustertriggerbinding delete 复制链接链接已复制到粘贴板!
Delete a ClusterTriggerBinding.
Example: Delete myclusterbinding1
and myclusterbinding2
ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
5.3.11.15. clustertriggerbinding describe 复制链接链接已复制到粘贴板!
Describe a ClusterTriggerBinding.
Example: Describe the myclusterbinding
ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding
5.3.11.16. clustertriggerbinding list 复制链接链接已复制到粘贴板!
List ClusterTriggerBindings.
Example: List all ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list