Red Hat SummitThis documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Chapter 6. Pipelines CLI (tkn)
6.1. Installing tkn
Use the tkn CLI to manage Red Hat OpenShift Pipelines from a terminal. The following section describes how to install tkn on different platforms.
You can also find the URL to the latest binaries from the OpenShift Container Platform web console by clicking the ? icon in the upper-right corner and selecting Command Line Tools.
6.1.1. Installing Red Hat OpenShift Pipelines CLI (tkn) on Linux
For Linux distributions, you can download the CLI directly as a tar.gz archive.
Procedure
Download the relevant CLI.
Unpack the archive:
tar xvzf <file>
$ tar xvzf <file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Place the
tknbinary in a directory that is on yourPATH. To check your
PATH, run:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
6.1.2. Installing Red Hat OpenShift Pipelines CLI (tkn) on Linux using an RPM
For Red Hat Enterprise Linux (RHEL) version 8, you can install the Red Hat OpenShift Pipelines CLI (tkn) as an RPM.
Prerequisites
- You have an active OpenShift Container Platform subscription on your Red Hat account.
- You have root or sudo privileges on your local system.
Procedure
Register with Red Hat Subscription Manager:
subscription-manager register
# subscription-manager registerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Pull the latest subscription data:
subscription-manager refresh
# subscription-manager refreshCopy to Clipboard Copied! Toggle word wrap Toggle overflow List the available subscriptions:
subscription-manager list --available --matches '*pipelines*'
# subscription-manager list --available --matches '*pipelines*'Copy to Clipboard Copied! Toggle word wrap Toggle overflow In the output for the previous command, find the pool ID for your OpenShift Container Platform subscription and attach the subscription to the registered system:
subscription-manager attach --pool=<pool_id>
# subscription-manager attach --pool=<pool_id>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Enable the repositories required by Red Hat OpenShift Pipelines:
subscription-manager repos --enable="pipelines-1.2-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="pipelines-1.2-for-rhel-8-x86_64-rpms"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Install the
openshift-pipelines-clientpackage:yum install openshift-pipelines-client
# yum install openshift-pipelines-clientCopy to Clipboard Copied! Toggle word wrap Toggle overflow
After you install the CLI, it is available using the tkn command:
tkn version
$ tkn version6.1.3. Installing Red Hat OpenShift Pipelines CLI (tkn) on Windows
For Windows, the tkn CLI is provided as a zip archive.
Procedure
- Download the CLI.
- Unzip the archive with a ZIP program.
-
Add the location of your
tkn.exefile to yourPATHenvironment variable. To check your
PATH, open the command prompt and run the command:path
C:\> pathCopy to Clipboard Copied! Toggle word wrap Toggle overflow
6.1.4. Installing Red Hat OpenShift Pipelines CLI (tkn) on macOS
For macOS, the tkn CLI is provided as a tar.gz archive.
Procedure
- Download the CLI.
- Unpack and unzip the archive.
-
Move the
tknbinary to a directory on your PATH. To check your
PATH, open a terminal window and run:echo $PATH
$ echo $PATHCopy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2. Configuring the OpenShift Pipelines tkn CLI
Configure the Red Hat OpenShift Pipelines tkn CLI to enable tab completion.
6.2.1. Enabling tab completion
After you install the tkn CLI, you can enable tab completion to automatically complete tkn commands or suggest options when you press Tab.
Prerequisites
-
You must have the
tknCLI tool installed. -
You must have
bash-completioninstalled on your local system.
Procedure
The following procedure enables tab completion for Bash.
Save the Bash completion code to a file:
tkn completion bash > tkn_bash_completion
$ tkn completion bash > tkn_bash_completionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the file to
/etc/bash_completion.d/:sudo cp tkn_bash_completion /etc/bash_completion.d/
$ sudo cp tkn_bash_completion /etc/bash_completion.d/Copy to Clipboard Copied! Toggle word wrap Toggle overflow Alternatively, you can save the file to a local directory and source it from your
.bashrcfile instead.
Tab completion is enabled when you open a new terminal.
6.3. OpenShift Pipelines tkn reference
This section lists the basic tkn CLI commands.
6.3.1. Basic syntax
tkn [command or options] [arguments…]
6.3.2. Global options
--help, -h
6.3.3. Utility commands
6.3.3.1. tkn
Parent command for tkn CLI.
Example: Display all options
tkn
$ tkn6.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 bash6.3.3.3. version
Print version information of the tkn CLI.
Example: Check the tkn version
tkn version
$ tkn version6.3.4. Pipelines management commands
6.3.4.1. pipeline
Manage Pipelines.
Example: Display help
tkn pipeline --help
$ tkn pipeline --help6.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 myspace6.3.4.3. pipeline describe
Describe a Pipeline.
Example: Describe mypipeline Pipeline
tkn pipeline describe mypipeline
$ tkn pipeline describe mypipeline6.3.4.4. pipeline list
List Pipelines.
Example: Display a list of Pipelines
tkn pipeline list
$ tkn pipeline list6.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 mypipeline6.3.4.6. pipeline start
Start a Pipeline.
Example: Start mypipeline Pipeline
tkn pipeline start mypipeline
$ tkn pipeline start mypipeline6.3.5. PipelineRun commands
6.3.5.1. pipelinerun
Manage PipelineRuns.
Example: Display help
tkn pipelinerun -h
$ tkn pipelinerun -h6.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 myspace6.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 myspace6.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 myspace6.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 myspace6.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 myspace6.3.6. Task management commands
6.3.6.1. task
Manage Tasks.
Example: Display help
tkn task -h
$ tkn task -h6.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 myspace6.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 myspace6.3.6.4. task list
List Tasks.
Example: List all the Tasks in a namespace
tkn task list -n myspace
$ tkn task list -n myspace6.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 myspace6.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 myspace6.3.7. TaskRun commands
6.3.7.1. taskrun
Manage TaskRuns.
Example: Display help
tkn taskrun -h
$ tkn taskrun -h6.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 myspace6.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 myspace6.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 myspace6.3.7.5. taskrun list
List TaskRuns.
Example: List all TaskRuns in a namespace
tkn taskrun list -n myspace
$ tkn taskrun list -n myspace6.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 myspace6.3.8. Condition management commands
6.3.8.1. condition
Manage Conditions.
Example: Display help
tkn condition --help
$ tkn condition --help6.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 myspace6.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 myspace6.3.8.4. condition list
List Conditions.
Example: List Conditions in a namespace
tkn condition list -n myspace
$ tkn condition list -n myspace6.3.9. Pipeline Resource management commands
6.3.9.1. resource
Manage Pipeline Resources.
Example: Display help
tkn resource -h
$ tkn resource -h6.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 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.
6.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 myspace6.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 myspace6.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 myspace6.3.10. ClusterTask management commands
6.3.10.1. clustertask
Manage ClusterTasks.
Example: Display help
tkn clustertask --help
$ tkn clustertask --help6.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 mytask26.3.10.3. clustertask describe
Describe a ClusterTask.
Example: Describe the mytask ClusterTask
tkn clustertask describe mytask1
$ tkn clustertask describe mytask16.3.10.4. clustertask list
List ClusterTasks.
Example: List ClusterTasks
tkn clustertask list
$ tkn clustertask list6.3.10.5. clustertask start
Start ClusterTasks.
Example: Start the mytask ClusterTask
tkn clustertask start mytask
$ tkn clustertask start mytask6.3.11. Trigger management commands
6.3.11.1. eventlistener
Manage EventListeners.
Example: Display help
tkn eventlistener -h
$ tkn eventlistener -h6.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 myspace6.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 myspace6.3.11.4. eventlistener list
List EventListeners.
Example: List all the EventListeners in a namespace
tkn eventlistener list -n myspace
$ tkn eventlistener list -n myspace6.3.11.5. triggerbinding
Manage TriggerBindings.
Example: Display TriggerBindings help
tkn triggerbinding -h
$ tkn triggerbinding -h6.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 myspace6.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 myspace6.3.11.8. triggerbinding list
List TriggerBindings.
Example: List all the TriggerBindings in a namespace
tkn triggerbinding list -n myspace
$ tkn triggerbinding list -n myspace6.3.11.9. triggertemplate
Manage TriggerTemplates.
Example: Display TriggerTemplate help
tkn triggertemplate -h
$ tkn triggertemplate -h6.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`6.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`6.3.11.12. triggertemplate list
List TriggerTemplates.
Example: List all the TriggerTemplates in a namespace
tkn triggertemplate list -n myspace
$ tkn triggertemplate list -n myspace6.3.11.13. clustertriggerbinding
Manage ClusterTriggerBindings.
Example: Display ClusterTriggerBindings help
tkn clustertriggerbinding -h
$ tkn clustertriggerbinding -h6.3.11.14. clustertriggerbinding delete
Delete a ClusterTriggerBinding.
Example: Delete myclusterbinding1 and myclusterbinding2 ClusterTriggerBindings
tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding26.3.11.15. clustertriggerbinding describe
Describe a ClusterTriggerBinding.
Example: Describe the myclusterbinding ClusterTriggerBinding
tkn clustertriggerbinding describe myclusterbinding
$ tkn clustertriggerbinding describe myclusterbinding6.3.11.16. clustertriggerbinding list
List ClusterTriggerBindings.
Example: List all ClusterTriggerBindings
tkn clustertriggerbinding list
$ tkn clustertriggerbinding list
'%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}