Red Hat SummitCe contenu n'est pas disponible dans la langue sélectionnée.
Chapter 3. OpenShift Pipelines tkn reference
This section lists the basic tkn CLI commands.
3.1. Basic syntax
tkn [command or options] [arguments…]
3.2. Global options
--help, -h
3.3. Utility commands
3.3.1. tkn
Parent command for tkn CLI.
Example: Display all options
tkn
$ tkn3.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 bash3.3.3. version
Print version information of the tkn CLI.
Example: Check the tkn version
tkn version
$ tkn version3.4. Pipelines management commands
3.4.1. pipeline
Manage pipelines.
Example: Display help
tkn pipeline --help
$ tkn pipeline --help3.4.2. pipeline delete
Delete a pipeline.
Example: Delete a pipeline from a namespace
tkn pipeline delete <pipeline_name> -n <namespace_name>
$ tkn pipeline delete <pipeline_name> -n <namespace_name>3.4.3. pipeline describe
Describe a pipeline.
Example: Describe a pipeline
tkn pipeline describe <pipeline_name>
$ tkn pipeline describe <pipeline_name>3.4.4. pipeline list
Display a list of pipelines.
Example: Display a list of pipelines
tkn pipeline list
$ tkn pipeline list3.4.5. pipeline logs
Display the logs for a specific pipeline.
Example: Stream the live logs for a pipeline
tkn pipeline logs -f <pipeline_name>
$ tkn pipeline logs -f <pipeline_name>3.4.6. pipeline start
Start a pipeline.
Example: Start a pipeline
tkn pipeline start <pipeline_name>
$ tkn pipeline start <pipeline_name>3.5. Pipeline run commands
3.5.1. pipelinerun
Manage pipeline runs.
Example: Display help
tkn pipelinerun -h
$ tkn pipelinerun -h3.5.2. pipelinerun cancel
Cancel a pipeline run.
Example: Cancel a pipeline run from a namespace
tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>
$ tkn pipelinerun cancel <pipeline_run_name> -n <namespace_name>3.5.3. pipelinerun delete
Delete a pipeline run.
Example: Delete pipeline runs from a namespace
tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>
$ tkn pipelinerun delete <pipeline_run_name_1> <pipeline_run_name_2> -n <namespace_name>Example: Delete all pipeline runs from a namespace, except the five most recently executed pipeline runs
tkn pipelinerun delete -n <namespace_name> --keep 5
$ tkn pipelinerun delete -n <namespace_name> --keep 5 - 1
- Replace
5with the number of most recently executed pipeline runs you want to retain.
Example: Delete all pipelines
tkn pipelinerun delete --all
$ tkn pipelinerun delete --all
Starting with Red Hat OpenShift Pipelines 1.6, the tkn pipelinerun delete --all command does not delete any resources that are in the running state.
3.5.4. pipelinerun describe
Describe a pipeline run.
Example: Describe a pipeline run in a namespace
tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>
$ tkn pipelinerun describe <pipeline_run_name> -n <namespace_name>3.5.5. pipelinerun list
List pipeline runs.
Example: Display a list of pipeline runs in a namespace
tkn pipelinerun list -n <namespace_name>
$ tkn pipelinerun list -n <namespace_name>3.5.6. pipelinerun logs
Display the logs of a pipeline run.
Example: Display the logs of a pipeline run with all tasks and steps in a namespace
tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>
$ tkn pipelinerun logs <pipeline_run_name> -a -n <namespace_name>3.6. Task management commands
3.6.1. task
Manage tasks.
Example: Display help
tkn task -h
$ tkn task -h3.6.2. task delete
Delete a task.
Example: Delete tasks from a namespace
tkn task delete <task_name_1> <task_name_2> -n <namespace_name>
$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>3.6.3. task describe
Describe a task.
Example: Describe a task in a namespace
tkn task describe <task_name> -n <namespace_name>
$ tkn task describe <task_name> -n <namespace_name>3.6.4. task list
List tasks.
Example: List all the tasks in a namespace
tkn task list -n <namespace_name>
$ tkn task list -n <namespace_name>3.6.5. task start
Start a task.
Example: Start a task in a namespace
tkn task start <task_name> -s <service_account_name> -n <namespace_name>
$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>3.7. Task run commands
3.7.1. taskrun
Manage task runs.
Example: Display help
tkn taskrun -h
$ tkn taskrun -h3.7.2. taskrun cancel
Cancel a task run.
Example: Cancel a task run from a namespace
tkn taskrun cancel <task_run_name> -n <namespace_name>
$ tkn taskrun cancel <task_run_name> -n <namespace_name>3.7.3. taskrun delete
Delete a TaskRun.
Example: Delete task runs from a namespace
tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>
$ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>Example: Delete all but the five most recently executed task runs from a namespace
tkn taskrun delete -n <namespace_name> --keep 5
$ tkn taskrun delete -n <namespace_name> --keep 5 - 1
- Replace
5with the number of most recently executed task runs you want to retain.
3.7.4. taskrun describe
Describe a task run.
Example: Describe a task run in a namespace
tkn taskrun describe <task_run_name> -n <namespace_name>
$ tkn taskrun describe <task_run_name> -n <namespace_name>3.7.5. taskrun list
List task runs.
Example: List all the task runs in a namespace
tkn taskrun list -n <namespace_name>
$ tkn taskrun list -n <namespace_name>3.7.6. taskrun logs
Display task run logs.
Example: Display live logs for a task run in a namespace
tkn taskrun logs -f <task_run_name> -n <namespace_name>
$ tkn taskrun logs -f <task_run_name> -n <namespace_name>3.8. Pipeline Resource management commands
3.8.1. resource
Manage Pipeline Resources.
Example: Display help
tkn resource -h
$ tkn resource -h3.8.2. resource create
Create a Pipeline Resource.
Example: Create a Pipeline Resource in a namespace
tkn resource create -n myspace
$ tkn resource create -n myspaceThis 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.
3.8.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 myspace3.8.4. resource describe
Describe a Pipeline Resource.
Example: Describe the myresource Pipeline Resource
tkn resource describe myresource -n myspace
$ tkn resource describe myresource -n myspace3.8.5. resource list
List Pipeline Resources.
Example: List all Pipeline Resources in a namespace
tkn resource list -n myspace
$ tkn resource list -n myspace3.9. Trigger management commands
3.9.1. eventlistener
Manage EventListeners.
Example: Display help
tkn eventlistener -h
$ tkn eventlistener -h3.9.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 myspace3.9.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 myspace3.9.4. eventlistener list
List EventListeners.
Example: List all the EventListeners in a namespace
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace3.9.5. eventlistener logs
Display logs of an EventListener.
Example: Display the logs of the mylistener EventListener in a namespace
tkn eventlistener logs mylistener -n myspace
$ tkn eventlistener logs mylistener -n myspace3.9.6. triggerbinding
Manage TriggerBindings.
Example: Display TriggerBindings help
tkn triggerbinding -h
$ tkn triggerbinding -h3.9.7. 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 myspace3.9.8. triggerbinding describe
Describe a TriggerBinding.
Example: Describe the mybinding TriggerBinding in a namespace
tkn triggerbinding describe mybinding -n myspace
$ tkn triggerbinding describe mybinding -n myspace3.9.9. triggerbinding list
List TriggerBindings.
Example: List all the TriggerBindings in a namespace
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace3.9.10. triggertemplate
Manage TriggerTemplates.
Example: Display TriggerTemplate help
tkn triggertemplate -h
$ tkn triggertemplate -h3.9.11. 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`3.9.12. 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`3.9.13. triggertemplate list
List TriggerTemplates.
Example: List all the TriggerTemplates in a namespace
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace3.9.14. clustertriggerbinding
Manage ClusterTriggerBindings.
Example: Display ClusterTriggerBindings help
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h3.9.15. clustertriggerbinding delete
Delete a ClusterTriggerBinding.
Example: Delete myclusterbinding1 and myclusterbinding2 ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding23.9.16. clustertriggerbinding describe
Describe a ClusterTriggerBinding.
Example: Describe the myclusterbinding ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding3.9.17. clustertriggerbinding list
List ClusterTriggerBindings.
Example: List all ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list3.10. Hub interaction commands
Interact with Tekton Hub for resources such as tasks and pipelines.
3.10.1. hub
Interact with hub.
Example: Display help
tkn hub -h
$ tkn hub -hExample: Interact with a hub API server
tkn hub --api-server https://api.hub.tekton.dev
$ tkn hub --api-server https://api.hub.tekton.dev
For each example, to get the corresponding sub-commands and flags, run tkn hub <command> --help.
3.10.2. hub downgrade
Downgrade an installed resource.
Example: Downgrade the mytask task in the mynamespace namespace to it’s older version
tkn hub downgrade task mytask --to version -n mynamespace
$ tkn hub downgrade task mytask --to version -n mynamespace3.10.3. hub get
Get a resource manifest by its name, kind, catalog, and version.
Example: Get the manifest for a specific version of the myresource pipeline or task from the tekton catalog
tkn hub get [pipeline | task] myresource --from tekton --version version
$ tkn hub get [pipeline | task] myresource --from tekton --version version3.10.4. hub info
Display information about a resource by its name, kind, catalog, and version.
Example: Display information about a specific version of the mytask task from the tekton catalog
tkn hub info task mytask --from tekton --version version
$ tkn hub info task mytask --from tekton --version version3.10.5. hub install
Install a resource from a catalog by its kind, name, and version.
Example: Install a specific version of the mytask task from the tekton catalog in the mynamespace namespace
tkn hub install task mytask --from tekton --version version -n mynamespace
$ tkn hub install task mytask --from tekton --version version -n mynamespace3.10.6. hub reinstall
Reinstall a resource by its kind and name.
Example: Reinstall a specific version of the mytask task from the tekton catalog in the mynamespace namespace
tkn hub reinstall task mytask --from tekton --version version -n mynamespace
$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace3.10.7. hub search
Search a resource by a combination of name, kind, and tags.
Example: Search a resource with a tag cli
tkn hub search --tags cli
$ tkn hub search --tags cli3.10.8. hub upgrade
Upgrade an installed resource.
Example: Upgrade the installed mytask task in the mynamespace namespace to a new version
tkn hub upgrade task mytask --to version -n mynamespace
$ tkn hub upgrade task mytask --to version -n mynamespace
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}